nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-eo/doc/html/classeo_value_param.html
legrand c3aec878e5 Paradiseo-eo sources added 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
2006-12-12 14:49:08 +00:00

216 lines
12 KiB
HTML
Raw Blame History

<!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>EO: eoValueParam&lt; ValueType &gt; Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.9.1 -->
<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="modules.html">Modules</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">Class&nbsp;List</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">Class&nbsp;Members</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>eoValueParam&lt; ValueType &gt; Class Template Reference</h1>eoValueParam&lt;ValueType&gt;: templatized derivation of <a class="el" href="classeo_param.html">eoParam</a>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="eo_param_8h-source.html">eoParam.h</a>&gt;</code>
<p>
<p>Inheritance diagram for eoValueParam&lt; ValueType &gt;:
<p><center><img src="classeo_value_param.png" usemap="#eoValueParam< ValueType >_map" border="0" alt=""></center>
<map name="eoValueParam< ValueType >_map">
<area href="classeo_param.html" alt="eoParam" shape="rect" coords="0,0,219,24">
<area href="classeo_perf2_worth.html" alt="eoPerf2Worth< EOT, EOT::Fitness >" shape="rect" coords="0,112,219,136">
<area href="classeo_no_perf2_worth.html" alt="eoNoPerf2Worth< EOT >" shape="rect" coords="0,168,219,192">
</map>
<a href="classeo_value_param-members.html">List of all members.</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"><a class="anchor" name="a0" doxytag="eoValueParam::eoValueParam"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_value_param.html#a0">eoValueParam</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a Param. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_value_param.html#a1">eoValueParam</a> (ValueType _defaultValue, std::string _longName, std::string _description="No description", char _shortHand=0, bool _required=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a Param. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ValueType &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_value_param.html#a2">value</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parameter value. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const ValueType &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_value_param.html#a3">value</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parameter value. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="eoValueParam::getValue"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_value_param.html#a4">getValue</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pure virtual function to get the value out. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="eoValueParam::setValue"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_value_param.html#a5">setValue</a> (const std::string &amp;_value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pure virtual function to set the value. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p0" doxytag="eoValueParam::repValue"></a>
ValueType&nbsp;</td><td class="memItemRight" valign="bottom"><b>repValue</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ValueType&gt;<br>
class eoValueParam&lt; ValueType &gt;</h3>
eoValueParam&lt;ValueType&gt;: templatized derivation of <a class="el" href="classeo_param.html">eoParam</a>.
<p>
Can be used to contain any scalar value type. It makes use of std::strstream to get and set values. This should be changed to std::stringstream when that class is available in g++.<p>
Note also that there is a template specialization for std::pair&lt;double, double&gt; and for std::vector&lt;double&gt;. These stream their contents delimited with whitespace.
<p>
<p>
Definition at line <a class="el" href="eo_param_8h-source.html#l00136">136</a> of file <a class="el" href="eo_param_8h-source.html">eoParam.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a1" doxytag="eoValueParam::eoValueParam"></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" colspan="4">
template&lt;class ValueType&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classeo_value_param.html">eoValueParam</a>&lt; ValueType &gt;::<a class="el" href="classeo_value_param.html">eoValueParam</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">ValueType&nbsp;</td>
<td class="mdname" nowrap> <em>_defaultValue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>std::string&nbsp;</td>
<td class="mdname" nowrap> <em>_longName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>std::string&nbsp;</td>
<td class="mdname" nowrap> <em>_description</em> = <code>"No&nbsp;description"</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char&nbsp;</td>
<td class="mdname" nowrap> <em>_shortHand</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>_required</em> = <code>false</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a Param.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_defaultValue</em>&nbsp;</td><td>The default value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_longName</em>&nbsp;</td><td>Long name of the argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_description</em>&nbsp;</td><td>Description of the parameter. What is useful for. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_shortName</em>&nbsp;</td><td>Short name of the argument (Optional) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_required</em>&nbsp;</td><td>If it is a necessary parameter or not </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="eo_param_8h-source.html#l00151">151</a> of file <a class="el" href="eo_param_8h-source.html">eoParam.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="eoValueParam::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" colspan="4">
template&lt;class ValueType&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">ValueType&amp; <a class="el" href="classeo_value_param.html">eoValueParam</a>&lt; ValueType &gt;::value </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Parameter value.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>parameter value </dd></dl>
<p>
Definition at line <a class="el" href="eo_param_8h-source.html#l00166">166</a> of file <a class="el" href="eo_param_8h-source.html">eoParam.h</a>.
<p>
Referenced by <a class="el" href="eo_perf2_worth_8h-source.html#l00237">eoNoPerf2Worth&lt; EOT &gt;::operator()()</a>, <a class="el" href="eo_file_snapshot_8h-source.html#l00133">eoFileSnapshot::operator()()</a>, <a class="el" href="eo_f_d_c_stat_8h-source.html#l00059">eoFDCStat&lt; EOT &gt;::operator()()</a>, and <a class="el" href="eo_parser_8h-source.html#l00234">eoParser::setStopOnUnknownParam()</a>. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="eoValueParam::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" colspan="4">
template&lt;class ValueType&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">const ValueType&amp; <a class="el" href="classeo_value_param.html">eoValueParam</a>&lt; ValueType &gt;::value </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Parameter value.
<p>
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.<p>
<dl compact><dt><b>Returns:</b></dt><dd>parameter value </dd></dl>
<p>
Definition at line <a class="el" href="eo_param_8h-source.html#l00175">175</a> of file <a class="el" href="eo_param_8h-source.html">eoParam.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="eo_param_8h-source.html">eoParam.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Oct 19 05:06:58 2006 for EO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink