📄 swarm.activity.generic.module.html
字号:
<HTML><HEAD><TITLE>General</TITLE><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.53"><LINKREL="HOME"TITLE="Documentation Set for Swarm 2.1.1"HREF="set.html"><LINKREL="UP"TITLE="Activity Library"HREF="swarm.activity.sgml.reference.html"><LINKREL="PREVIOUS"TITLE="SynchronizationType"HREF="swarm.activity.synchronizationtype.protocol.html"><LINKREL="NEXT"TITLE="Objectbase Library"HREF="swarm.objectbase.sgml.reference.html"></HEAD><BODYCLASS="REFENTRY"BGCOLOR="#FFFFFF"TEXT="#000000"LINK="#0000FF"VLINK="#840084"ALINK="#0000FF"><DIVCLASS="NAVHEADER"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><THCOLSPAN="3"ALIGN="center">Documentation Set for Swarm 2.1.1</TH></TR><TR><TDWIDTH="10%"ALIGN="left"VALIGN="bottom"><AHREF="swarm.activity.synchronizationtype.protocol.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom">Reference III. Activity Library</TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="swarm.objectbase.sgml.reference.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.ACTIVITY.GENERIC.MODULE">General</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN10654"></A><H2>Name</H2>activity -- Processing control over all levels of Swarm execution</DIV><DIVCLASS="REFSECT1"><ANAME="AEN10657"></A><H2>Description</H2><P> The activity library is responsible for scheduling actions to occur within a simulated world, and for making these actions actually happen at the right time in the right order. It provides the foundation of dynamic, object-oriented simulation within Swarm.</P><P> Actions consist of messages to objects, calls to functions, or groups of actions in some defined order. The activity library guarantees that all these actions, and the state changes they produce, occur at predictable points in time. Time is defined by the relative order of actions, and may also be indexed by the discrete values of a world clock.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN10661"></A><H2>Macros</H2><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.COMPLETEDP"></A><P></P><P><CODE><BCLASS="FSFUNC">COMPLETEDP</B>(<VARCLASS="PDPARAM">status</VAR>)</CODE></P><BR><P></P></DIV></LI><LI><P>DEFINED_timeval_t</P></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.HOLDINGP"></A><P></P><P><CODE><BCLASS="FSFUNC">HOLDINGP</B>(<VARCLASS="PDPARAM">status</VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.INITIALIZEDP"></A><P></P><P><CODE><BCLASS="FSFUNC">INITIALIZEDP</B>(<VARCLASS="PDPARAM">status</VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.RELEASEDP"></A><P></P><P><CODE><BCLASS="FSFUNC">RELEASEDP</B>(<VARCLASS="PDPARAM">status</VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.RUNNINGP"></A><P></P><P><CODE><BCLASS="FSFUNC">RUNNINGP</B>(<VARCLASS="PDPARAM">status</VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.STOPPEDP"></A><P></P><P><CODE><BCLASS="FSFUNC">STOPPEDP</B>(<VARCLASS="PDPARAM">status</VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.TERMINATEDP"></A><P></P><P><CODE><BCLASS="FSFUNC">TERMINATEDP</B>(<VARCLASS="PDPARAM">status</VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETCURRENTACTION"></A><P></P><P><CODE><BCLASS="FSFUNC">getCurrentAction</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETCURRENTACTIVITY"></A><P></P><P><CODE><BCLASS="FSFUNC">getCurrentActivity</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETCURRENTOWNERACTIVITY"></A><P></P><P><CODE><BCLASS="FSFUNC">getCurrentOwnerActivity</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETCURRENTSCHEDULE"></A><P></P><P><CODE><BCLASS="FSFUNC">getCurrentSchedule</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETCURRENTSCHEDULEACTIVITY"></A><P></P><P><CODE><BCLASS="FSFUNC">getCurrentScheduleActivity</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETCURRENTSWARM"></A><P></P><P><CODE><BCLASS="FSFUNC">getCurrentSwarm</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETCURRENTSWARMACTIVITY"></A><P></P><P><CODE><BCLASS="FSFUNC">getCurrentSwarmActivity</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETCURRENTTIME"></A><P></P><P><CODE><BCLASS="FSFUNC">getCurrentTime</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR> Macro to get the time of the current activity - only valid when an activity is actually running. Returns a (timeval_t).<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.MACRO.GETTOPLEVELACTIVITY"></A><P></P><P><CODE><BCLASS="FSFUNC">getTopLevelActivity</B>(<VARCLASS="PDPARAM"></VAR>)</CODE></P><BR> Macro to get id of the current topLevelActivity - only valid when an activity is actually running.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT1"><ANAME="AEN10810"></A><H2>Functions</H2><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ACTIVITY.GENERIC.FUNCTION.ACTIVITYCONTEXTERROR"></A><P></P><P><CODE>id <BCLASS="FSFUNC">_activity_context_error</B>(const char *<VARCLASS="PDPARAM">macroName</VAR>)</CODE></P><BR> Internal error message issued when a current activity is missing.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT1"><ANAME="AEN10822"></A><H2>Typedefs</H2><P></P><UL><LI><P>timeval_t<PRE>unsigned long</PRE></P></LI></UL></DIV><DIVCLASS="REFSECT1"><ANAME="AEN10828"></A><H2>Globals</H2><P></P><DIVCLASS="VARIABLELIST"><DL><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.INITIALIZED">id <Symbol> Initialized </A></DT><DD><P> Values returned by getStatus.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.RUNNING">id <Symbol> Running </A></DT><DD><P> Values returned by getStatus.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.HOLDING">id <Symbol> Holding </A></DT><DD><P> Values returned by getStatus.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.RELEASED">id <Symbol> Released </A></DT><DD><P> Values returned by getStatus.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.STOPPED">id <Symbol> Stopped </A></DT><DD><P> Values returned by getStatus.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.TERMINATED">id <Symbol> Terminated </A></DT><DD><P> Values returned by getStatus.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.COMPLETED">id <Symbol> Completed </A></DT><DD><P> Values returned by getStatus.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.CONCURRENT">id <Symbol> Concurrent </A></DT><DD><P> values for DefaultOrder</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.SEQUENTIAL">id <Symbol> Sequential </A></DT><DD><P> values for DefaultOrder</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.RANDOMIZED">id <Symbol> Randomized </A></DT><DD><P> values for DefaultOrder</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.HOLDSTART">id <Symbol> HoldStart </A></DT><DD><P> Values returned by getHoldType.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.HOLDEND">id <Symbol> HoldEnd </A></DT><DD><P> Values returned by getHoldType.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.ACTIVITYCURRENT">id _activity_current </A></DT><DD><P> Internal variable used by current context macros.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.INVALIDSWARMZONE">id <Error> InvalidSwarmZone </A></DT><DD><P> Error issued when an internal zone is expected, but absent.</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.ACTIVITYZONE">id _activity_zone </A></DT><DD><P> _activity_zone -- zone in which activity objects created</P></DD><DT><ANAME="SWARM.ACTIVITY.GENERIC.GLOBAL.ACTIVITYTRACE">BOOL (*) (id) _activity_trace </A></DT><DD><P> trace function for activity execution global variable for function to be called on every change in the activity tree Note: support for any specific form of this trace facility is not guaranteed in future versions. Some form of trace facility will remain for debug purposes, however, at least until a full form of event history logging has been implemented as an integral part of the Activity type.</P></DD></DL></DIV></DIV><DIVCLASS="NAVFOOTER"><HRALIGN="LEFT"WIDTH="100%"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top"><AHREF="swarm.activity.synchronizationtype.protocol.html">Prev</A></TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="set.html">Home</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top"><AHREF="swarm.objectbase.sgml.reference.html">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">SynchronizationType</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="swarm.activity.sgml.reference.html">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">Objectbase Library</TD></TR></TABLE></DIV></BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -