<!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::Constraint 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_constraint.html">Constraint</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">TCLAP::Constraint Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="TCLAP::Constraint" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The interface that defines the interaction between 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> and <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>
</div>
<p><code>#include <<a class="el" href="_constraint_8h_source.html">mrpt/otherlibs/tclap/Constraint.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::Constraint:</div>
<div class="dyncontent">
<div class="center"><img src="class_t_c_l_a_p_1_1_constraint__inherit__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_constraint_inherit__map" alt="Inheritance graph"/></div>
<map name="_t_c_l_a_p_1_1_constraint_inherit__map" id="_t_c_l_a_p_1_1_constraint_inherit__map">
<area shape="rect" id="node3" 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="node5" href="class_t_c_l_a_p_1_1_values_constraint.html" title="A Constraint that constrains the Arg to only those values specified in the constraint." alt="" coords="5,173,179,200"/></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_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">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_constraint.html#a5456259587f504d82e125ec3d855eb44">description</a> () const =0</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="#a5456259587f504d82e125ec3d855eb44"></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_constraint.html#ab8ee515d9a4956a9cee5994738be822a">shortID</a> () const =0</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="#ab8ee515d9a4956a9cee5994738be822a"></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_constraint.html#ad5265b09ded6b1b6a20dab57f6aa697f">check</a> (const T &value) const =0</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="#ad5265b09ded6b1b6a20dab57f6aa697f"></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_constraint.html#a118d389282893e0df7c539fa9a7eee0a">~Constraint</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a118d389282893e0df7c539fa9a7eee0a"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a118d389282893e0df7c539fa9a7eee0a"></a><!-- doxytag: member="TCLAP::Constraint::~Constraint" ref="a118d389282893e0df7c539fa9a7eee0a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual TCLAP::Constraint::~Constraint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Silences warnings about <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> being a base class with virtual functions but without a virtual destructor. </p>
<p>Definition at line <a class="el" href="_constraint_8h_source.html#l00064">64</a> of file <a class="el" href="_constraint_8h_source.html">Constraint.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad5265b09ded6b1b6a20dab57f6aa697f"></a><!-- doxytag: member="TCLAP::Constraint::check" ref="ad5265b09ded6b1b6a20dab57f6aa697f" args="(const T &value) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool TCLAP::Constraint::check </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td> const<code> [pure 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>Implemented in <a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#aff94a7aee604ec755d2c4010cbfc3cdf">TCLAP::ValuesConstraint</a>.</p>
</div>
</div>
<a class="anchor" id="a5456259587f504d82e125ec3d855eb44"></a><!-- doxytag: member="TCLAP::Constraint::description" ref="a5456259587f504d82e125ec3d855eb44" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::Constraint::description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure 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>Implemented in <a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#aa895e35f1452f91f578c72ccbcd2ef75">TCLAP::ValuesConstraint</a>.</p>
</div>
</div>
<a class="anchor" id="ab8ee515d9a4956a9cee5994738be822a"></a><!-- doxytag: member="TCLAP::Constraint::shortID" ref="ab8ee515d9a4956a9cee5994738be822a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::Constraint::shortID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure 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>Implemented in <a class="el" href="class_t_c_l_a_p_1_1_values_constraint.html#a8c2ee14b42307763ae876d635810b206">TCLAP::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>
