diff options
| author | Paul Buetow <paul@buetow.org> | 2008-08-15 04:09:42 +0000 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2008-08-15 04:09:42 +0000 |
| commit | afed274c10a93957f82a009824cafe8d83aa68a8 (patch) | |
| tree | 4a4d3980a3d9eb32bf7be443a83afe4c21dcdf55 /VS-Sim-Javadoc/core/VSTask.html | |
new branches
Diffstat (limited to 'VS-Sim-Javadoc/core/VSTask.html')
| -rw-r--r-- | VS-Sim-Javadoc/core/VSTask.html | 911 |
1 files changed, 911 insertions, 0 deletions
diff --git a/VS-Sim-Javadoc/core/VSTask.html b/VS-Sim-Javadoc/core/VSTask.html new file mode 100644 index 0000000..6c04f71 --- /dev/null +++ b/VS-Sim-Javadoc/core/VSTask.html @@ -0,0 +1,911 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_03-p4) on Thu Aug 14 07:45:33 GMT 2008 --> +<TITLE> +VSTask +</TITLE> + +<META NAME="date" CONTENT="2008-08-14"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="VSTask"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../core/VSMessageStub.html" title="class in core"><B>PREV CLASS</B></A> + <A HREF="../core/VSTaskManager.html" title="class in core"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../index.html?core/VSTask.html" target="_top"><B>FRAMES</B></A> + <A HREF="VSTask.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +core</FONT> +<BR> +Class VSTask</H2> +<PRE> +java.lang.Object + <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>core.VSTask</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Comparable, <A HREF="../serialize/VSSerializable.html" title="interface in serialize">VSSerializable</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>VSTask</B><DT>extends java.lang.Object<DT>implements java.lang.Comparable, <A HREF="../serialize/VSSerializable.html" title="interface in serialize">VSSerializable</A></DL> +</PRE> + +<P> +The class VSTask, an object of this class represents a task to do or done. + All tasks are managed by the task manager. There are local and global timed + tasks. Local timed tasks are being fullfilled if the process' local time is + reached. Global timed tasks are being fullfilled if the simulator's time is + reached. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Paul C. Buetow</DD> +</DL> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#GLOBAL">GLOBAL</A></B></CODE> + +<BR> + The Constant GLOBAL.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#LOCAL">LOCAL</A></B></CODE> + +<BR> + The Constant LOCAL.</TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../core/VSTask.html#VSTask(long, core.VSInternalProcess, events.VSAbstractEvent, boolean)">VSTask</A></B>(long taskTime, + <A HREF="../core/VSInternalProcess.html" title="class in core">VSInternalProcess</A> process, + <A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A> event, + boolean isLocal)</CODE> + +<BR> + Instantiates a new task.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../core/VSTask.html#VSTask(serialize.VSSerialize, java.io.ObjectInputStream)">VSTask</A></B>(<A HREF="../serialize/VSSerialize.html" title="class in serialize">VSSerialize</A> serialize, + java.io.ObjectInputStream objectInputStream)</CODE> + +<BR> + Instantiates a new task during a deserialization.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../core/VSTask.html#VSTask(core.VSTask)">VSTask</A></B>(<A HREF="../core/VSTask.html" title="class in core">VSTask</A> task)</CODE> + +<BR> + Instantiates a new task, it's a copy constructor.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object object)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#deserialize(serialize.VSSerialize, java.io.ObjectInputStream)">deserialize</A></B>(<A HREF="../serialize/VSSerialize.html" title="class in serialize">VSSerialize</A> serialize, + java.io.ObjectInputStream objectInputStream)</CODE> + +<BR> + Deserializes</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#equals(core.VSTask)">equals</A></B>(<A HREF="../core/VSTask.html" title="class in core">VSTask</A> task)</CODE> + +<BR> + Checks if the task equals to another task.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#getEvent()">getEvent</A></B>()</CODE> + +<BR> + Gets the event.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../core/VSInternalProcess.html" title="class in core">VSInternalProcess</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#getProcess()">getProcess</A></B>()</CODE> + +<BR> + Gets the process.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#getTaskNum()">getTaskNum</A></B>()</CODE> + +<BR> + Gets the task num.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#getTaskTime()">getTaskTime</A></B>()</CODE> + +<BR> + Gets the task time.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#hasInternalEvent()">hasInternalEvent</A></B>()</CODE> + +<BR> + Checks if the task is using an "internal event".</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#hasMessageReceiveEvent()">hasMessageReceiveEvent</A></B>()</CODE> + +<BR> + Checks if the task is a message receive event.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#hasNotSerializableEvent()">hasNotSerializableEvent</A></B>()</CODE> + +<BR> + Checks if the task should not get serialized.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#hasProcessRecoverEvent()">hasProcessRecoverEvent</A></B>()</CODE> + +<BR> + Checks if the task is a process recover event.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#isGlobalTimed()">isGlobalTimed</A></B>()</CODE> + +<BR> + Checks if the task is global timed.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#isProcess(core.VSInternalProcess)">isProcess</A></B>(<A HREF="../core/VSInternalProcess.html" title="class in core">VSInternalProcess</A> process)</CODE> + +<BR> + Checks if the task belongs to the specified process.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#isProgrammed()">isProgrammed</A></B>()</CODE> + +<BR> + Checks if the task is programmed.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#isProgrammed(boolean)">isProgrammed</A></B>(boolean isProgrammed)</CODE> + +<BR> + Sets if the task is programmed.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#isProtocol(protocols.VSAbstractProtocol)">isProtocol</A></B>(<A HREF="../protocols/VSAbstractProtocol.html" title="class in protocols">VSAbstractProtocol</A> protocol)</CODE> + +<BR> + Checks if the task belongs to the specified protocol object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#run()">run</A></B>()</CODE> + +<BR> + Runs the task.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#serialize(serialize.VSSerialize, java.io.ObjectOutputStream)">serialize</A></B>(<A HREF="../serialize/VSSerialize.html" title="class in serialize">VSSerialize</A> serialize, + java.io.ObjectOutputStream objectOutputStream)</CODE> + +<BR> + Serializes</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#setProcess(core.VSInternalProcess)">setProcess</A></B>(<A HREF="../core/VSInternalProcess.html" title="class in core">VSInternalProcess</A> process)</CODE> + +<BR> + Sets the process.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#setTaskTime(long)">setTaskTime</A></B>(long taskTime)</CODE> + +<BR> + Sets the task time.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#timeOver()">timeOver</A></B>()</CODE> + +<BR> + Checks if the task's time is over.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../core/VSTask.html#toString()">toString</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="LOCAL"><!-- --></A><H3> +LOCAL</H3> +<PRE> +public static final boolean <B>LOCAL</B></PRE> +<DL> +<DD>The Constant LOCAL. Used for the constructor if it's a local timed + task. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#core.VSTask.LOCAL">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="GLOBAL"><!-- --></A><H3> +GLOBAL</H3> +<PRE> +public static final boolean <B>GLOBAL</B></PRE> +<DL> +<DD>The Constant GLOBAL. Used for the constructor if it's a global timed + task. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#core.VSTask.GLOBAL">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="VSTask(long, core.VSInternalProcess, events.VSAbstractEvent, boolean)"><!-- --></A><H3> +VSTask</H3> +<PRE> +public <B>VSTask</B>(long taskTime, + <A HREF="../core/VSInternalProcess.html" title="class in core">VSInternalProcess</A> process, + <A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A> event, + boolean isLocal)</PRE> +<DL> +<DD>Instantiates a new task. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>taskTime</CODE> - the task time<DD><CODE>process</CODE> - the process<DD><CODE>event</CODE> - the event<DD><CODE>isLocal</CODE> - the taks is local timed</DL> +</DL> +<HR> + +<A NAME="VSTask(core.VSTask)"><!-- --></A><H3> +VSTask</H3> +<PRE> +public <B>VSTask</B>(<A HREF="../core/VSTask.html" title="class in core">VSTask</A> task)</PRE> +<DL> +<DD>Instantiates a new task, it's a copy constructor. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>task</CODE> - the task to copy</DL> +</DL> +<HR> + +<A NAME="VSTask(serialize.VSSerialize, java.io.ObjectInputStream)"><!-- --></A><H3> +VSTask</H3> +<PRE> +public <B>VSTask</B>(<A HREF="../serialize/VSSerialize.html" title="class in serialize">VSSerialize</A> serialize, + java.io.ObjectInputStream objectInputStream) + throws java.io.IOException, + java.lang.ClassNotFoundException</PRE> +<DL> +<DD>Instantiates a new task during a deserialization. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>serialize</CODE> - the serialize object<DD><CODE>objectInputStream</CODE> - The input stream +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE> +<DD><CODE>java.lang.ClassNotFoundException</CODE></DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getTaskNum()"><!-- --></A><H3> +getTaskNum</H3> +<PRE> +public int <B>getTaskNum</B>()</PRE> +<DL> +<DD>Gets the task num. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the task num</DL> +</DD> +</DL> +<HR> + +<A NAME="isProgrammed(boolean)"><!-- --></A><H3> +isProgrammed</H3> +<PRE> +public void <B>isProgrammed</B>(boolean isProgrammed)</PRE> +<DL> +<DD>Sets if the task is programmed. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>isProgrammed</CODE> - true, if the task is programmed</DL> +</DD> +</DL> +<HR> + +<A NAME="isProgrammed()"><!-- --></A><H3> +isProgrammed</H3> +<PRE> +public boolean <B>isProgrammed</B>()</PRE> +<DL> +<DD>Checks if the task is programmed. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true, if the task is programmed</DL> +</DD> +</DL> +<HR> + +<A NAME="hasInternalEvent()"><!-- --></A><H3> +hasInternalEvent</H3> +<PRE> +public boolean <B>hasInternalEvent</B>()</PRE> +<DL> +<DD>Checks if the task is using an "internal event". +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true, if the task is using an internal event</DL> +</DD> +</DL> +<HR> + +<A NAME="hasNotSerializableEvent()"><!-- --></A><H3> +hasNotSerializableEvent</H3> +<PRE> +public boolean <B>hasNotSerializableEvent</B>()</PRE> +<DL> +<DD>Checks if the task should not get serialized. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true, if the task should not get serialized</DL> +</DD> +</DL> +<HR> + +<A NAME="hasMessageReceiveEvent()"><!-- --></A><H3> +hasMessageReceiveEvent</H3> +<PRE> +public boolean <B>hasMessageReceiveEvent</B>()</PRE> +<DL> +<DD>Checks if the task is a message receive event. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true, if it is a message receive event</DL> +</DD> +</DL> +<HR> + +<A NAME="hasProcessRecoverEvent()"><!-- --></A><H3> +hasProcessRecoverEvent</H3> +<PRE> +public boolean <B>hasProcessRecoverEvent</B>()</PRE> +<DL> +<DD>Checks if the task is a process recover event. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true, if it is a process recover event</DL> +</DD> +</DL> +<HR> + +<A NAME="isProtocol(protocols.VSAbstractProtocol)"><!-- --></A><H3> +isProtocol</H3> +<PRE> +public boolean <B>isProtocol</B>(<A HREF="../protocols/VSAbstractProtocol.html" title="class in protocols">VSAbstractProtocol</A> protocol)</PRE> +<DL> +<DD>Checks if the task belongs to the specified protocol object. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>protocol</CODE> - the protocol object to check against. +<DT><B>Returns:</B><DD>true, if it's a task using the protocol object.</DL> +</DD> +</DL> +<HR> + +<A NAME="timeOver()"><!-- --></A><H3> +timeOver</H3> +<PRE> +public boolean <B>timeOver</B>()</PRE> +<DL> +<DD>Checks if the task's time is over. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true, if it's over</DL> +</DD> +</DL> +<HR> + +<A NAME="equals(core.VSTask)"><!-- --></A><H3> +equals</H3> +<PRE> +public boolean <B>equals</B>(<A HREF="../core/VSTask.html" title="class in core">VSTask</A> task)</PRE> +<DL> +<DD>Checks if the task equals to another task. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>task</CODE> - the task to compare to +<DT><B>Returns:</B><DD>true, if equal (the task nums equal)</DL> +</DD> +</DL> +<HR> + +<A NAME="isProcess(core.VSInternalProcess)"><!-- --></A><H3> +isProcess</H3> +<PRE> +public boolean <B>isProcess</B>(<A HREF="../core/VSInternalProcess.html" title="class in core">VSInternalProcess</A> process)</PRE> +<DL> +<DD>Checks if the task belongs to the specified process. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>process</CODE> - the process to check against +<DT><B>Returns:</B><DD>true, if the task is using the process</DL> +</DD> +</DL> +<HR> + +<A NAME="isGlobalTimed()"><!-- --></A><H3> +isGlobalTimed</H3> +<PRE> +public boolean <B>isGlobalTimed</B>()</PRE> +<DL> +<DD>Checks if the task is global timed. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true, if the taks is global timed</DL> +</DD> +</DL> +<HR> + +<A NAME="getProcess()"><!-- --></A><H3> +getProcess</H3> +<PRE> +public <A HREF="../core/VSInternalProcess.html" title="class in core">VSInternalProcess</A> <B>getProcess</B>()</PRE> +<DL> +<DD>Gets the process. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the process of the event</DL> +</DD> +</DL> +<HR> + +<A NAME="run()"><!-- --></A><H3> +run</H3> +<PRE> +public void <B>run</B>()</PRE> +<DL> +<DD>Runs the task. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getTaskTime()"><!-- --></A><H3> +getTaskTime</H3> +<PRE> +public long <B>getTaskTime</B>()</PRE> +<DL> +<DD>Gets the task time. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the task time</DL> +</DD> +</DL> +<HR> + +<A NAME="setTaskTime(long)"><!-- --></A><H3> +setTaskTime</H3> +<PRE> +public void <B>setTaskTime</B>(long taskTime)</PRE> +<DL> +<DD>Sets the task time. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>taskTime</CODE> - the task time</DL> +</DD> +</DL> +<HR> + +<A NAME="setProcess(core.VSInternalProcess)"><!-- --></A><H3> +setProcess</H3> +<PRE> +public void <B>setProcess</B>(<A HREF="../core/VSInternalProcess.html" title="class in core">VSInternalProcess</A> process)</PRE> +<DL> +<DD>Sets the process. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>process</CODE> - the process</DL> +</DD> +</DL> +<HR> + +<A NAME="getEvent()"><!-- --></A><H3> +getEvent</H3> +<PRE> +public <A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A> <B>getEvent</B>()</PRE> +<DL> +<DD>Gets the event. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the event</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public java.lang.String <B>toString</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="compareTo(java.lang.Object)"><!-- --></A><H3> +compareTo</H3> +<PRE> +public int <B>compareTo</B>(java.lang.Object object)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="serialize(serialize.VSSerialize, java.io.ObjectOutputStream)"><!-- --></A><H3> +serialize</H3> +<PRE> +public void <B>serialize</B>(<A HREF="../serialize/VSSerialize.html" title="class in serialize">VSSerialize</A> serialize, + java.io.ObjectOutputStream objectOutputStream) + throws java.io.IOException</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../serialize/VSSerializable.html#serialize(serialize.VSSerialize, java.io.ObjectOutputStream)">VSSerializable</A></CODE></B></DD> +<DD>Serializes +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../serialize/VSSerializable.html#serialize(serialize.VSSerialize, java.io.ObjectOutputStream)">serialize</A></CODE> in interface <CODE><A HREF="../serialize/VSSerializable.html" title="interface in serialize">VSSerializable</A></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>serialize</CODE> - The serialize object<DD><CODE>objectOutputStream</CODE> - The object output stream +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="deserialize(serialize.VSSerialize, java.io.ObjectInputStream)"><!-- --></A><H3> +deserialize</H3> +<PRE> +public void <B>deserialize</B>(<A HREF="../serialize/VSSerialize.html" title="class in serialize">VSSerialize</A> serialize, + java.io.ObjectInputStream objectInputStream) + throws java.io.IOException, + java.lang.ClassNotFoundException</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../serialize/VSSerializable.html#deserialize(serialize.VSSerialize, java.io.ObjectInputStream)">VSSerializable</A></CODE></B></DD> +<DD>Deserializes +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../serialize/VSSerializable.html#deserialize(serialize.VSSerialize, java.io.ObjectInputStream)">deserialize</A></CODE> in interface <CODE><A HREF="../serialize/VSSerializable.html" title="interface in serialize">VSSerializable</A></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>serialize</CODE> - The serialize object<DD><CODE>objectInputStream</CODE> - The object input stream +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE> +<DD><CODE>java.lang.ClassNotFoundException</CODE></DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 |