nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Paradiseo-eo sources added

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
legrand 2006-12-12 14:49:08 +00:00
commit c3aec878e5
3609 changed files with 342772 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

179
trunk/paradiseo-eo/doc/html/classeo_param.html Normal file
View file

@ -0,0 +1,179 @@
<!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: eoParam 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>eoParam Class Reference</h1>eoParam: Base class for monitoring and parsing parameters
<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 eoParam:
<p><center><img src="classeo_param.png" usemap="#eoParam_map" border="0" alt=""></center>
<map name="eoParam_map">
<area href="classeo_value_param.html" alt="eoValueParam< ValueType >" shape="rect" coords="282,56,554,80">
<area href="classeo_value_param.html" alt="eoValueParam< double >" shape="rect" coords="282,112,554,136">
<area href="classeo_value_param.html" alt="eoValueParam< EOT::Fitness >" shape="rect" coords="282,168,554,192">
<area href="classeo_value_param.html" alt="eoValueParam< ParamType >" shape="rect" coords="282,224,554,248">
<area href="classeo_value_param.html" alt="eoValueParam< std::pair< double, double > >" shape="rect" coords="282,280,554,304">
<area href="classeo_value_param.html" alt="eoValueParam< std::string >" shape="rect" coords="282,336,554,360">
<area href="classeo_value_param.html" alt="eoValueParam< std::vector< double > >" shape="rect" coords="282,392,554,416">
<area href="classeo_value_param.html" alt="eoValueParam< std::vector< FitT > >" shape="rect" coords="282,448,554,472">
<area href="classeo_value_param.html" alt="eoValueParam< std::vector< PartFitT > >" shape="rect" coords="282,504,554,528">
<area href="classeo_value_param.html" alt="eoValueParam< std::vector< WorthT > >" shape="rect" coords="282,560,554,584">
<area href="classeo_value_param.html" alt="eoValueParam< string >" shape="rect" coords="282,616,554,640">
<area href="classeo_value_param.html" alt="eoValueParam< T >" shape="rect" coords="282,672,554,696">
<area href="classeo_value_param.html" alt="eoValueParam< unsigned >" shape="rect" coords="282,728,554,752">
<area href="classeo_value_param.html" alt="eoValueParam< unsigned long >" shape="rect" coords="282,784,554,808">
</map>
<a href="classeo_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="eoParam::eoParam"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a0">eoParam</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Empty constructor - called from outside any parser. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a1">eoParam</a> (std::string _longName, std::string _default, std::string _description, char _shortName=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"><a class="anchor" name="a2" doxytag="eoParam::~eoParam"></a>
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a2">~eoParam</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor is needed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="eoParam::getValue"></a>
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a3">getValue</a> () const =0</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="a4" doxytag="eoParam::setValue"></a>
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a4">setValue</a> (const std::string &amp;_value)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pure virtual function to set the value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="eoParam::shortName"></a>
char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a5">shortName</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the short name. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="eoParam::longName"></a>
const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a6">longName</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the long name. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="eoParam::description"></a>
const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a7">description</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the description of the argument. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="eoParam::defValue"></a>
const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a8">defValue</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the default value of the argument. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="eoParam::defValue"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a9">defValue</a> (const std::string &amp;str)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the default value of the argument,. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="eoParam::setLongName"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a10">setLongName</a> (std::string _longName)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ALlows to change the name (see the prefix in <a class="el" href="eo_parser_8h.html">eoParser.h</a>). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="eoParam::required"></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_param.html#a11">required</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns if required or not. <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="eoParam::repLongName"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>repLongName</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r1" doxytag="eoParam::repDefault"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>repDefault</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r2" doxytag="eoParam::repDescription"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>repDescription</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r3" doxytag="eoParam::repShortHand"></a>
char&nbsp;</td><td class="memItemRight" valign="bottom"><b>repShortHand</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r4" doxytag="eoParam::repRequired"></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>repRequired</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
eoParam: Base class for monitoring and parsing parameters
<p>
<p>
Definition at line <a class="el" href="eo_param_8h-source.html#l00042">42</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="eoParam::eoParam"></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">eoParam::eoParam </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">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>_default</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>_shortName</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>_longName</em>&nbsp;</td><td>Long name of the argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_default</em>&nbsp;</td><td>The default value </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#l00060">60</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: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>