<!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>TCLAP::ValuesConstraint Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div> <div align="right"> <a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a> </div> <!-- Generated by Doxygen 1.7.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <div class="left"> <form id="FSearchBox" action="search.php" method="get"> <img id="MSearchSelect" src="search/mag.png" alt=""/> <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)"/> </form> </div><div class="right"></div> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_t_c_l_a_p.html">TCLAP</a> </li> <li class="navelem"><a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html">ValuesConstraint</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">TCLAP::ValuesConstraint Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="TCLAP::ValuesConstraint" --><!-- doxytag: inherits="Constraint< T >" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A <a class="el" href="class_t_c_l_a_p_1_1_constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a> that constrains the <a class="el" href="class_t_c_l_a_p_1_1_arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a> to only those values specified in the constraint. </p> </div> <p><code>#include <<a class="el" href="_values_constraint_8h_source.html">mrpt/otherlibs/tclap/ValuesConstraint.h</a>></code></p> <div class="dynheader"> Inheritance diagram for TCLAP::ValuesConstraint:</div> <div class="dyncontent"> <div class="center"><img src="class_t_c_l_a_p_1_1_values_constraint__inherit__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_values_constraint_inherit__map" alt="Inheritance graph"/></div> <map name="_t_c_l_a_p_1_1_values_constraint_inherit__map" id="_t_c_l_a_p_1_1_values_constraint_inherit__map"> <area shape="rect" id="node2" href="class_t_c_l_a_p_1_1_constraint.html" title="TCLAP::Constraint\< T \>" alt="" coords="9,96,173,123"/><area shape="rect" id="node4" href="class_t_c_l_a_p_1_1_constraint.html" title="The interface that defines the interaction between the Arg and Constraint." alt="" coords="25,5,159,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="class_t_c_l_a_p_1_1_values_constraint-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#a6604c719fea2dce02b4c1f4be27348c8">ValuesConstraint</a> (<a class="el" href="classstd_1_1vector.html">std::vector</a>< T > &allowed)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a6604c719fea2dce02b4c1f4be27348c8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#a2496b5029d406e28dcc96f968b1b14a1">~ValuesConstraint</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#a2496b5029d406e28dcc96f968b1b14a1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#aa895e35f1452f91f578c72ccbcd2ef75">description</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a description of the <a class="el" href="class_t_c_l_a_p_1_1_constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>. <a href="#aa895e35f1452f91f578c72ccbcd2ef75"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#a8c2ee14b42307763ae876d635810b206">shortID</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the short ID for the <a class="el" href="class_t_c_l_a_p_1_1_constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>. <a href="#a8c2ee14b42307763ae876d635810b206"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#aff94a7aee604ec755d2c4010cbfc3cdf">check</a> (const T &value) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The method used to verify that the value parsed from the command line meets the constraint. <a href="#aff94a7aee604ec755d2c4010cbfc3cdf"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#ab7bdffd2795946c7c1a0c90af2ec105a">_allowed</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The list of valid values. <a href="#ab7bdffd2795946c7c1a0c90af2ec105a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#a320eaba3cdf93336f169c48c76b544ba">_typeDesc</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The string used to describe the allowed values of this constraint. <a href="#a320eaba3cdf93336f169c48c76b544ba"></a><br/></td></tr> </table> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a6604c719fea2dce02b4c1f4be27348c8"></a><!-- doxytag: member="TCLAP::ValuesConstraint::ValuesConstraint" ref="a6604c719fea2dce02b4c1f4be27348c8" args="(std::vector< T > &allowed)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TCLAP::ValuesConstraint::ValuesConstraint </td> <td>(</td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">std::vector</a>< T > & </td> <td class="paramname"><em>allowed</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">allowed</td><td>- vector of allowed values. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_values_constraint_8h_source.html#l00099">99</a> of file <a class="el" href="_values_constraint_8h_source.html">ValuesConstraint.h</a>.</p> <p>References <a class="el" href="_values_constraint_8h_source.html#l00089">_allowed</a>, and <a class="el" href="_values_constraint_8h_source.html#l00094">_typeDesc</a>.</p> </div> </div> <a class="anchor" id="a2496b5029d406e28dcc96f968b1b14a1"></a><!-- doxytag: member="TCLAP::ValuesConstraint::~ValuesConstraint" ref="a2496b5029d406e28dcc96f968b1b14a1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual TCLAP::ValuesConstraint::~ValuesConstraint </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Virtual destructor. </p> <p>Definition at line <a class="el" href="_values_constraint_8h_source.html#l00065">65</a> of file <a class="el" href="_values_constraint_8h_source.html">ValuesConstraint.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aff94a7aee604ec755d2c4010cbfc3cdf"></a><!-- doxytag: member="TCLAP::ValuesConstraint::check" ref="aff94a7aee604ec755d2c4010cbfc3cdf" args="(const T &value) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool TCLAP::ValuesConstraint::check </td> <td>(</td> <td class="paramtype">const T & </td> <td class="paramname"><em>value</em></td><td>)</td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The method used to verify that the value parsed from the command line meets the constraint. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>- The value that will be checked. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_constraint.html#ad5265b09ded6b1b6a20dab57f6aa697f">TCLAP::Constraint< T ></a>.</p> <p>Definition at line <a class="el" href="_values_constraint_8h_source.html#l00124">124</a> of file <a class="el" href="_values_constraint_8h_source.html">ValuesConstraint.h</a>.</p> </div> </div> <a class="anchor" id="aa895e35f1452f91f578c72ccbcd2ef75"></a><!-- doxytag: member="TCLAP::ValuesConstraint::description" ref="aa895e35f1452f91f578c72ccbcd2ef75" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::ValuesConstraint::description </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns a description of the <a class="el" href="class_t_c_l_a_p_1_1_constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_constraint.html#a5456259587f504d82e125ec3d855eb44">TCLAP::Constraint< T ></a>.</p> <p>Definition at line <a class="el" href="_values_constraint_8h_source.html#l00139">139</a> of file <a class="el" href="_values_constraint_8h_source.html">ValuesConstraint.h</a>.</p> </div> </div> <a class="anchor" id="a8c2ee14b42307763ae876d635810b206"></a><!-- doxytag: member="TCLAP::ValuesConstraint::shortID" ref="a8c2ee14b42307763ae876d635810b206" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::ValuesConstraint::shortID </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the short ID for the <a class="el" href="class_t_c_l_a_p_1_1_constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_constraint.html#ab8ee515d9a4956a9cee5994738be822a">TCLAP::Constraint< T ></a>.</p> <p>Definition at line <a class="el" href="_values_constraint_8h_source.html#l00133">133</a> of file <a class="el" href="_values_constraint_8h_source.html">ValuesConstraint.h</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="ab7bdffd2795946c7c1a0c90af2ec105a"></a><!-- doxytag: member="TCLAP::ValuesConstraint::_allowed" ref="ab7bdffd2795946c7c1a0c90af2ec105a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1vector.html">std::vector</a><T> <a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#ab7bdffd2795946c7c1a0c90af2ec105a">TCLAP::ValuesConstraint::_allowed</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The list of valid values. </p> <p>Definition at line <a class="el" href="_values_constraint_8h_source.html#l00089">89</a> of file <a class="el" href="_values_constraint_8h_source.html">ValuesConstraint.h</a>.</p> <p>Referenced by <a class="el" href="_values_constraint_8h_source.html#l00099">ValuesConstraint()</a>.</p> </div> </div> <a class="anchor" id="a320eaba3cdf93336f169c48c76b544ba"></a><!-- doxytag: member="TCLAP::ValuesConstraint::_typeDesc" ref="a320eaba3cdf93336f169c48c76b544ba" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#a320eaba3cdf93336f169c48c76b544ba">TCLAP::ValuesConstraint::_typeDesc</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The string used to describe the allowed values of this constraint. </p> <p>Definition at line <a class="el" href="_values_constraint_8h_source.html#l00094">94</a> of file <a class="el" href="_values_constraint_8h_source.html">ValuesConstraint.h</a>.</p> <p>Referenced by <a class="el" href="_values_constraint_8h_source.html#l00099">ValuesConstraint()</a>.</p> </div> </div> </div> <br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>