aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a05243.html
diff options
context:
space:
mode:
authorneodarz <neodarz@neodarz.net>2018-08-11 20:21:34 +0200
committerneodarz <neodarz@neodarz.net>2018-08-11 20:21:34 +0200
commit0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch)
tree2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/a05243.html
downloadnevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz
nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip
Initial commit
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a05243.html167
1 files changed, 167 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a05243.html b/docs/doxygen/nel/a05243.html
new file mode 100644
index 00000000..fea02083
--- /dev/null
+++ b/docs/doxygen/nel/a05243.html
@@ -0,0 +1,167 @@
+<!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: variable.h File 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>variable.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Management of runtime variable<p>
+<dl compact><dt><b>Id</b></dt><dd><a class="el" href="a05243.html">variable.h</a>,v 1.8 2004/01/15 17:29:44 lecroart Exp </dd></dl>
+
+<p>
+Definition in file <a class="el" href="a06666.html">variable.h</a>.
+<p>
+<code>#include "<a class="el" href="a06590.html">nel/misc/types_nl.h</a>"</code><br>
+<code>#include "<a class="el" href="a05585.html">nel/misc/command.h</a>"</code><br>
+<code>#include "<a class="el" href="a06657.html">nel/misc/value_smoother.h</a>"</code><br>
+
+<p>
+<a href="a06666.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>namespace &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a05378.html">NLMISC</a></td></tr>
+
+<tr><td colspan=2><br><h2>Defines</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a05243.html#a1">NLMISC_DYNVARIABLE</a>(__type, __name, __help)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a05243.html#a0">NLMISC_VARIABLE</a>(__type, __var, __help)&nbsp;&nbsp;&nbsp;<a class="el" href="a03650.html">NLMISC::CVariablePtr</a>&lt;__type&gt; __var##Instance(#__var, __help " (" #__type ")", &amp;__var)</td></tr>
+
+</table>
+<hr><h2>Define Documentation</h2>
+<a class="anchor" name="a1" doxytag="variable.h::NLMISC_DYNVARIABLE" ></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"> #define NLMISC_DYNVARIABLE</td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">__type, <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>__name, <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>__help&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&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><span class="keyword">class </span>__name##Class : <span class="keyword">public</span> NLMISC::IVariable \
+{ \
+<span class="keyword">public</span>: \
+ <a class="code" href="a06968.html">__name</a>##Class () : IVariable(#<a class="code" href="a06968.html">__name</a>, __help) { } \
+ \
+ <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a05378.html#a423">fromString</a>(<span class="keyword">const</span> std::string &amp;val, <span class="keywordtype">bool</span> human=<span class="keyword">false</span>) \
+ { \
+ <span class="comment">/*std::stringstream ss (val);*/</span> \
+ __type p; \
+ <span class="comment">/*ss &gt;&gt; p;*/</span> \
+ <a class="code" href="a05378.html#a423">NLMISC::fromString</a>(val, p) ; \
+ ptr (&amp;p, <span class="keyword">false</span>, human); \
+ } \
+ \
+ <span class="keyword">virtual</span> std::string <a class="code" href="a05378.html#a244">toString</a>(<span class="keywordtype">bool</span> human) <span class="keyword">const</span> \
+ { \
+ __type p; \
+ ptr (&amp;p, <span class="keyword">true</span>, human); \
+ <span class="comment">/*std::stringstream ss;*/</span> \
+ <span class="comment">/*ss &lt;&lt; p;*/</span> \
+ <span class="comment">/*return ss.str();*/</span> \
+ <span class="keywordflow">return</span> <a class="code" href="a05378.html#a244">NLMISC::toString</a>(p); \
+ } \
+ \
+ <span class="keywordtype">void</span> ptr(__type *<a class="code" href="a04223.html#a570">pointer</a>, <span class="keywordtype">bool</span> get, <span class="keywordtype">bool</span> human) <span class="keyword">const</span>; \
+}; \
+<a class="code" href="a06968.html">__name</a>##Class <a class="code" href="a06968.html">__name</a>##Instance; \
+<span class="keywordtype">void</span> <a class="code" href="a06968.html">__name</a>##Class::ptr(__type *<a class="code" href="a04223.html#a570">pointer</a>, <span class="keywordtype">bool</span> get, <span class="keywordtype">bool</span> human) <span class="keyword">const</span>
+</pre></div>Add a variable that can be modify in realtime. 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: <pre class="fragment"><div> <span class="comment">// a function to read the variable</span>
+ <a class="code" href="a04558.html#a7">uint8</a> getVar() { <span class="keywordflow">return</span> ...; }
+
+ <span class="comment">// a function to write the variable</span>
+ <span class="keywordtype">void</span> setVar(<a class="code" href="a04558.html#a7">uint8</a> val) { ...=val; }
+
+ <span class="comment">// I want to look and change the variable in realtime:</span>
+ <a class="code" href="a05243.html#a1">NLMISC_DYNVARIABLE</a>(<a class="code" href="a04558.html#a7">uint8</a>, FooBar, <span class="stringliteral">"this is a dummy variable"</span>)
+ {
+ <span class="comment">// read or write the variable</span>
+ <span class="keywordflow">if</span> (get)
+ *<a class="code" href="a04223.html#a570">pointer</a> = getVar();
+ <span class="keywordflow">else</span>
+ setVar(*<a class="code" href="a04223.html#a570">pointer</a>);
+ }
+</div></pre><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></dt><dd>Vianney Lecroart <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+Definition at line <a class="el" href="a06666.html#l00099">99</a> of file <a class="el" href="a06666.html">variable.h</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="a0" doxytag="variable.h::NLMISC_VARIABLE" ></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"> #define NLMISC_VARIABLE</td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">__type, <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>__var, <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>__help&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="a03650.html">NLMISC::CVariablePtr</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. The variable must be global. If you must acces the variable with function, use NLMISC_DYNVARIABLE<p>
+Example: <pre class="fragment"><div> <span class="comment">// I want to look and change the variable 'foobar' in realtime, so, first i create it:</span>
+ <a class="code" href="a04558.html#a7">uint8</a> foobar;
+ <span class="comment">// and then, I add it</span>
+ <a class="code" href="a05243.html#a0">NLMISC_VARIABLE</a>(<a class="code" href="a04558.html#a7">uint8</a>, FooBar, <span class="stringliteral">"this is a dummy variable"</span>);
+</div></pre><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></dt><dd>Vianney Lecroart <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+Definition at line <a class="el" href="a06666.html#l00064">64</a> of file <a class="el" href="a06666.html">variable.h</a>. </td>
+ </tr>
+</table>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 06:43:29 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>