diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a03649.html | 529 |
1 files changed, 529 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03649.html b/docs/doxygen/nel/a03649.html new file mode 100644 index 00000000..33abd871 --- /dev/null +++ b/docs/doxygen/nel/a03649.html @@ -0,0 +1,529 @@ +<!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: NLMISC::CVariable< std::string > 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>NLMISC::CVariable< std::string > Class Reference</h1><code>#include <<a class="el" href="a06666.html">variable.h</a>></code> +<p> +<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>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a0">c_str</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a1">CVariable</a> (const char *commandName, const char *commandHelp, const std::string &defaultValue, <a class="el" href="a04558.html#a15">uint</a> nbMeanValue=0, bool useConfigFile=false, void(*cc)(<a class="el" href="a03648.html">IVariable</a> &var)=NULL)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a2">execute</a> (const std::vector< std::string > &args, <a class="el" href="a02813.html">NLMISC::CLog</a> &log, bool quiet, bool human)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a3">fromString</a> (const std::string &val, bool human=false)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>const std::string & </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a4">get</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a5">operator const char *</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a6">operator std::string</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03646.html">CVariable</a>< std::string > & </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a7">operator=</a> (const std::string &val)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a8">set</a> (const std::string &val)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4a9">toString</a> (bool human=false) const </td></tr> + +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a03649.html#NLMISC_1_1CVariable_3_01std_1_1string_01_4r0">_Value</a></td></tr> + +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a0" doxytag="NLMISC::CVariable< std::string >::c_str" ></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"> const char* <a class="el" href="a03646.html">NLMISC::CVariable</a>< std::string >::c_str </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> [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="a06666.html#l00403">403</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +<div class="fragment"><pre>00404 { +00405 <span class="keywordflow">return</span> <a class="code" href="a03646.html#NLMISC_1_1CVariablea3">get</a>().c_str(); +00406 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a1" doxytag="NLMISC::CVariable< std::string >::CVariable" ></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="a03646.html">NLMISC::CVariable</a>< std::string >::<a class="el" href="a03646.html">CVariable</a> </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>commandName</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>commandHelp</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>defaultValue</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>nbMeanValue</em> = 0, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>useConfigFile</em> = false, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>void(* </td> + <td class="mdname" nowrap> <em>cc</em>)(<a class="el" href="a03648.html">IVariable</a> &var) = NULL</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><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="a06666.html#l00371">371</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +References <a class="el" href="a06666.html#l00257">NLMISC::CVariable< T >::set()</a>, <a class="el" href="a05981.html#l00105">uint</a>, and <a class="el" href="a05646.html#l01132">value</a>. +<p> +<div class="fragment"><pre>00371 : +00372 <a class="code" href="a03648.html">IVariable</a> (commandName, commandHelp, <span class="stringliteral">"[<value>]"</span>, useConfigFile, cc) +00373 { +00374 <a class="code" href="a03646.html#NLMISC_1_1CVariablea8">set</a> (defaultValue); +00375 } + +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a2" doxytag="NLMISC::CVariable< std::string >::execute" ></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 <a class="el" href="a03646.html">NLMISC::CVariable</a>< std::string >::execute </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::vector< std::string > & </td> + <td class="mdname" nowrap> <em>args</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02813.html">NLMISC::CLog</a> & </td> + <td class="mdname" nowrap> <em>log</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>quiet</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>human</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</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="a06666.html#l00425">425</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +References <a class="el" href="a05943.html#l00323">NLMISC::CLog::displayNL()</a>, <a class="el" href="a06465.html#l00203">NLMISC::fromString()</a>, and <a class="el" href="a06229.html#l02652">NLMISC::toString()</a>. +<p> +<div class="fragment"><pre>00426 { +00427 <span class="keywordflow">if</span> (args.size () > 1) +00428 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00429 +00430 <span class="keywordflow">if</span> (args.size () == 1) +00431 { +00432 <span class="comment">// set the value</span> +00433 <a class="code" href="a05378.html#a423">fromString</a> (args[0], human); +00434 } +00435 +00436 <span class="comment">// display the value</span> +00437 <span class="keywordflow">if</span> (quiet) +00438 { +00439 log.<a class="code" href="a02813.html#NLNET_1_1CNetLoga7">displayNL</a> (<a class="code" href="a05378.html#a244">toString</a>(human).c_str()); +00440 } +00441 <span class="keywordflow">else</span> +00442 { +00443 log.<a class="code" href="a02813.html#NLNET_1_1CNetLoga7">displayNL</a> (<span class="stringliteral">"Variable %s = %s"</span>, <a class="code" href="a03647.html#NLMISC_1_1IVariablep0">_CommandName</a>.c_str(), <a class="code" href="a05378.html#a244">toString</a>(human).c_str()); +00444 } +00445 <span class="keywordflow">return</span> <span class="keyword">true</span>; +00446 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a3" doxytag="NLMISC::CVariable< std::string >::fromString" ></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 <a class="el" href="a03646.html">NLMISC::CVariable</a>< std::string >::fromString </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>val</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>human</em> = false</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</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="a06666.html#l00377">377</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +References <a class="el" href="a06666.html#l00257">NLMISC::CVariable< T >::set()</a>. +<p> +<div class="fragment"><pre>00378 { +00379 <a class="code" href="a03646.html#NLMISC_1_1CVariablea8">set</a> (val); +00380 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a4" doxytag="NLMISC::CVariable< std::string >::get" ></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"> const std::string& <a class="el" href="a03646.html">NLMISC::CVariable</a>< std::string >::get </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> [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="a06666.html#l00420">420</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +<div class="fragment"><pre>00421 { +00422 <span class="keywordflow">return</span> <a class="code" href="a03646.html#NLMISC_1_1CVariabler4">_Value</a>; +00423 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a5" doxytag="NLMISC::CVariable< std::string >::operator const char *" ></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="a03646.html">NLMISC::CVariable</a>< std::string >::operator const char * </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> [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="a06666.html#l00398">398</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +<div class="fragment"><pre>00399 { +00400 <span class="keywordflow">return</span> <a class="code" href="a03646.html#NLMISC_1_1CVariablea3">get</a>().c_str(); +00401 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a6" doxytag="NLMISC::CVariable< std::string >::operator std::string" ></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="a03646.html">NLMISC::CVariable</a>< std::string >::operator std::string </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> [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="a06666.html#l00393">393</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +References <a class="el" href="a06666.html#l00275">NLMISC::CVariable< T >::get()</a>. +<p> +<div class="fragment"><pre>00394 { +00395 <span class="keywordflow">return</span> <a class="code" href="a03646.html#NLMISC_1_1CVariablea3">get</a>(); +00396 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a7" doxytag="NLMISC::CVariable< std::string >::operator=" ></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="a03646.html">CVariable</a><std::string>& <a class="el" href="a03646.html">NLMISC::CVariable</a>< std::string >::operator= </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>val</em> </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="a06666.html#l00387">387</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +References <a class="el" href="a06666.html#l00257">NLMISC::CVariable< T >::set()</a>. +<p> +<div class="fragment"><pre>00388 { +00389 <a class="code" href="a03646.html#NLMISC_1_1CVariablea8">set</a> (val); +00390 <span class="keywordflow">return</span> *<span class="keyword">this</span>; +00391 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a8" doxytag="NLMISC::CVariable< std::string >::set" ></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 <a class="el" href="a03646.html">NLMISC::CVariable</a>< std::string >::set </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>val</em> </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="a06666.html#l00408">408</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +<div class="fragment"><pre>00409 { +00410 <a class="code" href="a03646.html#NLMISC_1_1CVariabler4">_Value</a> = val; +00411 <span class="keyword">static</span> <span class="keywordtype">bool</span> RecurseSet = <span class="keyword">false</span>; +00412 <span class="keywordflow">if</span> (<a class="code" href="a03648.html#NLMISC_1_1IVariablep1">ChangeCallback</a> && !RecurseSet) +00413 { +00414 RecurseSet = <span class="keyword">true</span>; +00415 <a class="code" href="a03648.html#NLMISC_1_1IVariablep1">ChangeCallback</a>(*<span class="keyword">this</span>); +00416 RecurseSet = <span class="keyword">false</span>; +00417 } +00418 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4a9" doxytag="NLMISC::CVariable< std::string >::toString" ></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 std::string <a class="el" href="a03646.html">NLMISC::CVariable</a>< std::string >::toString </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>human</em> = false </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline, virtual]</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="a06666.html#l00382">382</a> of file <a class="el" href="a06666.html">variable.h</a>. +<p> +<div class="fragment"><pre>00383 { +00384 <span class="keywordflow">return</span> <a class="code" href="a03646.html#NLMISC_1_1CVariabler4">_Value</a>; +00385 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLMISC_1_1CVariable_3_01std_1_1string_01_4r0" doxytag="NLMISC::CVariable< std::string >::_Value" ></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"> std::string <a class="el" href="a03646.html">NLMISC::CVariable</a>< std::string >::_Value<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06666.html#l00450">450</a> of file <a class="el" href="a06666.html">variable.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06666.html">variable.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:40:47 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> |