diff options
Diffstat (limited to 'docs/doxygen/nel/classNLLOGIC_1_1CLogicState.html')
| -rw-r--r-- | docs/doxygen/nel/classNLLOGIC_1_1CLogicState.html | 853 |
1 files changed, 853 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLLOGIC_1_1CLogicState.html b/docs/doxygen/nel/classNLLOGIC_1_1CLogicState.html new file mode 100644 index 00000000..205a6324 --- /dev/null +++ b/docs/doxygen/nel/classNLLOGIC_1_1CLogicState.html @@ -0,0 +1,853 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLLOGIC::CLogicState Class Reference</h1><a class="el" href="classNLLOGIC_1_1CLogicState.html">CLogicState</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="logic__state_8h-source.html">logic_state.h</a>></code> +<p> +<a href="classNLLOGIC_1_1CLogicState-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a0">CLogicState</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Default constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a1">setLogicStateMachine</a> (<a class="el" href="classNLLOGIC_1_1CLogicStateMachine.html">CLogicStateMachine</a> *logicStateMachine)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the state machine which contains this state.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a2">setName</a> (std::string name)</td></tr> +<tr><td> </td><td><font size=-1><em>set the state name.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a3">getName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>get the state name.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a4">addEvent</a> (<a class="el" href="classNLLOGIC_1_1CLogicEvent.html">CLogicEvent</a> event)</td></tr> +<tr><td> </td><td><font size=-1><em>Add an event.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a5">addSIdMap</a> (const <a class="el" href="namespaceNLLOGIC.html#a0">TSIdMap</a> &sIdMap)</td></tr> +<tr><td> </td><td><font size=-1><em>Associate message destination name with sid.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a6">processLogic</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Test the conditions of this state.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a7">getMessagesToSend</a> (std::multimap< <a class="el" href="structNLMISC_1_1CEntityId.html">NLMISC::CEntityId</a>, <a class="el" href="classNLNET_1_1CMessage.html">NLNET::CMessage</a> > &msgs)</td></tr> +<tr><td> </td><td><font size=-1><em>Get the messages to send.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a8">enterState</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>send the entry messages.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a9">exitState</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>send the exit messages.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a10">trySendEntryMessages</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Try to send the entry messages.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a11">trySendEventMessages</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Try to send the event messages.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a12">fillVarMap</a> (std::multimap< <a class="el" href="structNLMISC_1_1CEntityId.html">NLMISC::CEntityId</a>, std::string > &stateMachineVariables)</td></tr> +<tr><td> </td><td><font size=-1><em>Fill a map associating all the referenced var in the state with the id of service managing them (debug purpose).</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a13">write</a> (xmlNodePtr node) const</td></tr> +<tr><td> </td><td><font size=-1><em>serial.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#a14">read</a> (xmlNodePtr node)</td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#m0">_StateName</a></td></tr> +<tr><td> </td><td><font size=-1><em>state name.</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="classNLLOGIC_1_1CLogicEventMessage.html">CLogicEventMessage</a> > </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#m1">_EntryMessages</a></td></tr> +<tr><td> </td><td><font size=-1><em>entry messages.</em> <a href="#m1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="classNLLOGIC_1_1CLogicEventMessage.html">CLogicEventMessage</a> > </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#m2">_ExitMessages</a></td></tr> +<tr><td> </td><td><font size=-1><em>exit messages.</em> <a href="#m2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="classNLLOGIC_1_1CLogicEvent.html">CLogicEvent</a> > </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#m3">_Events</a></td></tr> +<tr><td> </td><td><font size=-1><em>logic.</em> <a href="#m3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLLOGIC_1_1CLogicStateMachine.html">CLogicStateMachine</a> * </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#m4">_LogicStateMachine</a></td></tr> +<tr><td> </td><td><font size=-1><em>state machine containing this state.</em> <a href="#m4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::multimap< <a class="el" href="structNLMISC_1_1CEntityId.html">NLMISC::CEntityId</a>,<br> + <a class="el" href="classNLNET_1_1CMessage.html">NLNET::CMessage</a> > </td><td valign=bottom><a class="el" href="classNLLOGIC_1_1CLogicState.html#m5">_MessagesToSend</a></td></tr> +<tr><td> </td><td><font size=-1><em>messages to send by the service.</em> <a href="#m5">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<a class="el" href="classNLLOGIC_1_1CLogicState.html">CLogicState</a>. +<p> +<dl compact><dt><b> +Author: </b><dd> +Stephane Coutelas , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00056">56</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLLOGIC::CLogicState::CLogicState"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLLOGIC::CLogicState::CLogicState </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Default constructor. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00042">42</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00073">_LogicStateMachine</a>, and <a class="el" href="logic__state_8h-source.html#l00061">_StateName</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="NLLOGIC::CLogicState::addEvent"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::addEvent </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLLOGIC_1_1CLogicEvent.html">CLogicEvent</a> </td> + <td class="mdname1" valign="top" nowrap> <em>event</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Add an event. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>event</em> </td><td> +is the event to add </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00081">81</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00070">_Events</a>, and <a class="el" href="logic__state_8h-source.html#l00073">_LogicStateMachine</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLLOGIC::CLogicState::addSIdMap"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::addSIdMap </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="namespaceNLLOGIC.html#a0">TSIdMap</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>sIdMap</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Associate message destination name with sid. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>sIdMap</em> </td><td> +is the map associating destination name with a destination id </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00096">96</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00064">_EntryMessages</a>, <a class="el" href="logic__state_8h-source.html#l00070">_Events</a>, <a class="el" href="logic__state_8h-source.html#l00067">_ExitMessages</a>, <a class="el" href="logic__state_8cpp-source.html#l00239">trySendEntryMessages</a>, <a class="el" href="logic__state_8cpp-source.html#l00265">trySendEventMessages</a>, and <a class="el" href="logic__state_8h-source.html#l00047">NLLOGIC::TSIdMap</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLLOGIC::CLogicState::enterState"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::enterState </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +send the entry messages. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00184">184</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8cpp-source.html#l00239">trySendEntryMessages</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLLOGIC::CLogicState::exitState"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::exitState </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +send the exit messages. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00196">196</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00064">_EntryMessages</a>, <a class="el" href="logic__state_8h-source.html#l00070">_Events</a>, <a class="el" href="logic__state_8h-source.html#l00067">_ExitMessages</a>, and <a class="el" href="logic__state_8h-source.html#l00076">_MessagesToSend</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLLOGIC::CLogicState::fillVarMap"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::fillVarMap </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::multimap< <a class="el" href="structNLMISC_1_1CEntityId.html">NLMISC::CEntityId</a>, std::string > & </td> + <td class="mdname1" valign="top" nowrap> <em>stateMachineVariables</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Fill a map associating all the referenced var in the state with the id of service managing them (debug purpose). +<p> + </td> + </tr> +</table> +<a name="a7" doxytag="NLLOGIC::CLogicState::getMessagesToSend"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::getMessagesToSend </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::multimap< <a class="el" href="structNLMISC_1_1CEntityId.html">NLMISC::CEntityId</a>, <a class="el" href="classNLNET_1_1CMessage.html">NLNET::CMessage</a> > & </td> + <td class="mdname1" valign="top" nowrap> <em>msgs</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the messages to send. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>msgs</em> </td><td> +is the map associating all the message to send with their destination id </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="NLLOGIC::CLogicState::getName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLLOGIC::CLogicState::getName </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +get the state name. +<p> +<dl compact><dt><b> +Returns: </b><dd> +the state's name </dl> +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00104">104</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00061">_StateName</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLLOGIC::CLogicState::processLogic"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::processLogic </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Test the conditions of this state. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00148">148</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00070">_Events</a>, <a class="el" href="logic__state_8h-source.html#l00073">_LogicStateMachine</a>, and <a class="el" href="logic__state_8cpp-source.html#l00265">trySendEventMessages</a>. </td> + </tr> +</table> +<a name="a14" doxytag="NLLOGIC::CLogicState::read"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::read </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">xmlNodePtr </td> + <td class="mdname1" valign="top" nowrap> <em>node</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00379">379</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00064">_EntryMessages</a>, <a class="el" href="logic__state_8h-source.html#l00070">_Events</a>, <a class="el" href="logic__state_8h-source.html#l00067">_ExitMessages</a>, <a class="el" href="logic__state_8h-source.html#l00061">_StateName</a>, <a class="el" href="logic__state__machine_8cpp-source.html#l00071">NLLOGIC::getXMLProp</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00234">v</a>, and <a class="el" href="logic__state__machine_8cpp-source.html#l00041">NLLOGIC::xmlCheckNodeName</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLLOGIC::CLogicState::setLogicStateMachine"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::setLogicStateMachine </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLLOGIC_1_1CLogicStateMachine.html">CLogicStateMachine</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>logicStateMachine</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the state machine which contains this state. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>logicStateMachine</em> </td><td> +is the state machine containing this block </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00054">54</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00070">_Events</a>, <a class="el" href="logic__state_8h-source.html#l00073">_LogicStateMachine</a>, and <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLLOGIC::CLogicState::setName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::setName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname1" valign="top" nowrap> <em>name</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +set the state name. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +is the new state's name </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00097">97</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00061">_StateName</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLLOGIC::CLogicState::trySendEntryMessages"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::trySendEntryMessages </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Try to send the entry messages. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00239">239</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00064">_EntryMessages</a>, and <a class="el" href="logic__state_8h-source.html#l00076">_MessagesToSend</a>. +<p> +Referenced by <a class="el" href="logic__state_8cpp-source.html#l00096">addSIdMap</a>, and <a class="el" href="logic__state_8cpp-source.html#l00184">enterState</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLLOGIC::CLogicState::trySendEventMessages"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::trySendEventMessages </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Try to send the event messages. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00265">265</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00070">_Events</a>, and <a class="el" href="logic__state_8h-source.html#l00076">_MessagesToSend</a>. +<p> +Referenced by <a class="el" href="logic__state_8cpp-source.html#l00096">addSIdMap</a>, and <a class="el" href="logic__state_8cpp-source.html#l00148">processLogic</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLLOGIC::CLogicState::write"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicState::write </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">xmlNodePtr </td> + <td class="mdname1" valign="top" nowrap> <em>node</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const</td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +serial. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8cpp-source.html#l00359">359</a> of file <a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a>. +<p> +References <a class="el" href="logic__state_8h-source.html#l00064">_EntryMessages</a>, <a class="el" href="logic__state_8h-source.html#l00070">_Events</a>, <a class="el" href="logic__state_8h-source.html#l00067">_ExitMessages</a>, and <a class="el" href="logic__state_8h-source.html#l00061">_StateName</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="m1" doxytag="NLLOGIC::CLogicState::_EntryMessages"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::vector<<a class="el" href="classNLLOGIC_1_1CLogicEventMessage.html">CLogicEventMessage</a>> NLLOGIC::CLogicState::_EntryMessages + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +entry messages. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00064">64</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>. +<p> +Referenced by <a class="el" href="logic__state_8cpp-source.html#l00096">addSIdMap</a>, <a class="el" href="logic__state_8cpp-source.html#l00196">exitState</a>, <a class="el" href="logic__state_8cpp-source.html#l00379">read</a>, <a class="el" href="logic__state_8cpp-source.html#l00239">trySendEntryMessages</a>, and <a class="el" href="logic__state_8cpp-source.html#l00359">write</a>. </td> + </tr> +</table> +<a name="m3" doxytag="NLLOGIC::CLogicState::_Events"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::vector<<a class="el" href="classNLLOGIC_1_1CLogicEvent.html">CLogicEvent</a>> NLLOGIC::CLogicState::_Events + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +logic. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00070">70</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>. +<p> +Referenced by <a class="el" href="logic__state_8cpp-source.html#l00081">addEvent</a>, <a class="el" href="logic__state_8cpp-source.html#l00096">addSIdMap</a>, <a class="el" href="logic__state_8cpp-source.html#l00196">exitState</a>, <a class="el" href="logic__state_8cpp-source.html#l00148">processLogic</a>, <a class="el" href="logic__state_8cpp-source.html#l00379">read</a>, <a class="el" href="logic__state_8cpp-source.html#l00054">setLogicStateMachine</a>, <a class="el" href="logic__state_8cpp-source.html#l00265">trySendEventMessages</a>, and <a class="el" href="logic__state_8cpp-source.html#l00359">write</a>. </td> + </tr> +</table> +<a name="m2" doxytag="NLLOGIC::CLogicState::_ExitMessages"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::vector<<a class="el" href="classNLLOGIC_1_1CLogicEventMessage.html">CLogicEventMessage</a>> NLLOGIC::CLogicState::_ExitMessages + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +exit messages. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00067">67</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>. +<p> +Referenced by <a class="el" href="logic__state_8cpp-source.html#l00096">addSIdMap</a>, <a class="el" href="logic__state_8cpp-source.html#l00196">exitState</a>, <a class="el" href="logic__state_8cpp-source.html#l00379">read</a>, and <a class="el" href="logic__state_8cpp-source.html#l00359">write</a>. </td> + </tr> +</table> +<a name="m4" doxytag="NLLOGIC::CLogicState::_LogicStateMachine"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLLOGIC_1_1CLogicStateMachine.html">CLogicStateMachine</a>* NLLOGIC::CLogicState::_LogicStateMachine + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +state machine containing this state. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00073">73</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>. +<p> +Referenced by <a class="el" href="logic__state_8cpp-source.html#l00081">addEvent</a>, <a class="el" href="logic__state_8cpp-source.html#l00042">CLogicState</a>, <a class="el" href="logic__state_8cpp-source.html#l00148">processLogic</a>, and <a class="el" href="logic__state_8cpp-source.html#l00054">setLogicStateMachine</a>. </td> + </tr> +</table> +<a name="m5" doxytag="NLLOGIC::CLogicState::_MessagesToSend"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::multimap<<a class="el" href="structNLMISC_1_1CEntityId.html">NLMISC::CEntityId</a>, <a class="el" href="classNLNET_1_1CMessage.html">NLNET::CMessage</a>> NLLOGIC::CLogicState::_MessagesToSend + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +messages to send by the service. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00076">76</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>. +<p> +Referenced by <a class="el" href="logic__state_8cpp-source.html#l00196">exitState</a>, <a class="el" href="logic__state_8cpp-source.html#l00239">trySendEntryMessages</a>, and <a class="el" href="logic__state_8cpp-source.html#l00265">trySendEventMessages</a>. </td> + </tr> +</table> +<a name="m0" doxytag="NLLOGIC::CLogicState::_StateName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLLOGIC::CLogicState::_StateName + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +state name. +<p> + +<p> +Definition at line <a class="el" href="logic__state_8h-source.html#l00061">61</a> of file <a class="el" href="logic__state_8h-source.html">logic_state.h</a>. +<p> +Referenced by <a class="el" href="logic__state_8cpp-source.html#l00042">CLogicState</a>, <a class="el" href="logic__state_8h-source.html#l00104">getName</a>, <a class="el" href="logic__state_8cpp-source.html#l00379">read</a>, <a class="el" href="logic__state_8h-source.html#l00097">setName</a>, and <a class="el" href="logic__state_8cpp-source.html#l00359">write</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="logic__state_8h-source.html">logic_state.h</a><li><a class="el" href="logic__state_8cpp-source.html">logic_state.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |