diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a02395.html | 323 |
1 files changed, 323 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02395.html b/docs/doxygen/nel/a02395.html new file mode 100644 index 00000000..2c576d50 --- /dev/null +++ b/docs/doxygen/nel/a02395.html @@ -0,0 +1,323 @@ +<!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: NLAISCRIPT::CComponent struct 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>NLAISCRIPT::CComponent Struct Reference</h1><code>#include <<a class="el" href="a05846.html">interpret_object.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Struct <a class="el" href="a02395.html">CComponent</a>.<p> +This structer is used for define a component characteristic.<p> +<dl compact><dt><b>Author:</b></dt><dd>Chafik sameh <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2000</dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a05846.html#l00044">44</a> of file <a class="el" href="a05846.html">interpret_object.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="a02395.html#NLAISCRIPT_1_1CComponenta0">CComponent</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02395.html#NLAISCRIPT_1_1CComponenta1">load</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02395.html#NLAISCRIPT_1_1CComponenta2">save</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &)</td></tr> + +<tr><td colspan=2><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02395.html#NLAISCRIPT_1_1CComponento0">Local</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02661.html">NLAIAGENT::IVarName</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02395.html#NLAISCRIPT_1_1CComponento1">ObjectName</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the Component. <a href="#NLAISCRIPT_1_1CComponento1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02661.html">NLAIAGENT::IVarName</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02395.html#NLAISCRIPT_1_1CComponento2">RegisterName</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Component type name. <a href="#NLAISCRIPT_1_1CComponento2"></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="a02395.html#NLAISCRIPT_1_1CComponento3">Static</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02149.html">NLAIAGENT::IObjectIA</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02395.html#NLAISCRIPT_1_1CComponento4">StaticValue</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Static value if the component is a static one. <a href="#NLAISCRIPT_1_1CComponento4"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLAISCRIPT_1_1CComponenta0" doxytag="NLAISCRIPT::CComponent::CComponent" ></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"> NLAISCRIPT::CComponent::CComponent </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> + +<p> +Definition at line <a class="el" href="a05846.html#l00061">61</a> of file <a class="el" href="a05846.html">interpret_object.h</a>. +<p> +References <a class="el" href="a05846.html#l00059">Local</a>, <a class="el" href="a05846.html#l00049">ObjectName</a>, <a class="el" href="a05846.html#l00047">RegisterName</a>, <a class="el" href="a05846.html#l00060">Static</a>, and <a class="el" href="a05846.html#l00051">StaticValue</a>. +<p> +<div class="fragment"><pre>00062 { +00063 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento2">RegisterName</a> = NULL; <span class="comment">// name of the type of component in the registry</span> +00064 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento1">ObjectName</a> = NULL; <span class="comment">// name of the member component in the class</span> +00065 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento0">Local</a> = <span class="keyword">false</span>; <span class="comment">// true if the object is not accessible from a remote machine</span> +00066 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento3">Static</a> = <span class="keyword">false</span>; <span class="comment">// true if the component is static (defined and stored in the class)</span> +00067 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento4">StaticValue</a> = NULL; <span class="comment">// static value of the component, NULL if non static</span> +00068 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLAISCRIPT_1_1CComponenta1" doxytag="NLAISCRIPT::CComponent::load" ></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 NLAISCRIPT::CComponent::load </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> & </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Load component characteristic. +<p> +Definition at line <a class="el" href="a05845.html#l00038">38</a> of file <a class="el" href="a05845.html">interpret_object.cpp</a>. +<p> +References <a class="el" href="a05386.html#l00080">NLAIC::IPointerGestion::incRef()</a>, <a class="el" href="a05386.html#l00350">NLAIC::IBasicInterface::load()</a>, <a class="el" href="a05846.html#l00049">ObjectName</a>, <a class="el" href="a05846.html#l00047">RegisterName</a>, and <a class="el" href="a06462.html#l00232">NLMISC::IStream::serial()</a>. +<p> +Referenced by <a class="el" href="a05847.html#l00783">NLAISCRIPT::CAgentClass::load()</a>. +<p> +<div class="fragment"><pre>00039 { +00040 <a class="code" href="a02651.html">NLAIC::CIdentTypeAlloc</a> <span class="keywordtype">id</span>; +00041 is.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a>( <span class="keywordtype">id</span> ); +00042 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento2">RegisterName</a> = (<a class="code" href="a02661.html">NLAIAGENT::IVarName</a> *) <span class="keywordtype">id</span>.allocClass(); +00043 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento2">RegisterName</a>-><a class="code" href="a02154.html#NLAIAGENT_1_1IWordNumRefa10">load</a>( is ); +00044 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento2">RegisterName</a>-><a class="code" href="a02145.html#NLAIAGENT_1_1VectorTypea16">incRef</a>(); +00045 +00046 is.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a>( <span class="keywordtype">id</span> ); +00047 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento1">ObjectName</a> = (<a class="code" href="a02661.html">NLAIAGENT::IVarName</a> *) <span class="keywordtype">id</span>.allocClass(); +00048 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento1">ObjectName</a>-><a class="code" href="a02154.html#NLAIAGENT_1_1IWordNumRefa10">load</a>( is ); +00049 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento1">ObjectName</a>-><a class="code" href="a02145.html#NLAIAGENT_1_1VectorTypea16">incRef</a>(); +00050 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLAISCRIPT_1_1CComponenta2" doxytag="NLAISCRIPT::CComponent::save" ></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 NLAISCRIPT::CComponent::save </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> & </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Save component characteristic. +<p> +Definition at line <a class="el" href="a05845.html#l00030">30</a> of file <a class="el" href="a05845.html">interpret_object.cpp</a>. +<p> +References <a class="el" href="a02151.html#NLAICHARACTER_1_1IZonea20">NLAIC::IBasicType::getType()</a>, <a class="el" href="a05846.html#l00049">ObjectName</a>, <a class="el" href="a05846.html#l00047">RegisterName</a>, <a class="el" href="a05386.html#l00346">NLAIC::IBasicInterface::save()</a>, and <a class="el" href="a06462.html#l00232">NLMISC::IStream::serial()</a>. +<p> +<div class="fragment"><pre>00031 { +00032 os.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a>( (<a class="code" href="a02650.html">NLAIC::CIdentType</a> &) <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento2">RegisterName</a>-><a class="code" href="a02151.html#NLAICHARACTER_1_1IZonea20">getType</a>() ); +00033 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento2">RegisterName</a>-><a class="code" href="a02154.html#NLAIAGENT_1_1IWordNumRefa14">save</a>( os ); +00034 os.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a>( (<a class="code" href="a02650.html">NLAIC::CIdentType</a> &) <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento1">ObjectName</a>-><a class="code" href="a02151.html#NLAICHARACTER_1_1IZonea20">getType</a>() ); +00035 <a class="code" href="a02395.html#NLAISCRIPT_1_1CComponento1">ObjectName</a>-><a class="code" href="a02154.html#NLAIAGENT_1_1IWordNumRefa14">save</a>( os ); +00036 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLAISCRIPT_1_1CComponento0" doxytag="NLAISCRIPT::CComponent::Local" ></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="a02395.html#NLAISCRIPT_1_1CComponento0">NLAISCRIPT::CComponent::Local</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Local define the distribution type.<p> +If it true then the component is all time local. If it false the component can be just distributed in the server. And we can't manipulate directly but by message. +<p> +Definition at line <a class="el" href="a05846.html#l00059">59</a> of file <a class="el" href="a05846.html">interpret_object.h</a>. +<p> +Referenced by <a class="el" href="a05846.html#l00061">CComponent()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLAISCRIPT_1_1CComponento1" doxytag="NLAISCRIPT::CComponent::ObjectName" ></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="a02661.html">NLAIAGENT::IVarName</a>* <a class="el" href="a02395.html#NLAISCRIPT_1_1CComponento1">NLAISCRIPT::CComponent::ObjectName</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Name of the Component. +<p> + +<p> +Definition at line <a class="el" href="a05846.html#l00049">49</a> of file <a class="el" href="a05846.html">interpret_object.h</a>. +<p> +Referenced by <a class="el" href="a05846.html#l00061">CComponent()</a>, <a class="el" href="a05847.html#l00609">NLAISCRIPT::CAgentClass::createComponents()</a>, <a class="el" href="a05847.html#l00924">NLAISCRIPT::CAgentClass::getComponentName()</a>, <a class="el" href="a05847.html#l00318">NLAISCRIPT::CAgentClass::getStaticMemberIndex()</a>, <a class="el" href="a05845.html#l00038">load()</a>, <a class="el" href="a05847.html#l00264">NLAISCRIPT::CAgentClass::registerComponent()</a>, <a class="el" href="a05845.html#l00030">save()</a>, <a class="el" href="a05847.html#l00974">NLAISCRIPT::CAgentClass::setStaticMember()</a>, <a class="el" href="a05847.html#l01000">NLAISCRIPT::CAgentClass::updateStaticMember()</a>, and <a class="el" href="a05847.html#l00105">NLAISCRIPT::CAgentClass::~CAgentClass()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLAISCRIPT_1_1CComponento2" doxytag="NLAISCRIPT::CComponent::RegisterName" ></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="a02661.html">NLAIAGENT::IVarName</a>* <a class="el" href="a02395.html#NLAISCRIPT_1_1CComponento2">NLAISCRIPT::CComponent::RegisterName</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Component type name. +<p> + +<p> +Definition at line <a class="el" href="a05846.html#l00047">47</a> of file <a class="el" href="a05846.html">interpret_object.h</a>. +<p> +Referenced by <a class="el" href="a05846.html#l00061">CComponent()</a>, <a class="el" href="a05847.html#l00609">NLAISCRIPT::CAgentClass::createComponents()</a>, <a class="el" href="a05847.html#l00369">NLAISCRIPT::CAgentClass::getStaticMember()</a>, <a class="el" href="a05845.html#l00038">load()</a>, <a class="el" href="a05847.html#l00264">NLAISCRIPT::CAgentClass::registerComponent()</a>, <a class="el" href="a05845.html#l00030">save()</a>, <a class="el" href="a05847.html#l00974">NLAISCRIPT::CAgentClass::setStaticMember()</a>, <a class="el" href="a05847.html#l01000">NLAISCRIPT::CAgentClass::updateStaticMember()</a>, and <a class="el" href="a05847.html#l00105">NLAISCRIPT::CAgentClass::~CAgentClass()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLAISCRIPT_1_1CComponento3" doxytag="NLAISCRIPT::CComponent::Static" ></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="a02395.html#NLAISCRIPT_1_1CComponento3">NLAISCRIPT::CComponent::Static</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05846.html#l00060">60</a> of file <a class="el" href="a05846.html">interpret_object.h</a>. +<p> +Referenced by <a class="el" href="a05846.html#l00061">CComponent()</a>, and <a class="el" href="a05847.html#l00609">NLAISCRIPT::CAgentClass::createComponents()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLAISCRIPT_1_1CComponento4" doxytag="NLAISCRIPT::CComponent::StaticValue" ></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="a02149.html">NLAIAGENT::IObjectIA</a>* <a class="el" href="a02395.html#NLAISCRIPT_1_1CComponento4">NLAISCRIPT::CComponent::StaticValue</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Static value if the component is a static one. +<p> + +<p> +Definition at line <a class="el" href="a05846.html#l00051">51</a> of file <a class="el" href="a05846.html">interpret_object.h</a>. +<p> +Referenced by <a class="el" href="a05846.html#l00061">CComponent()</a>, <a class="el" href="a05847.html#l00609">NLAISCRIPT::CAgentClass::createComponents()</a>, <a class="el" href="a05847.html#l01024">NLAISCRIPT::CAgentClass::getStaticComponentValue()</a>, <a class="el" href="a05847.html#l00974">NLAISCRIPT::CAgentClass::setStaticMember()</a>, and <a class="el" href="a05847.html#l01000">NLAISCRIPT::CAgentClass::updateStaticMember()</a>. </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="a05846.html">interpret_object.h</a><li><a class="el" href="a05845.html">interpret_object.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 11:26:52 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> |