diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/a03843.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to 'docs/doxygen/nel/a03843.html')
| -rw-r--r-- | docs/doxygen/nel/a03843.html | 370 |
1 files changed, 370 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03843.html b/docs/doxygen/nel/a03843.html new file mode 100644 index 00000000..160f26a0 --- /dev/null +++ b/docs/doxygen/nel/a03843.html @@ -0,0 +1,370 @@ +<!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: NLAINIMAT::IBlackBox 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>NLAINIMAT::IBlackBox Class Reference</h1><code>#include <<a class="el" href="a05488.html">black_box.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +An interface between an agent and a C++ component. An <a class="el" href="a03843.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:</b></dt><dd>Robert Gabriel <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="a05488.html#l00042">42</a> of file <a class="el" href="a05488.html">black_box.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="a03843.html#NLAINIMAT_1_1IBlackBoxa0">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 class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a05371.html#a2">TCommandList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1786_0">getInputList</a> () const=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a05371.html#a2">TCommandList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1786_1">getOutputList</a> () const=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a05371.html#a3">TParameterList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1786_2">getParamInList</a> () const=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a05371.html#a3">TParameterList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1786_3">getParamOutList</a> () const=0</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 class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a05371.html#a3">TParameterList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1788_0">getNeededParamIn</a> () const=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1788_1">getOutput</a> (<a class="el" href="a05371.html#a1">TString</a> outputName)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of an output signal. <a href="#NLAINIMAT_1_1IBlackBoxz1788_1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const IObjectIA * </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1788_2">getParamOut</a> (<a class="el" href="a05371.html#a1">TString</a> parameterName)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of an output parameter. <a href="#NLAINIMAT_1_1IBlackBoxz1788_2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1788_3">setInput</a> (<a class="el" href="a05371.html#a1">TString</a> inputName, bool)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Fix the value of an input signal. <a href="#NLAINIMAT_1_1IBlackBoxz1788_3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03843.html#NLAINIMAT_1_1IBlackBoxz1788_4">setParamIn</a> (<a class="el" href="a05371.html#a1">TString</a> parameterName, IObjectIA val)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of an input parameter. <a href="#NLAINIMAT_1_1IBlackBoxz1788_4"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLAINIMAT_1_1IBlackBoxa0" doxytag="NLAINIMAT::IBlackBox::IBlackBox" ></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"> NLAINIMAT::IBlackBox::IBlackBox </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> + </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLAINIMAT_1_1IBlackBoxz1786_0" doxytag="NLAINIMAT::IBlackBox::getInputList" ></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"> virtual <a class="el" href="a05371.html#a2">TCommandList</a> NLAINIMAT::IBlackBox::getInputList </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></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. It's a list of the differents pins which can be triggered when receiving an incoming event. </td> + </tr> +</table> +<a class="anchor" name="NLAINIMAT_1_1IBlackBoxz1788_0" doxytag="NLAINIMAT::IBlackBox::getNeededParamIn" ></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"> virtual <a class="el" href="a05371.html#a3">TParameterList</a> NLAINIMAT::IBlackBox::getNeededParamIn </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></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. </td> + </tr> +</table> +<a class="anchor" name="NLAINIMAT_1_1IBlackBoxz1788_1" doxytag="NLAINIMAT::IBlackBox::getOutput" ></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"> virtual bool NLAINIMAT::IBlackBox::getOutput </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05371.html#a1">TString</a> </td> + <td class="mdname1" valign="top" nowrap> <em>outputName</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></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 class="anchor" name="NLAINIMAT_1_1IBlackBoxz1786_1" doxytag="NLAINIMAT::IBlackBox::getOutputList" ></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"> virtual <a class="el" href="a05371.html#a2">TCommandList</a> NLAINIMAT::IBlackBox::getOutputList </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></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. It's a list of the differents pins which allows to send an event, to triggered anoter <a class="el" href="a03843.html">IBlackBox</a>. </td> + </tr> +</table> +<a class="anchor" name="NLAINIMAT_1_1IBlackBoxz1786_2" doxytag="NLAINIMAT::IBlackBox::getParamInList" ></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"> virtual <a class="el" href="a05371.html#a3">TParameterList</a> NLAINIMAT::IBlackBox::getParamInList </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></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="a03843.html">IBlackBox</a>. It's the name and type of each parameters. </td> + </tr> +</table> +<a class="anchor" name="NLAINIMAT_1_1IBlackBoxz1788_2" doxytag="NLAINIMAT::IBlackBox::getParamOut" ></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"> virtual const IObjectIA* NLAINIMAT::IBlackBox::getParamOut </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05371.html#a1">TString</a> </td> + <td class="mdname1" valign="top" nowrap> <em>parameterName</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></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 class="anchor" name="NLAINIMAT_1_1IBlackBoxz1786_3" doxytag="NLAINIMAT::IBlackBox::getParamOutList" ></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"> virtual <a class="el" href="a05371.html#a3">TParameterList</a> NLAINIMAT::IBlackBox::getParamOutList </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></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="a03843.html">IBlackBox</a>. It's the name and type of each parameters. </td> + </tr> +</table> +<a class="anchor" name="NLAINIMAT_1_1IBlackBoxz1788_3" doxytag="NLAINIMAT::IBlackBox::setInput" ></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"> virtual void NLAINIMAT::IBlackBox::setInput </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05371.html#a1">TString</a> </td> + <td class="mdname" nowrap> <em>inputName</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></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 class="anchor" name="NLAINIMAT_1_1IBlackBoxz1788_4" doxytag="NLAINIMAT::IBlackBox::setParamIn" ></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"> virtual void NLAINIMAT::IBlackBox::setParamIn </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05371.html#a1">TString</a> </td> + <td class="mdname" nowrap> <em>parameterName</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>IObjectIA </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></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="a05488.html">black_box.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 11:10: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> |