activity.html

来自「文件来自swarm.org」· HTML 代码 · 共 560 行 · 第 1/2 页

<TD><B>Methods inherited from interface swarm.defobj.<A HREF="../../swarm/defobj/GetName.html">GetName</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../swarm/defobj/GetName.html#getName()">getName</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->


<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="run()"><!-- --></A><H3>
run</H3>
<PRE>
public <A HREF="../../swarm/defobj/Symbol.html">Symbol</A> <B>run</B>()</PRE>
<DL>
<DD>The run message continue processing of an activity from any state in which its execution has been suspended.  An error is raised if the activity is already running.  run returns either a Stopped or Completed status that the activity has when it is no longer eligible to be run further.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
public void <B>stop</B>()</PRE>
<DL>
<DD>The stop message causes the a currently running tree of activities to stop further processing and return a Stopped status.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="terminate()"><!-- --></A><H3>
terminate</H3>
<PRE>
public void <B>terminate</B>()</PRE>
<DL>
<DD>Terminate also stops a running tree of activities, but sets all activities within the tree to a status of Completed whenever the tree is next run. terminate may be used on either a running or stopped tree of activities.  It is the standard way to terminate schedule that is endlessly repeating under the RepeatInterval option.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="nextAction()"><!-- --></A><H3>
nextAction</H3>
<PRE>
public <A HREF="../../swarm/defobj/Symbol.html">Symbol</A> <B>nextAction</B>()</PRE>
<DL>
<DD>The next executes actions within a single compound action while skipping over all processing of any complete action plans executed by those actions.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="stepAction()"><!-- --></A><H3>
stepAction</H3>
<PRE>
public <A HREF="../../swarm/defobj/Symbol.html">Symbol</A> <B>stepAction</B>()</PRE>
<DL>
<DD>The step message executes a single action within a tree of activities.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getStatus()"><!-- --></A><H3>
getStatus</H3>
<PRE>
public <A HREF="../../swarm/defobj/Symbol.html">Symbol</A> <B>getStatus</B>()</PRE>
<DL>
<DD>The getStatus message returns one of the following codes for the current run status of a particular activity: Initialized, Running, Stopped, Holding, Released, Terminated, Completed.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getHoldType()"><!-- --></A><H3>
getHoldType</H3>
<PRE>
public <A HREF="../../swarm/defobj/Symbol.html">Symbol</A> <B>getHoldType</B>()</PRE>
<DL>
<DD>The getHoldType returns a code for the particular hold constraint under which an activity is currently holding (HoldStart or HoldEnd). It returns nil if the basic status of the activity is not Holding.  (.. Currently no hold constraints other than merging within a swarm are supported, and this message always returns nil.)<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAction()"><!-- --></A><H3>
getAction</H3>
<PRE>
public <A HREF="../../swarm/activity/Action.html">Action</A> <B>getAction</B>()</PRE>
<DL>
<DD>Get action containing parameter bindings for the local activity.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getActionType()"><!-- --></A><H3>
getActionType</H3>
<PRE>
public java.lang.Object <B>getActionType</B>()</PRE>
<DL>
<DD>Get action type of action being performed by activity.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setOwnerActivity(java.lang.Object)"><!-- --></A><H3>
setOwnerActivity</H3>
<PRE>
public void <B>setOwnerActivity</B>(java.lang.Object&nbsp;ownerActivity)</PRE>
<DL>
<DD>Change owner from one swarm activity to another.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getOwnerActivity()"><!-- --></A><H3>
getOwnerActivity</H3>
<PRE>
public <A HREF="../../swarm/activity/Activity.html">Activity</A> <B>getOwnerActivity</B>()</PRE>
<DL>
<DD>Return activity under which this activity is running.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSubactivities()"><!-- --></A><H3>
getSubactivities</H3>
<PRE>
public java.lang.Object <B>getSubactivities</B>()</PRE>
<DL>
<DD>Return set of subactivities pending to be run.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getControllingActivity()"><!-- --></A><H3>
getControllingActivity</H3>
<PRE>
public <A HREF="../../swarm/activity/Activity.html">Activity</A> <B>getControllingActivity</B>()</PRE>
<DL>
<DD>Return activity that issued current run request on top-level activity.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getTopLevelActivity()"><!-- --></A><H3>
getTopLevelActivity</H3>
<PRE>
public <A HREF="../../swarm/activity/Activity.html">Activity</A> <B>getTopLevelActivity</B>()</PRE>
<DL>
<DD>Return top of activity tree running the local activity.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSwarmActivity()"><!-- --></A><H3>
getSwarmActivity</H3>
<PRE>
public <A HREF="../../swarm/activity/SwarmActivity.html">SwarmActivity</A> <B>getSwarmActivity</B>()</PRE>
<DL>
<DD>Return most immediately containing Swarm activity.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getScheduleActivity()"><!-- --></A><H3>
getScheduleActivity</H3>
<PRE>
public <A HREF="../../swarm/activity/ScheduleActivity.html">ScheduleActivity</A> <B>getScheduleActivity</B>()</PRE>
<DL>
<DD>Return most immediately containing Schedule activity.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setSerialMode(boolean)"><!-- --></A><H3>
setSerialMode</H3>
<PRE>
public java.lang.Object <B>setSerialMode</B>(boolean&nbsp;serialMode)</PRE>
<DL>
<DD>Set serial execution mode.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSerialMode()"><!-- --></A><H3>
getSerialMode</H3>
<PRE>
public boolean <B>getSerialMode</B>()</PRE>
<DL>
<DD>Return indicator for serial execution mode.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentSubactivity()"><!-- --></A><H3>
getCurrentSubactivity</H3>
<PRE>
public <A HREF="../../swarm/activity/Activity.html">Activity</A> <B>getCurrentSubactivity</B>()</PRE>
<DL>
<DD>Get running subactivity or next subactivity to run.<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../swarm/activity/ActivationOrderS.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../swarm/activity/ActivityC.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Activity.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>