diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/class_NLAINIMAT__IBlackBox.html | 448 |
1 files changed, 448 insertions, 0 deletions
diff --git a/docs/doxygen/nel/class_NLAINIMAT__IBlackBox.html b/docs/doxygen/nel/class_NLAINIMAT__IBlackBox.html new file mode 100644 index 00000000..342a3556 --- /dev/null +++ b/docs/doxygen/nel/class_NLAINIMAT__IBlackBox.html @@ -0,0 +1,448 @@ +<!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.2 on Sat May 19 22:27:39 2001 --> +<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>NLAINIMAT::IBlackBox Class Reference</h1>An interface between an agent and a C++ component. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="black_box_h-source.html">black_box.h</a>></code> +<p> +Inheritance diagram for NLAINIMAT::IBlackBox<p><center><img src="class_NLAINIMAT__IBlackBox_inherit_graph.gif" border="0" usemap="#NLAINIMAT::IBlackBox_inherit_map" alt="Inheritance graph"></center> +<map name="NLAINIMAT::IBlackBox_inherit_map"> +<area href="class_NLAINIMAT__IObjectIA.html" shape="rect" coords="1,1,151,19"> +</map> +<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for NLAINIMAT::IBlackBox:<p><center><img src="class_NLAINIMAT__IBlackBox_coll_graph.gif" border="0" usemap="#NLAINIMAT::IBlackBox_coll_map" alt="Collaboration graph"></center> +<map name="NLAINIMAT::IBlackBox_coll_map"> +<area href="class_NLAINIMAT__IObjectIA.html" shape="rect" coords="1,1,151,19"> +</map> +<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_NLAINIMAT__IBlackBox-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="class_NLAINIMAT__IBlackBox.html#a0">IBlackBox</a> ()</td></tr> +<tr><td colspan="2"><div class="groupHeader">Description functions</div></td></tr> +<tr><td colspan="2"><div class="groupText">Give the interface (Inputs, Outputs, ParamaeterIn and ParameterOut) of the IBlackBox.<br><br></div></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespace_NLAINIMAT.html#a1">tCommandList</a> </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a1">getInputList</a> () const = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the list of Inputs for command signal.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespace_NLAINIMAT.html#a1">tCommandList</a> </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a2">getOutputList</a> () const = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the list of Outputs for command signal.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespace_NLAINIMAT.html#a2">tParameterList</a> </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a3">getParamInList</a> () const = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the list of parameters used by the <a class="el" href="class_NLAINIMAT__IBlackBox.html">IBlackBox</a>.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespace_NLAINIMAT.html#a2">tParameterList</a> </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a4">getParamOutList</a> () const = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the list of parameters returned by the <a class="el" href="class_NLAINIMAT__IBlackBox.html">IBlackBox</a>.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Running functions</div></td></tr> +<tr><td colspan="2"><div class="groupText">Functions used during the run time of the IBlackBox.<br><br></div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a5">setInput</a> (<a class="el" href="namespace_NLAINIMAT.html#a0">tString</a> inputName, bool) = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Fix the value of an input signal.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a6">getOutput</a> (<a class="el" href="namespace_NLAINIMAT.html#a0">tString</a> outputName) = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the value of an output signal.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a7">setParamIn</a> (<a class="el" href="namespace_NLAINIMAT.html#a0">tString</a> parameterName, <a class="el" href="class_NLAINIMAT__IObjectIA.html">IObjectIA</a> val) = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the value of an input parameter.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const <a class="el" href="class_NLAINIMAT__IObjectIA.html">IObjectIA</a>* </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a8">getParamOut</a> (<a class="el" href="namespace_NLAINIMAT.html#a0">tString</a> parameterName) = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the value of an output parameter.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespace_NLAINIMAT.html#a2">tParameterList</a> </td><td valign=bottom><a class="el" href="class_NLAINIMAT__IBlackBox.html#a9">getNeededParamIn</a> () const = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Return a list of the parameters which need to be updated.</em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +An interface between an agent and a C++ component. +<p> +An <a class="el" href="class_NLAINIMAT__IBlackBox.html">IBlackBox</a> is an interface for any component which can be use in the built of an agent. It's like an electronique component which can be plug in an agent. There can be input and output parameter and input and output command signal. <dl compact><dt> +<b>Author(s): </b><dd> + Robert Gabriel , Nevrax France </dl><dl compact><dt> +<b>Date: </b><dd> + 2000 </dl> +<p> + +<p> +Definition at line <a class="el" href="black_box_h-source.html#l00042">42</a> of file <a class="el" href="black_box_h-source.html">black_box.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLAINIMAT::IBlackBox::IBlackBox"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +NLAINIMAT::IBlackBox::IBlackBox ( + </b></td> + <td valign="bottom"><b> +) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="NLAINIMAT::IBlackBox::getInputList"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="namespace_NLAINIMAT.html#a1">tCommandList</a> NLAINIMAT::IBlackBox::getInputList ( + </b></td> + <td valign="bottom"><b> +) const<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the list of Inputs for command signal. +<p> +It's a list of the differents pins which can be triggered when receiving an incoming event. </td> + </tr> +</table> +<a name="a9" doxytag="NLAINIMAT::IBlackBox::getNeededParamIn"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="namespace_NLAINIMAT.html#a2">tParameterList</a> NLAINIMAT::IBlackBox::getNeededParamIn ( + </b></td> + <td valign="bottom"><b> +) const<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a list of the parameters which need to be updated. +<p> + </td> + </tr> +</table> +<a name="a6" doxytag="NLAINIMAT::IBlackBox::getOutput"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +bool NLAINIMAT::IBlackBox::getOutput ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="namespace_NLAINIMAT.html#a0">tString</a> <em>outputName</em> )<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the value of an output signal. +<p> + </td> + </tr> +</table> +<a name="a2" doxytag="NLAINIMAT::IBlackBox::getOutputList"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="namespace_NLAINIMAT.html#a1">tCommandList</a> NLAINIMAT::IBlackBox::getOutputList ( + </b></td> + <td valign="bottom"><b> +) const<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the list of Outputs for command signal. +<p> +It's a list of the differents pins which allows to send an event, to triggered anoter <a class="el" href="class_NLAINIMAT__IBlackBox.html">IBlackBox</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLAINIMAT::IBlackBox::getParamInList"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="namespace_NLAINIMAT.html#a2">tParameterList</a> NLAINIMAT::IBlackBox::getParamInList ( + </b></td> + <td valign="bottom"><b> +) const<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the list of parameters used by the <a class="el" href="class_NLAINIMAT__IBlackBox.html">IBlackBox</a>. +<p> +It's the name and type of each parameters. </td> + </tr> +</table> +<a name="a8" doxytag="NLAINIMAT::IBlackBox::getParamOut"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const <a class="el" href="class_NLAINIMAT__IObjectIA.html">IObjectIA</a> * NLAINIMAT::IBlackBox::getParamOut ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="namespace_NLAINIMAT.html#a0">tString</a> <em>parameterName</em> )<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the value of an output parameter. +<p> + </td> + </tr> +</table> +<a name="a4" doxytag="NLAINIMAT::IBlackBox::getParamOutList"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="namespace_NLAINIMAT.html#a2">tParameterList</a> NLAINIMAT::IBlackBox::getParamOutList ( + </b></td> + <td valign="bottom"><b> +) const<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the list of parameters returned by the <a class="el" href="class_NLAINIMAT__IBlackBox.html">IBlackBox</a>. +<p> +It's the name and type of each parameters. </td> + </tr> +</table> +<a name="a5" doxytag="NLAINIMAT::IBlackBox::setInput"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void NLAINIMAT::IBlackBox::setInput ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="namespace_NLAINIMAT.html#a0">tString</a> <em>inputName</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +bool )<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Fix the value of an input signal. +<p> + </td> + </tr> +</table> +<a name="a7" doxytag="NLAINIMAT::IBlackBox::setParamIn"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void NLAINIMAT::IBlackBox::setParamIn ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="namespace_NLAINIMAT.html#a0">tString</a> <em>parameterName</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_NLAINIMAT__IObjectIA.html">IObjectIA</a> <em>val</em> )<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the value of an input parameter. +<p> + </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="black_box_h-source.html">black_box.h</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> |