nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-eo/doc/html/classeo_parameter_loader.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

185 lines
10 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: eoParameterLoader Class 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>eoParameterLoader Class Reference</h1>Parameter saving and loading.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="eo_parser_8h-source.html">eoParser.h</a>&gt;</code>
<p>
<p>Inheritance diagram for eoParameterLoader:
<p><center><img src="classeo_parameter_loader.png" usemap="#eoParameterLoader_map" border="0" alt=""></center>
<map name="eoParameterLoader_map">
<area href="classeo_parser.html" alt="eoParser" shape="rect" coords="0,56,124,80">
</map>
<a href="classeo_parameter_loader-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="eoParameterLoader::~eoParameterLoader"></a>
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_parameter_loader.html#a0">~eoParameterLoader</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Need a virtual destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_parameter_loader.html#a1">processParam</a> (<a class="el" href="classeo_param.html">eoParam</a> &amp;param, std::string section="")=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register a parameter and set its value if it is known. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="eoParameterLoader::isItThere"></a>
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_parameter_loader.html#a2">isItThere</a> (<a class="el" href="classeo_param.html">eoParam</a> &amp;_param) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">checks if _param has been actually entered <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class ValueType&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="classeo_value_param.html">eoValueParam</a>&lt; ValueType &gt; &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classeo_parameter_loader.html#a3">createParam</a> (ValueType _defaultValue, std::string _longName, std::string _description, char _shortHand=0, std::string _section="", bool _required=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a Param and sets its value. <a href="#a3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r0" doxytag="eoParameterLoader::ownedParams"></a>
std::vector&lt; <a class="el" href="classeo_param.html">eoParam</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>ownedParams</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Parameter saving and loading.
<p>
eoParameterLoader is an abstract class that can be used as a base for your own parameter loading and saving. The command line parser <a class="el" href="classeo_parser.html">eoParser</a> is derived from this class.
<p>
<p>
Definition at line <a class="el" href="eo_parser_8h-source.html#l00040">40</a> of file <a class="el" href="eo_parser_8h-source.html">eoParser.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="eoParameterLoader::processParam"></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 eoParameterLoader::processParam </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classeo_param.html">eoParam</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>param</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>section</em> = <code>""</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</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>
&nbsp;
</td>
<td>
<p>
Register a parameter and set its value if it is known.
<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>param</em>&nbsp;</td><td>the parameter to process </td></tr>
<tr><td valign="top"></td><td valign="top"><em>section</em>&nbsp;</td><td>the section where this parameter belongs </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classeo_parser.html#a1">eoParser</a>. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="eoParameterLoader::createParam"></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;&amp; eoParameterLoader::createParam </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>, </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>std::string&nbsp;</td>
<td class="mdname" nowrap> <em>_section</em> = <code>""</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 and sets its value.
<p>
The loader will own the memory thus created<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>_section</em>&nbsp;</td><td>Name of the section where the parameter belongs </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_parser_8h-source.html#l00070">70</a> of file <a class="el" href="eo_parser_8h-source.html">eoParser.h</a>.
<p>
Referenced by <a class="el" href="eo_parser_8h-source.html#l00173">eoParser::getORcreateParam()</a>, and <a class="el" href="eo_parser_8h-source.html#l00211">eoParser::setORcreateParam()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="eo_parser_8h-source.html">eoParser.h</a><li><a class="el" href="eo_parser_8cpp-source.html">eoParser.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Oct 19 05:06:52 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