diff options
Diffstat (limited to 'docs/doxygen/nel/a02822.html')
| -rw-r--r-- | docs/doxygen/nel/a02822.html | 310 |
1 files changed, 310 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02822.html b/docs/doxygen/nel/a02822.html new file mode 100644 index 00000000..b00034d9 --- /dev/null +++ b/docs/doxygen/nel/a02822.html @@ -0,0 +1,310 @@ +<!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::CLogicEventAction 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::CLogicEventAction 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="a02822.html">CLogicEventAction</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#l00105">105</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="a02822.html#NLLOGIC_1_1CLogicEventActiona0">CLogicEventAction</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02822.html#NLLOGIC_1_1CLogicEventActiona1">enableSendMessage</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02822.html#NLLOGIC_1_1CLogicEventActiona2">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="a02822.html#NLLOGIC_1_1CLogicEventActiona3">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><a class="el" href="a02823.html">CLogicEventMessage</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02822.html#NLLOGIC_1_1CLogicEventActiono0">EventMessage</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">event message <a href="#NLLOGIC_1_1CLogicEventActiono0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02822.html#NLLOGIC_1_1CLogicEventActiono1">IsStateChange</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this action consist in a state change, false if it's a message <a href="#NLLOGIC_1_1CLogicEventActiono1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a02822.html#NLLOGIC_1_1CLogicEventActiono2">StateChange</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">state name for state change <a href="#NLLOGIC_1_1CLogicEventActiono2"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventActiona0" doxytag="NLLOGIC::CLogicEventAction::CLogicEventAction" ></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::CLogicEventAction::CLogicEventAction </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#l00121">121</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +References <a class="el" href="a05949.html#l00110">IsStateChange</a>. +<p> +<div class="fragment"><pre>00122 { +00123 <a class="code" href="a02822.html#NLLOGIC_1_1CLogicEventActiono1">IsStateChange</a> = <span class="keyword">false</span>; +00124 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventActiona1" doxytag="NLLOGIC::CLogicEventAction::enableSendMessage" ></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::CLogicEventAction::enableSendMessage </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> +This message will be sent as soon as the dest id will be given +<p> +Definition at line <a class="el" href="a05948.html#l00089">89</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00116">EventMessage</a>, and <a class="el" href="a05949.html#l00056">NLLOGIC::CLogicEventMessage::ToSend</a>. +<p> +<div class="fragment"><pre>00090 { +00091 <a class="code" href="a02822.html#NLLOGIC_1_1CLogicEventActiono0">EventMessage</a>.ToSend = <span class="keyword">true</span>; +00092 +00093 } <span class="comment">// enableSendMessage //</span> +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventActiona2" doxytag="NLLOGIC::CLogicEventAction::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::CLogicEventAction::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#l00132">132</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00116">EventMessage</a>, <a class="el" href="a05954.html#l00072">NLLOGIC::getXMLProp()</a>, <a class="el" href="a05949.html#l00110">IsStateChange</a>, <a class="el" href="a05948.html#l00068">NLLOGIC::CLogicEventMessage::read()</a>, <a class="el" href="a05949.html#l00113">StateChange</a>, and <a class="el" href="a05954.html#l00042">NLLOGIC::xmlCheckNodeName()</a>. +<p> +Referenced by <a class="el" href="a05948.html#l00250">NLLOGIC::CLogicEvent::read()</a>. +<p> +<div class="fragment"><pre>00133 { +00134 <a class="code" href="a05376.html#a2">xmlCheckNodeName</a> (node, <span class="stringliteral">"EVENT_ACTION"</span>); +00135 +00136 <a class="code" href="a02822.html#NLLOGIC_1_1CLogicEventActiono1">IsStateChange</a> = atoi(getXMLProp (node, <span class="stringliteral">"IsStateChange"</span>).c_str()) == 1; +00137 <span class="keywordflow">if</span> (<a class="code" href="a02822.html#NLLOGIC_1_1CLogicEventActiono1">IsStateChange</a>) +00138 { +00139 <a class="code" href="a02822.html#NLLOGIC_1_1CLogicEventActiono2">StateChange</a> = <a class="code" href="a05376.html#a3">getXMLProp</a> (node, <span class="stringliteral">"StateChange"</span>); +00140 } +00141 <span class="keywordflow">else</span> +00142 { +00143 <a class="code" href="a02822.html#NLLOGIC_1_1CLogicEventActiono0">EventMessage</a>.read(node); +00144 } +00145 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventActiona3" doxytag="NLLOGIC::CLogicEventAction::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::CLogicEventAction::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#l00118">118</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00116">EventMessage</a>, <a class="el" href="a05949.html#l00110">IsStateChange</a>, <a class="el" href="a05949.html#l00113">StateChange</a>, and <a class="el" href="a05948.html#l00059">NLLOGIC::CLogicEventMessage::write()</a>. +<p> +Referenced by <a class="el" href="a05948.html#l00243">NLLOGIC::CLogicEvent::write()</a>. +<p> +<div class="fragment"><pre>00119 { +00120 xmlNodePtr elmPtr = xmlNewChild ( node, NULL, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"EVENT_ACTION"</span>, NULL); +00121 xmlSetProp (elmPtr, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"IsStateChange"</span>, (<span class="keyword">const</span> xmlChar*)<a class="code" href="a05378.html#a244">toString</a>(IsStateChange).c_str()); +00122 <span class="keywordflow">if</span> (IsStateChange) +00123 { +00124 xmlSetProp (elmPtr, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"StateChange"</span>, (<span class="keyword">const</span> xmlChar*)<a class="code" href="a02822.html#NLLOGIC_1_1CLogicEventActiono2">StateChange</a>.c_str()); +00125 } +00126 <span class="keywordflow">else</span> +00127 { +00128 <a class="code" href="a02822.html#NLLOGIC_1_1CLogicEventActiono0">EventMessage</a>.write(elmPtr); +00129 } +00130 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventActiono0" doxytag="NLLOGIC::CLogicEventAction::EventMessage" ></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="a02823.html">CLogicEventMessage</a> <a class="el" href="a02822.html#NLLOGIC_1_1CLogicEventActiono0">NLLOGIC::CLogicEventAction::EventMessage</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +event message +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00116">116</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05948.html#l00089">enableSendMessage()</a>, <a class="el" href="a05948.html#l00132">read()</a>, <a class="el" href="a05948.html#l00162">NLLOGIC::CLogicEvent::reset()</a>, and <a class="el" href="a05948.html#l00118">write()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventActiono1" doxytag="NLLOGIC::CLogicEventAction::IsStateChange" ></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 <a class="el" href="a02822.html#NLLOGIC_1_1CLogicEventActiono1">NLLOGIC::CLogicEventAction::IsStateChange</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +true if this action consist in a state change, false if it's a message +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00110">110</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05949.html#l00121">CLogicEventAction()</a>, <a class="el" href="a05948.html#l00132">read()</a>, and <a class="el" href="a05948.html#l00118">write()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventActiono2" doxytag="NLLOGIC::CLogicEventAction::StateChange" ></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="a02822.html#NLLOGIC_1_1CLogicEventActiono2">NLLOGIC::CLogicEventAction::StateChange</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +state name for state change +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00113">113</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05948.html#l00132">read()</a>, and <a class="el" href="a05948.html#l00118">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:59 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> |