📄 swarm.simtools.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="Simtools Library"HREF="swarm.simtools.sgml.reference.html"><LINKREL="PREVIOUS"TITLE="UName"HREF="swarm.simtools.uname.protocol.html"><LINKREL="NEXT"TITLE="Simtoolsgui Library"HREF="swarm.simtoolsgui.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.simtools.uname.protocol.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom">Reference VI. Simtools Library</TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="swarm.simtoolsgui.sgml.reference.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.SIMTOOLS.GENERIC.MODULE">General</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN16436"></A><H2>Name</H2>simtools -- General simulation tools</DIV><DIVCLASS="REFSECT1"><ANAME="AEN16439"></A><H2>Description</H2><P> A collection of tools that are only loosely related to each other. the class hierarchy is virtually flat.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN16442"></A><H2>Macros</H2><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.GENERIC.MACRO.INITSWARM"></A><P></P><P><CODE><BCLASS="FSFUNC">initSwarm</B>(<VARCLASS="PDPARAM">argc</VAR>, <VARCLASS="PDPARAM">argv</VAR>)</CODE></P><BR> Initializes the Swarm libraries without version or bug-report-address information.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.GENERIC.MACRO.INITSWARMAPP"></A><P></P><P><CODE><BCLASS="FSFUNC">initSwarmApp</B>(<VARCLASS="PDPARAM">argc</VAR>, <VARCLASS="PDPARAM">argv</VAR>, <VARCLASS="PDPARAM">version</VAR>, <VARCLASS="PDPARAM">bugAddress</VAR>)</CODE></P><BR> Initializes the Swarm libraries for an application. <P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.GENERIC.MACRO.INITSWARMAPPARGUMENTS"></A><P></P><P><CODE><BCLASS="FSFUNC">initSwarmAppArguments</B>(<VARCLASS="PDPARAM">argc</VAR>, <VARCLASS="PDPARAM">argv</VAR>, <VARCLASS="PDPARAM">version</VAR>, <VARCLASS="PDPARAM">bugAddress</VAR>, <VARCLASS="PDPARAM">argumentsClass</VAR>)</CODE></P><BR> Like initSwarmApp, but specifies what class to use for argument parsing, typically this will be a subclass of Arguments.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.GENERIC.MACRO.INITSWARMAPPBATCH"></A><P></P><P><CODE><BCLASS="FSFUNC">initSwarmAppBatch</B>(<VARCLASS="PDPARAM">argc</VAR>, <VARCLASS="PDPARAM">argv</VAR>, <VARCLASS="PDPARAM">version</VAR>, <VARCLASS="PDPARAM">bugaddress</VAR>)</CODE></P><BR> Like initSwarmApp, but initializes in batch-mode only<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.GENERIC.MACRO.INITSWARMAPPOPTIONS"></A><P></P><P><CODE><BCLASS="FSFUNC">initSwarmAppOptions</B>(<VARCLASS="PDPARAM">argc</VAR>, <VARCLASS="PDPARAM">argv</VAR>, <VARCLASS="PDPARAM">version</VAR>, <VARCLASS="PDPARAM">bugAddress</VAR>, <VARCLASS="PDPARAM">options</VAR>, <VARCLASS="PDPARAM">optionFunc</VAR>)</CODE></P><BR> Like initSwarmApp, but specifies a parsing function .<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.GENERIC.MACRO.INITSWARMAPPOPTIONSBATCH"></A><P></P><P><CODE><BCLASS="FSFUNC">initSwarmAppOptionsBatch</B>(<VARCLASS="PDPARAM">argc</VAR>, <VARCLASS="PDPARAM">argv</VAR>, <VARCLASS="PDPARAM">version</VAR>, <VARCLASS="PDPARAM">bugAddress</VAR>, <VARCLASS="PDPARAM">options</VAR>, <VARCLASS="PDPARAM">optionFunc</VAR>)</CODE></P><BR> Like initSwarmAppOptions, but initializes in batch-mode only<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.GENERIC.MACRO.INITSWARMARGUMENTS"></A><P></P><P><CODE><BCLASS="FSFUNC">initSwarmArguments</B>(<VARCLASS="PDPARAM">argc</VAR>, <VARCLASS="PDPARAM">argv</VAR>, <VARCLASS="PDPARAM">argumentsClass</VAR>)</CODE></P><BR> Like initSwarm, but specifies what class to use for argument parsing, typically this will be a subclass of Arguments.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.GENERIC.MACRO.INITSWARMBATCH"></A><P></P><P><CODE><BCLASS="FSFUNC">initSwarmBatch</B>(<VARCLASS="PDPARAM">argc</VAR>, <VARCLASS="PDPARAM">argv</VAR>)</CODE></P><BR> Initializes the Swarm libraries for batch mode without version or bug report address information.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT1"><ANAME="AEN16565"></A><H2>Globals</H2><P></P><DIVCLASS="VARIABLELIST"><DL><DT><ANAME="SWARM.SIMTOOLS.GENERIC.GLOBAL.SWARMGUIMODE">BOOL swarmGUIMode </A></DT><DD><P> Flag for whether we're in graphics mode or not. Default is NO.</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.simtools.uname.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.sgml.reference.html">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">UName</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="swarm.simtools.sgml.reference.html">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">Simtoolsgui Library</TD></TR></TABLE></DIV></BODY></HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -