diff options
Diffstat (limited to 'docs/doxygen/nel/a02821.html')
| -rw-r--r-- | docs/doxygen/nel/a02821.html | 418 |
1 files changed, 418 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02821.html b/docs/doxygen/nel/a02821.html new file mode 100644 index 00000000..897d3b9e --- /dev/null +++ b/docs/doxygen/nel/a02821.html @@ -0,0 +1,418 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLLOGIC::CLogicEvent class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLLOGIC::CLogicEvent Class Reference</h1><code>#include <<a class="el" href="a05949.html">logic_event.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<a class="el" href="a02821.html">CLogicEvent</a><p> +<dl compact><dt><b>Author:</b></dt><dd>Stephane Coutelas <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00149">149</a> of file <a class="el" href="a05949.html">logic_event.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEventa0">CLogicEvent</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEventa1">read</a> (xmlNodePtr node)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEventa2">reset</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEventa3">setLogicStateMachine</a> (<a class="el" href="a02825.html">CLogicStateMachine</a> *logicStateMachine)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEventa4">testCondition</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEventa5">write</a> (xmlNodePtr node) const </td></tr> + +<tr><td colspan=2><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEvento0">ConditionName</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">condition name <a href="#NLLOGIC_1_1CLogicEvento0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02822.html">CLogicEventAction</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEvento1">EventAction</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">event action <a href="#NLLOGIC_1_1CLogicEvento1"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02825.html">CLogicStateMachine</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02821.html#NLLOGIC_1_1CLogicEventr0">_LogicStateMachine</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">state machine managing this event <a href="#NLLOGIC_1_1CLogicEventr0"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventa0" doxytag="NLLOGIC::CLogicEvent::CLogicEvent" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLLOGIC::CLogicEvent::CLogicEvent </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> +Default constructor +<p> +Definition at line <a class="el" href="a05949.html#l00165">165</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +References <a class="el" href="a05949.html#l00157">ConditionName</a>. +<p> +<div class="fragment"><pre>00166 { +00167 <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEventr0">_LogicStateMachine</a> = 0; +00168 <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento0">ConditionName</a> = <span class="stringliteral">"no_condition"</span>; +00169 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventa1" doxytag="NLLOGIC::CLogicEvent::read" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicEvent::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="a05948.html#l00250">250</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00157">ConditionName</a>, <a class="el" href="a05949.html#l00160">EventAction</a>, <a class="el" href="a05954.html#l00072">NLLOGIC::getXMLProp()</a>, <a class="el" href="a05948.html#l00132">NLLOGIC::CLogicEventAction::read()</a>, and <a class="el" href="a05954.html#l00042">NLLOGIC::xmlCheckNodeName()</a>. +<p> +<div class="fragment"><pre>00251 { +00252 <a class="code" href="a05376.html#a2">xmlCheckNodeName</a> (node, <span class="stringliteral">"EVENT"</span>); +00253 +00254 <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento0">ConditionName</a> = <a class="code" href="a05376.html#a3">getXMLProp</a> (node, <span class="stringliteral">"ConditionName"</span>); +00255 <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento1">EventAction</a>.read(node); +00256 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventa2" doxytag="NLLOGIC::CLogicEvent::reset" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicEvent::reset </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> +Reset this event +<p> +Definition at line <a class="el" href="a05948.html#l00162">162</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00160">EventAction</a>, <a class="el" href="a05949.html#l00116">NLLOGIC::CLogicEventAction::EventMessage</a>, <a class="el" href="a05949.html#l00059">NLLOGIC::CLogicEventMessage::Sent</a>, and <a class="el" href="a05949.html#l00056">NLLOGIC::CLogicEventMessage::ToSend</a>. +<p> +<div class="fragment"><pre>00163 { +00164 <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento1">EventAction</a>.EventMessage.Sent = <span class="keyword">false</span>; +00165 <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento1">EventAction</a>.EventMessage.ToSend = <span class="keyword">false</span>; +00166 +00167 } <span class="comment">// reset //</span> +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventa3" doxytag="NLLOGIC::CLogicEvent::setLogicStateMachine" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicEvent::setLogicStateMachine </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02825.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 logic state machine<p> +<dl compact><dt><b>Parameters:</b></dt><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="a05948.html#l00175">175</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05622.html#l00135">nlwarning</a>. +<p> +Referenced by <a class="el" href="a05952.html#l00081">NLLOGIC::CLogicState::addEvent()</a>. +<p> +<div class="fragment"><pre>00176 { +00177 <span class="keywordflow">if</span>( logicStateMachine == 0 ) +00178 { +00179 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"(LOGIC)<CLogicEvent::setLogicStateMachine> The state machine is null"</span>); +00180 } +00181 <span class="keywordflow">else</span> +00182 { +00183 <span class="comment">// init the logic state machine for this event</span> +00184 <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEventr0">_LogicStateMachine</a> = logicStateMachine; +00185 } +00186 +00187 } <span class="comment">// setLogicStateMachine //</span> +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventa4" doxytag="NLLOGIC::CLogicEvent::testCondition" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLLOGIC::CLogicEvent::testCondition </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 condition<p> +<dl compact><dt><b>Returns:</b></dt><dd>true if condition is fulfiled</dd></dl> + +<p> +Definition at line <a class="el" href="a05948.html#l00195">195</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00157">ConditionName</a>, <a class="el" href="a05954.html#l00233">NLLOGIC::CLogicStateMachine::getCondition()</a>, <a class="el" href="a05622.html#l00135">nlwarning</a>, and <a class="el" href="a05946.html#l00550">NLLOGIC::CLogicCondition::testLogic()</a>. +<p> +<div class="fragment"><pre>00196 { +00197 <span class="keywordflow">if</span>( <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEventr0">_LogicStateMachine</a> ) +00198 { +00199 <span class="keywordflow">if</span>( <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento0">ConditionName</a> != <span class="stringliteral">"no_condition"</span> ) +00200 { +00201 CLogicCondition cond; +00202 <span class="keywordflow">if</span>( <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEventr0">_LogicStateMachine</a>->getCondition( ConditionName, cond ) ) +00203 { +00204 <span class="keywordflow">return</span> cond.testLogic(); +00205 } +00206 <span class="keywordflow">else</span> +00207 { +00208 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"(LOGIC)<CLogicEvent::testCondition> Condition %s not found in the state machine"</span>,<a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento0">ConditionName</a>.c_str()); +00209 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00210 } +00211 } +00212 <span class="keywordflow">else</span> +00213 { +00214 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"(LOGIC)<CLogicEvent::testCondition> Condition undefined"</span>); +00215 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00216 } +00217 } +00218 <span class="keywordflow">else</span> +00219 { +00220 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"(LOGIC)<CLogicEvent::testCondition> The state machine managing this event is Null"</span>); +00221 } +00222 +00223 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00224 +00225 } <span class="comment">// testCondition //</span> +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventa5" doxytag="NLLOGIC::CLogicEvent::write" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLLOGIC::CLogicEvent::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> +Definition at line <a class="el" href="a05948.html#l00243">243</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00157">ConditionName</a>, <a class="el" href="a05949.html#l00160">EventAction</a>, and <a class="el" href="a05948.html#l00118">NLLOGIC::CLogicEventAction::write()</a>. +<p> +<div class="fragment"><pre>00244 { +00245 xmlNodePtr elmPtr = xmlNewChild ( node, NULL, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"EVENT"</span>, NULL); +00246 xmlSetProp (elmPtr, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"ConditionName"</span>, (<span class="keyword">const</span> xmlChar*)<a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento0">ConditionName</a>.c_str()); +00247 <a class="code" href="a02821.html#NLLOGIC_1_1CLogicEvento1">EventAction</a>.write(elmPtr); +00248 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventr0" doxytag="NLLOGIC::CLogicEvent::_LogicStateMachine" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a02825.html">CLogicStateMachine</a>* <a class="el" href="a02821.html#NLLOGIC_1_1CLogicEventr0">NLLOGIC::CLogicEvent::_LogicStateMachine</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +state machine managing this event +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00152">152</a> of file <a class="el" href="a05949.html">logic_event.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEvento0" doxytag="NLLOGIC::CLogicEvent::ConditionName" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string <a class="el" href="a02821.html#NLLOGIC_1_1CLogicEvento0">NLLOGIC::CLogicEvent::ConditionName</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +condition name +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00157">157</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05949.html#l00165">CLogicEvent()</a>, <a class="el" href="a05948.html#l00250">read()</a>, <a class="el" href="a05948.html#l00195">testCondition()</a>, and <a class="el" href="a05948.html#l00243">write()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEvento1" doxytag="NLLOGIC::CLogicEvent::EventAction" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a02822.html">CLogicEventAction</a> <a class="el" href="a02821.html#NLLOGIC_1_1CLogicEvento1">NLLOGIC::CLogicEvent::EventAction</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +event action +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00160">160</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05948.html#l00250">read()</a>, <a class="el" href="a05948.html#l00162">reset()</a>, and <a class="el" href="a05948.html#l00243">write()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a05949.html">logic_event.h</a><li><a class="el" href="a05948.html">logic_event.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 12:53:54 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |