diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a02823.html | 378 |
1 files changed, 378 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02823.html b/docs/doxygen/nel/a02823.html new file mode 100644 index 00000000..32b74b14 --- /dev/null +++ b/docs/doxygen/nel/a02823.html @@ -0,0 +1,378 @@ +<!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::CLogicEventMessage 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::CLogicEventMessage 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="a02823.html">CLogicEventMessage</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#l00051">51</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="a02823.html#NLLOGIC_1_1CLogicEventMessagea0">CLogicEventMessage</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02823.html#NLLOGIC_1_1CLogicEventMessagea1">read</a> (xmlNodePtr node, const char *subName="")</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02823.html#NLLOGIC_1_1CLogicEventMessagea2">write</a> (xmlNodePtr node, const char *subName="") 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="a02823.html#NLLOGIC_1_1CLogicEventMessageo0">Arguments</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">message arguments <a href="#NLLOGIC_1_1CLogicEventMessageo0"></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo1">Destination</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">message destination <a href="#NLLOGIC_1_1CLogicEventMessageo1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02189.html">NLMISC::CEntityId</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo2">DestinationId</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">message destination id <a href="#NLLOGIC_1_1CLogicEventMessageo2"></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo3">MessageId</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">message id <a href="#NLLOGIC_1_1CLogicEventMessageo3"></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo4">Sent</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">true if the message has been sent <a href="#NLLOGIC_1_1CLogicEventMessageo4"></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo5">ToSend</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">true if the message has to be sent <a href="#NLLOGIC_1_1CLogicEventMessageo5"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessagea0" doxytag="NLLOGIC::CLogicEventMessage::CLogicEventMessage" ></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::CLogicEventMessage::CLogicEventMessage </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#l00076">76</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +References <a class="el" href="a05949.html#l00071">Arguments</a>, <a class="el" href="a05949.html#l00062">Destination</a>, <a class="el" href="a05949.html#l00065">DestinationId</a>, <a class="el" href="a05949.html#l00068">MessageId</a>, <a class="el" href="a05949.html#l00059">Sent</a>, <a class="el" href="a05673.html#l00251">NLMISC::CEntityId::setCreatorId()</a>, <a class="el" href="a05673.html#l00239">NLMISC::CEntityId::setDynamicId()</a>, <a class="el" href="a05673.html#l00263">NLMISC::CEntityId::setType()</a>, and <a class="el" href="a05949.html#l00056">ToSend</a>. +<p> +<div class="fragment"><pre>00077 { +00078 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo5">ToSend</a> = <span class="keyword">false</span>; +00079 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo4">Sent</a> = <span class="keyword">false</span>; +00080 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo1">Destination</a> = <span class="stringliteral">"no_destination"</span>; +00081 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo3">MessageId</a> = <span class="stringliteral">"no_id"</span>; +00082 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo2">DestinationId</a>.<a class="code" href="a02189.html#NLAIAGENT_1_1CIdenta29">setType</a>( 0xfe ); +00083 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo2">DestinationId</a>.<a class="code" href="a02189.html#NLAIAGENT_1_1CIdenta26">setCreatorId</a>( 0 ); +00084 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo2">DestinationId</a>.<a class="code" href="a02189.html#NLAIAGENT_1_1CIdenta27">setDynamicId</a>( 0 ); +00085 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo0">Arguments</a> = <span class="stringliteral">"no_arguments"</span>; +00086 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessagea1" doxytag="NLLOGIC::CLogicEventMessage::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::CLogicEventMessage::read </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">xmlNodePtr </td> + <td class="mdname" nowrap> <em>node</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>subName</em> = ""</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></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#l00068">68</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00071">Arguments</a>, <a class="el" href="a05949.html#l00062">Destination</a>, <a class="el" href="a05949.html#l00065">DestinationId</a>, <a class="el" href="a05954.html#l00072">NLLOGIC::getXMLProp()</a>, <a class="el" href="a05949.html#l00068">MessageId</a>, and <a class="el" href="a05954.html#l00042">NLLOGIC::xmlCheckNodeName()</a>. +<p> +Referenced by <a class="el" href="a05948.html#l00132">NLLOGIC::CLogicEventAction::read()</a>. +<p> +<div class="fragment"><pre>00069 { +00070 <a class="code" href="a05376.html#a2">xmlCheckNodeName</a> (node, string(string(subName)+string(<span class="stringliteral">"EVENT_MESSAGE"</span>)).c_str()); +00071 +00072 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo1">Destination</a> = <a class="code" href="a05376.html#a3">getXMLProp</a> (node, <span class="stringliteral">"Destination"</span>); +00073 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo2">DestinationId</a> = <a class="code" href="a05364.html#a43">atoiInt64</a>(getXMLProp (node, <span class="stringliteral">"DestinationId"</span>).c_str()); +00074 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo3">MessageId</a> = <a class="code" href="a05376.html#a3">getXMLProp</a> (node, <span class="stringliteral">"MessageId"</span>); +00075 <a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo0">Arguments</a> = <a class="code" href="a05376.html#a3">getXMLProp</a> (node, <span class="stringliteral">"Arguments"</span>); +00076 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessagea2" doxytag="NLLOGIC::CLogicEventMessage::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::CLogicEventMessage::write </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">xmlNodePtr </td> + <td class="mdname" nowrap> <em>node</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>subName</em> = ""</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> 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#l00059">59</a> of file <a class="el" href="a05948.html">logic_event.cpp</a>. +<p> +References <a class="el" href="a05949.html#l00071">Arguments</a>, <a class="el" href="a05949.html#l00062">Destination</a>, <a class="el" href="a05949.html#l00065">DestinationId</a>, and <a class="el" href="a05949.html#l00068">MessageId</a>. +<p> +Referenced by <a class="el" href="a05948.html#l00118">NLLOGIC::CLogicEventAction::write()</a>. +<p> +<div class="fragment"><pre>00060 { +00061 xmlNodePtr elmPtr = xmlNewChild ( node, NULL, (<span class="keyword">const</span> xmlChar*)string(string(subName)+string(<span class="stringliteral">"EVENT_MESSAGE"</span>)).c_str(), NULL); +00062 xmlSetProp (elmPtr, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"Destination"</span>, (<span class="keyword">const</span> xmlChar*)<a class="code" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo1">Destination</a>.c_str()); +00063 xmlSetProp (elmPtr, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"DestinationId"</span>, (<span class="keyword">const</span> xmlChar*)<a class="code" href="a05378.html#a244">toString</a>(DestinationId).c_str()); +00064 xmlSetProp (elmPtr, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"MessageId"</span>, (<span class="keyword">const</span> xmlChar*)<a class="code" href="a05378.html#a244">toString</a>(MessageId).c_str()); +00065 xmlSetProp (elmPtr, (<span class="keyword">const</span> xmlChar*)<span class="stringliteral">"Arguments"</span>, (<span class="keyword">const</span> xmlChar*)<a class="code" href="a05378.html#a244">toString</a>(Arguments).c_str()); +00066 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessageo0" doxytag="NLLOGIC::CLogicEventMessage::Arguments" ></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo0">NLLOGIC::CLogicEventMessage::Arguments</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +message arguments +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00071">71</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05949.html#l00076">CLogicEventMessage()</a>, <a class="el" href="a05948.html#l00068">read()</a>, and <a class="el" href="a05948.html#l00059">write()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessageo1" doxytag="NLLOGIC::CLogicEventMessage::Destination" ></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo1">NLLOGIC::CLogicEventMessage::Destination</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +message destination +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00062">62</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05949.html#l00076">CLogicEventMessage()</a>, <a class="el" href="a05948.html#l00068">read()</a>, and <a class="el" href="a05948.html#l00059">write()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessageo2" doxytag="NLLOGIC::CLogicEventMessage::DestinationId" ></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="a02189.html">NLMISC::CEntityId</a> <a class="el" href="a02823.html#NLLOGIC_1_1CLogicEventMessageo2">NLLOGIC::CLogicEventMessage::DestinationId</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +message destination id +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00065">65</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05949.html#l00076">CLogicEventMessage()</a>, <a class="el" href="a05948.html#l00068">read()</a>, and <a class="el" href="a05948.html#l00059">write()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessageo3" doxytag="NLLOGIC::CLogicEventMessage::MessageId" ></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo3">NLLOGIC::CLogicEventMessage::MessageId</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +message id +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00068">68</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05949.html#l00076">CLogicEventMessage()</a>, <a class="el" href="a05948.html#l00068">read()</a>, and <a class="el" href="a05948.html#l00059">write()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessageo4" doxytag="NLLOGIC::CLogicEventMessage::Sent" ></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo4">NLLOGIC::CLogicEventMessage::Sent</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +true if the message has been sent +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00059">59</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05949.html#l00076">CLogicEventMessage()</a>, and <a class="el" href="a05948.html#l00162">NLLOGIC::CLogicEvent::reset()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLLOGIC_1_1CLogicEventMessageo5" doxytag="NLLOGIC::CLogicEventMessage::ToSend" ></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="a02823.html#NLLOGIC_1_1CLogicEventMessageo5">NLLOGIC::CLogicEventMessage::ToSend</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +true if the message has to be sent +<p> + +<p> +Definition at line <a class="el" href="a05949.html#l00056">56</a> of file <a class="el" href="a05949.html">logic_event.h</a>. +<p> +Referenced by <a class="el" href="a05949.html#l00076">CLogicEventMessage()</a>, <a class="el" href="a05948.html#l00089">NLLOGIC::CLogicEventAction::enableSendMessage()</a>, and <a class="el" href="a05948.html#l00162">NLLOGIC::CLogicEvent::reset()</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:54:05 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> |