📄 swarm.simtoolsgui.controlpanel.protocol.html

📁 set for Swarm2.1是圣菲研究院的开发人员对Swarm的特性及其使用描述的最为完备的指南性文档。从这里可以获得最细致的平台说明。
💻 HTML
字号:
<HTML><HEAD><TITLE>ControlPanel</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="Simtoolsgui Library"HREF="swarm.simtoolsgui.sgml.reference.html"><LINKREL="PREVIOUS"TITLE="CompositeWindowGeometryRecordName"HREF="swarm.simtoolsgui.compositewindowgeometryrecordname.protocol.html"><LINKREL="NEXT"TITLE="GUIComposite"HREF="swarm.simtoolsgui.guicomposite.protocol.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.simtoolsgui.compositewindowgeometryrecordname.protocol.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom">Reference VII. Simtoolsgui Library</TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="swarm.simtoolsgui.guicomposite.protocol.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.PROTOCOL">ControlPanel</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN17062"></A><H2>Name</H2>ControlPanel&nbsp;--&nbsp; Class to control the top level SwarmProcess</DIV><DIVCLASS="REFSECT1"><ANAME="AEN17065"></A><H2>Description</H2><P> ControlPanel keeps track of the users requests to run, stop, quit, or time step the simulation. It cooperates with the GUISwarm to control the execution of activities in Swarm.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN17068"></A><H2>Protocols adopted by ControlPanel</H2><P> <AHREF="swarm.objectbase.swarmobject.protocol.html">SwarmObject</A> <AHREF="swarm.defobj.returnable.protocol.html">RETURNABLE</A></P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN17073"></A><H2>Methods</H2><DIVCLASS="REFSECT2"><ANAME="AEN17075"></A><H3>Phase: Creating</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PC.M228"></A><P></P>- <BCLASS="FUNCPROTOTYPE">createEnd</B><BR><P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN17086"></A><H3>Phase: Using</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M492"></A><P></P>- (id &lt;Symbol&gt;)<BCLASS="FUNCPROTOTYPE">getState</B><BR> Get the current button state of the controlpanel.  Is one of ControlStateRunning, ControlStateStopped, ControlStateStepping, ControlStateNextTime, or ControlStateQuit.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M858"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setState:</B> (id &lt;Symbol&gt;)<VARCLASS="PDPARAM">s</VAR> <BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M918"></A><P></P>- <BCLASS="FUNCPROTOTYPE">startInActivity:</B> (id &lt;SwarmActivity&gt;)<VARCLASS="PDPARAM">activityID</VAR> <BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M864"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setStateRunning</B><BR> Sets the state to `running'.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M867"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setStateStopped</B><BR> The -setStateStopped message is particularly useful since it will cause the simulation to stop until the user interactively sets it back in motion (in other words, this method is useful in generating a software-triggered pause).<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M866"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setStateStepping</B><BR> Stop the running activity, and then set state to `ControlStateStepping'.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M863"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setStateQuit</B><BR> Terminate activities, and set state to `ControlStateQuit'.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M862"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setStateNextTime</B><BR> Stop the running activity, and then set state to `ControlStateNextTime'.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLSGUI.CONTROLPANEL.METHOD.PU.M865"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setStateSave</B><BR> Saves the objects that are registered for archiving.<P></P></DIV></LI></UL></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.simtoolsgui.compositewindowgeometryrecordname.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.simtoolsgui.guicomposite.protocol.html">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">CompositeWindowGeometryRecordName</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="swarm.simtoolsgui.sgml.reference.html">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">GUIComposite</TD></TR></TABLE></DIV></BODY></HTML>
⌨️ 快捷键说明

复制代码 Ctrl + C
搜索代码 Ctrl + F
全屏模式 F11
切换主题 Ctrl + Shift + D
显示快捷键 ?
增大字号 Ctrl + =
减小字号 Ctrl + -