aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/command_8h.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/command_8h.html283
1 files changed, 283 insertions, 0 deletions
diff --git a/docs/doxygen/nel/command_8h.html b/docs/doxygen/nel/command_8h.html
new file mode 100644
index 00000000..f85606a0
--- /dev/null
+++ b/docs/doxygen/nel/command_8h.html
@@ -0,0 +1,283 @@
+<!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>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</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>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</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>
+&nbsp;
+
+<!-- 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>&nbsp;</td>
+</tr></table>
+<!-- Generated by Doxygen 1.2.14 -->
+<center>
+<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <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> &nbsp; </center>
+<hr><h1>command.h File Reference</h1>Management of runtime command line processing.
+<a href="#_details">More...</a>
+<p>
+<code>#include "<a class="el" href="types__nl_8h-source.html">nel/misc/types_nl.h</a>"</code><br>
+<code>#include &lt;string&gt;</code><br>
+<code>#include &lt;map&gt;</code><br>
+<code>#include &lt;vector&gt;</code><br>
+<code>#include &lt;sstream&gt;</code><br>
+<code>#include &lt;istream&gt;</code><br>
+<code>#include "<a class="el" href="stream_8h-source.html">nel/misc/stream.h</a>"</code><br>
+<code>#include "<a class="el" href="log_8h-source.html">nel/misc/log.h</a>"</code><br>
+
+<p>
+<a href="command_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
+<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceNLMISC.html">NLMISC</a></td></tr>
+<tr><td colspan=2><br><h2>Defines</h2></td></tr>
+<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="command_8h.html#a0">NLMISC_COMMAND</a>(__name, __help, __args)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Create a function that can be call in realtime.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="command_8h.html#a1">NLMISC_VARIABLE</a>(__type, __var, __help)&nbsp;&nbsp;&nbsp;<a class="el" href="classNLMISC_1_1CVariable.html">NLMISC::CVariable</a>&lt;__type&gt; __var##Instance(#__var, __help " (" #__type ")", &amp;__var)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Add a variable that can be modify in realtime.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="command_8h.html#a2">NLMISC_DYNVARIABLE</a>(__type, __name, __help)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Add a variable that can be modify in realtime.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Management of runtime command line processing.
+<p>
+ <dl compact><dt><b>
+Id: </b><dd>
+ command.h,v 1.17 2002/11/29 10:07:54 lecroart Exp </dl>
+<p>
+
+<p>
+Definition in file <a class="el" href="command_8h-source.html">command.h</a>.<hr><h2>Define Documentation</h2>
+<a name="a0" doxytag="command.h::NLMISC_COMMAND"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> #define NLMISC_COMMAND</td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">__name, <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>__help, <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>__args&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+<b>Value:</b><div class="fragment"><pre><font class="keyword">struct </font>__name##Class: <font class="keyword">public</font> NLMISC::ICommand \
+{ \
+ __name##Class() : NLMISC::ICommand(#__name,__help,__args) { } \
+ <font class="keyword">virtual</font> <font class="keywordtype">bool</font> execute(<font class="keyword">const</font> std::vector&lt;std::string&gt; &amp;args, <a class="code" href="classNLMISC_1_1CLog.html">NLMISC::CLog</a> &amp;log); \
+}; \
+__name##Class __name##Instance; \
+<font class="keywordtype">bool</font> __name##Class::execute(<font class="keyword">const</font> std::vector&lt;std::string&gt; &amp;args, <a class="code" href="classNLMISC_1_1CLog.html">NLMISC::CLog</a> &amp;log)</pre></div>Create a function that can be call in realtime.
+<p>
+Example: <div class="fragment"><pre> <font class="comment">// I want to create a function that compute the square of the parameter and display the result</font>
+ <a class="code" href="command_8h.html#a0">NLMISC_COMMAND</a>(square,<font class="stringliteral">"display the square of the parameter"</font>,<font class="stringliteral">"&lt;value&gt;"</font>)
+ {
+ <font class="comment">// check args, if there s not the right number of parameter, return bad</font>
+ <font class="keywordflow">if</font>(args.size() != 1) <font class="keywordflow">return</font> <font class="keyword">false</font>;
+ <font class="comment">// get the value</font>
+ uint32 val = atoi(args[0].c_str());
+ <font class="comment">// display the result on the displayer</font>
+ log.displayNL(<font class="stringliteral">"The square of %d is %d"</font>, val, val*val);
+ <font class="keywordflow">return</font> <font class="keyword">true</font>;
+ }
+</pre></div>
+<p>
+Please use the same casing than for the function (first letter in lower case and after each word first letter in upper case) ie: myFunction, step, orderByName, lookAtThis
+<p>
+<dl compact><dt><b>
+Author: </b><dd>
+Vianney Lecroart , Nevrax France </dl><dl compact><dt><b>
+Date: </b><dd>
+2001 </dl>
+<p>
+Definition at line <a class="el" href="command_8h-source.html#l00071">71</a> of file <a class="el" href="command_8h-source.html">command.h</a>. </td>
+ </tr>
+</table>
+<a name="a2" doxytag="command.h::NLMISC_DYNVARIABLE"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> #define NLMISC_DYNVARIABLE</td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">__type, <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>__name, <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>__help&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Add a variable that can be modify in realtime.
+<p>
+The code profide the way to access to the variable in the read and write access (depending of the <code>get</code> boolean value)
+<p>
+Example: <div class="fragment"><pre> <font class="comment">// a function to read the variable</font>
+ uint8 getVar() { <font class="keywordflow">return</font> ...; }
+
+ <font class="comment">// a function to write the variable</font>
+ <font class="keywordtype">void</font> setVar(uint8 val) { ...=val; }
+
+ <font class="comment">// I want to look and change the variable in realtime:</font>
+ <a class="code" href="command_8h.html#a2">NLMISC_DYNVARIABLE</a>(uint8, FooBar, <font class="stringliteral">"this is a dummy variable"</font>)
+ {
+ <font class="comment">// read or write the variable</font>
+ <font class="keywordflow">if</font> (get)
+ *<a class="code" href="driver__opengl__extension__def_8h.html#a362">pointer</a> = getVar();
+ <font class="keywordflow">else</font>
+ setVar(*<a class="code" href="driver__opengl__extension__def_8h.html#a362">pointer</a>);
+ }
+</pre></div>
+<p>
+Please use the same casing than for the variable (first letter of each word in upper case) ie: MyVariable, NetSpeedLoop, Time
+<p>
+<dl compact><dt><b>
+Author: </b><dd>
+Vianney Lecroart , Nevrax France </dl><dl compact><dt><b>
+Date: </b><dd>
+2001 </dl>
+<p>
+Definition at line <a class="el" href="command_8h-source.html#l00136">136</a> of file <a class="el" href="command_8h-source.html">command.h</a>. </td>
+ </tr>
+</table>
+<a name="a1" doxytag="command.h::NLMISC_VARIABLE"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> #define NLMISC_VARIABLE</td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">__type, <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>__var, <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>__help&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="classNLMISC_1_1CVariable.html">NLMISC::CVariable</a>&lt;__type&gt; __var##Instance(#__var, __help " (" #__type ")", &amp;__var)
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Add a variable that can be modify in realtime.
+<p>
+The variable must be global. If you must acces the variable with function, use NLMISC_DYNVARIABLE
+<p>
+Example: <div class="fragment"><pre> <font class="comment">// I want to look and change the variable 'foobar' in realtime, so, first i create it:</font>
+ uint8 foobar;
+ <font class="comment">// and then, I add it</font>
+ <a class="code" href="command_8h.html#a1">NLMISC_VARIABLE</a>(uint8, FooBar, <font class="stringliteral">"this is a dummy variable"</font>);
+</pre></div>
+<p>
+Please use the same casing than for the variable (first letter of each word in upper case) ie: MyVariable, NetSpeedLoop, Time
+<p>
+<dl compact><dt><b>
+Author: </b><dd>
+Vianney Lecroart , Nevrax France </dl><dl compact><dt><b>
+Date: </b><dd>
+2001 </dl>
+<p>
+Definition at line <a class="el" href="command_8h-source.html#l00101">101</a> of file <a class="el" href="command_8h-source.html">command.h</a>. </td>
+ </tr>
+</table>
+
+
+<!-- footer -->
+<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>