<!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>ValuesConstraint.h Source File</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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><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="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <div class="title">ValuesConstraint.h</div> </div> </div> <div class="contents"> <a href="_values_constraint_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">/****************************************************************************** </span> <a name="l00004"></a>00004 <span class="comment"> * </span> <a name="l00005"></a>00005 <span class="comment"> * file: ValuesConstraint.h</span> <a name="l00006"></a>00006 <span class="comment"> * </span> <a name="l00007"></a>00007 <span class="comment"> * Copyright (c) 2005, Michael E. Smoot</span> <a name="l00008"></a>00008 <span class="comment"> * All rights reverved.</span> <a name="l00009"></a>00009 <span class="comment"> * </span> <a name="l00010"></a>00010 <span class="comment"> * See the file COPYING in the top directory of this distribution for</span> <a name="l00011"></a>00011 <span class="comment"> * more information.</span> <a name="l00012"></a>00012 <span class="comment"> * </span> <a name="l00013"></a>00013 <span class="comment"> * THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS </span> <a name="l00014"></a>00014 <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, </span> <a name="l00015"></a>00015 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL </span> <a name="l00016"></a>00016 <span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER </span> <a name="l00017"></a>00017 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING </span> <a name="l00018"></a>00018 <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER </span> <a name="l00019"></a>00019 <span class="comment"> * DEALINGS IN THE SOFTWARE. </span> <a name="l00020"></a>00020 <span class="comment"> * </span> <a name="l00021"></a>00021 <span class="comment"> *****************************************************************************/</span> <a name="l00022"></a>00022 <a name="l00023"></a>00023 <span class="preprocessor">#ifndef TCLAP_VALUESCONSTRAINT_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define TCLAP_VALUESCONSTRAINT_H</span> <a name="l00025"></a>00025 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <string></span> <a name="l00027"></a>00027 <span class="preprocessor">#include <vector></span> <a name="l00028"></a>00028 <span class="preprocessor">#include <<a class="code" href="_constraint_8h.html">mrpt/otherlibs/tclap/Constraint.h</a>></span> <a name="l00029"></a>00029 <a name="l00030"></a>00030 <span class="comment">//#ifdef HAVE_CONFIG_H</span> <a name="l00031"></a>00031 <span class="comment">//#include <config.h></span> <a name="l00032"></a>00032 <span class="comment">//#else</span> <a name="l00033"></a><a class="code" href="_values_constraint_8h.html#a91e904e6e4f21f803c49113b934e6966">00033</a> <span class="preprocessor">#define HAVE_SSTREAM</span> <a name="l00034"></a>00034 <span class="preprocessor"></span><span class="comment">//#endif</span> <a name="l00035"></a>00035 <a name="l00036"></a>00036 <span class="preprocessor">#if defined(HAVE_SSTREAM)</span> <a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#include <sstream></span> <a name="l00038"></a>00038 <span class="preprocessor">#elif defined(HAVE_STRSTREAM)</span> <a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#include <strstream></span> <a name="l00040"></a>00040 <span class="preprocessor">#else</span> <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#error "Need a stringstream (sstream or strstream) to compile!"</span> <a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00043"></a>00043 <span class="preprocessor"></span> <a name="l00044"></a>00044 <span class="keyword">namespace </span>TCLAP { <a name="l00045"></a>00045 <span class="comment"></span> <a name="l00046"></a>00046 <span class="comment">/**</span> <a name="l00047"></a>00047 <span class="comment"> * A Constraint that constrains the Arg to only those values specified</span> <a name="l00048"></a>00048 <span class="comment"> * in the constraint.</span> <a name="l00049"></a>00049 <span class="comment"> */</span> <a name="l00050"></a>00050 <span class="keyword">template</span><<span class="keyword">class</span> T> <a name="l00051"></a>00051 <span class="keyword">class </span>ValuesConstraint : <span class="keyword">public</span> Constraint<T> <a name="l00052"></a>00052 { <a name="l00053"></a>00053 <a name="l00054"></a>00054 <span class="keyword">public</span>: <a name="l00055"></a>00055 <span class="comment"></span> <a name="l00056"></a>00056 <span class="comment"> /**</span> <a name="l00057"></a>00057 <span class="comment"> * Constructor. </span> <a name="l00058"></a>00058 <span class="comment"> * \param allowed - vector of allowed values. </span> <a name="l00059"></a>00059 <span class="comment"> */</span> <a name="l00060"></a>00060 <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a6604c719fea2dce02b4c1f4be27348c8" title="Constructor.">ValuesConstraint</a>(<a class="code" href="classstd_1_1vector.html">std::vector<T></a>& allowed); <a name="l00061"></a>00061 <span class="comment"></span> <a name="l00062"></a>00062 <span class="comment"> /**</span> <a name="l00063"></a>00063 <span class="comment"> * Virtual destructor.</span> <a name="l00064"></a>00064 <span class="comment"> */</span> <a name="l00065"></a><a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a2496b5029d406e28dcc96f968b1b14a1">00065</a> <span class="keyword">virtual</span> <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a2496b5029d406e28dcc96f968b1b14a1" title="Virtual destructor.">~ValuesConstraint</a>() {} <a name="l00066"></a>00066 <span class="comment"></span> <a name="l00067"></a>00067 <span class="comment"> /**</span> <a name="l00068"></a>00068 <span class="comment"> * Returns a description of the Constraint. </span> <a name="l00069"></a>00069 <span class="comment"> */</span> <a name="l00070"></a>00070 <span class="keyword">virtual</span> std::string <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#aa895e35f1452f91f578c72ccbcd2ef75" title="Returns a description of the Constraint.">description</a>() <span class="keyword">const</span>; <a name="l00071"></a>00071 <span class="comment"></span> <a name="l00072"></a>00072 <span class="comment"> /**</span> <a name="l00073"></a>00073 <span class="comment"> * Returns the short ID for the Constraint.</span> <a name="l00074"></a>00074 <span class="comment"> */</span> <a name="l00075"></a>00075 <span class="keyword">virtual</span> std::string <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a8c2ee14b42307763ae876d635810b206" title="Returns the short ID for the Constraint.">shortID</a>() <span class="keyword">const</span>; <a name="l00076"></a>00076 <span class="comment"></span> <a name="l00077"></a>00077 <span class="comment"> /**</span> <a name="l00078"></a>00078 <span class="comment"> * The method used to verify that the value parsed from the command</span> <a name="l00079"></a>00079 <span class="comment"> * line meets the constraint.</span> <a name="l00080"></a>00080 <span class="comment"> * \param value - The value that will be checked. </span> <a name="l00081"></a>00081 <span class="comment"> */</span> <a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#aff94a7aee604ec755d2c4010cbfc3cdf" title="The method used to verify that the value parsed from the command line meets the constraint.">check</a>(<span class="keyword">const</span> T& value) <span class="keyword">const</span>; <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="keyword">protected</span>: <a name="l00085"></a>00085 <span class="comment"></span> <a name="l00086"></a>00086 <span class="comment"> /**</span> <a name="l00087"></a>00087 <span class="comment"> * The list of valid values. </span> <a name="l00088"></a>00088 <span class="comment"> */</span> <a name="l00089"></a><a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#ab7bdffd2795946c7c1a0c90af2ec105a">00089</a> std::vector<T> <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#ab7bdffd2795946c7c1a0c90af2ec105a" title="The list of valid values.">_allowed</a>; <a name="l00090"></a>00090 <span class="comment"></span> <a name="l00091"></a>00091 <span class="comment"> /**</span> <a name="l00092"></a>00092 <span class="comment"> * The string used to describe the allowed values of this constraint.</span> <a name="l00093"></a>00093 <span class="comment"> */</span> <a name="l00094"></a><a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a320eaba3cdf93336f169c48c76b544ba">00094</a> std::string <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a320eaba3cdf93336f169c48c76b544ba" title="The string used to describe the allowed values of this constraint.">_typeDesc</a>; <a name="l00095"></a>00095 <a name="l00096"></a>00096 }; <a name="l00097"></a>00097 <a name="l00098"></a>00098 <span class="keyword">template</span><<span class="keyword">class</span> T> <a name="l00099"></a><a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a6604c719fea2dce02b4c1f4be27348c8">00099</a> <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a6604c719fea2dce02b4c1f4be27348c8" title="Constructor.">ValuesConstraint<T>::ValuesConstraint</a>(<a class="code" href="classstd_1_1vector.html">std::vector<T></a>& allowed) <a name="l00100"></a>00100 : _allowed(allowed) <a name="l00101"></a>00101 { <a name="l00102"></a>00102 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#ab7bdffd2795946c7c1a0c90af2ec105a" title="The list of valid values.">_allowed</a>.size(); i++ ) <a name="l00103"></a>00103 { <a name="l00104"></a>00104 <a name="l00105"></a>00105 <span class="preprocessor">#if defined(HAVE_SSTREAM)</span> <a name="l00106"></a>00106 <span class="preprocessor"></span> std::ostringstream os; <a name="l00107"></a>00107 <span class="preprocessor">#elif defined(HAVE_STRSTREAM)</span> <a name="l00108"></a>00108 <span class="preprocessor"></span> std::ostrstream os; <a name="l00109"></a>00109 <span class="preprocessor">#else</span> <a name="l00110"></a>00110 <span class="preprocessor"></span><span class="preprocessor">#error "Need a stringstream (sstream or strstream) to compile!"</span> <a name="l00111"></a>00111 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00112"></a>00112 <span class="preprocessor"></span> <a name="l00113"></a>00113 os << <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#ab7bdffd2795946c7c1a0c90af2ec105a" title="The list of valid values.">_allowed</a>[i]; <a name="l00114"></a>00114 <a name="l00115"></a>00115 std::string temp( os.str() ); <a name="l00116"></a>00116 <a name="l00117"></a>00117 <span class="keywordflow">if</span> ( i > 0 ) <a name="l00118"></a>00118 <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a320eaba3cdf93336f169c48c76b544ba" title="The string used to describe the allowed values of this constraint.">_typeDesc</a> += <span class="stringliteral">"|"</span>; <a name="l00119"></a>00119 <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a320eaba3cdf93336f169c48c76b544ba" title="The string used to describe the allowed values of this constraint.">_typeDesc</a> += temp; <a name="l00120"></a>00120 } <a name="l00121"></a>00121 } <a name="l00122"></a>00122 <a name="l00123"></a>00123 <span class="keyword">template</span><<span class="keyword">class</span> T> <a name="l00124"></a><a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#aff94a7aee604ec755d2c4010cbfc3cdf">00124</a> <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#aff94a7aee604ec755d2c4010cbfc3cdf" title="The method used to verify that the value parsed from the command line meets the constraint.">ValuesConstraint<T>::check</a>( <span class="keyword">const</span> T& val )<span class="keyword"> const</span> <a name="l00125"></a>00125 <span class="keyword"></span>{ <a name="l00126"></a>00126 <span class="keywordflow">if</span> ( std::find(_allowed.begin(),_allowed.end(),val) == _allowed.end() ) <a name="l00127"></a>00127 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00128"></a>00128 <span class="keywordflow">else</span> <a name="l00129"></a>00129 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00130"></a>00130 } <a name="l00131"></a>00131 <a name="l00132"></a>00132 <span class="keyword">template</span><<span class="keyword">class</span> T> <a name="l00133"></a><a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a8c2ee14b42307763ae876d635810b206">00133</a> std::string <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#a8c2ee14b42307763ae876d635810b206" title="Returns the short ID for the Constraint.">ValuesConstraint<T>::shortID</a>()<span class="keyword"> const</span> <a name="l00134"></a>00134 <span class="keyword"></span>{ <a name="l00135"></a>00135 <span class="keywordflow">return</span> _typeDesc; <a name="l00136"></a>00136 } <a name="l00137"></a>00137 <a name="l00138"></a>00138 <span class="keyword">template</span><<span class="keyword">class</span> T> <a name="l00139"></a><a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#aa895e35f1452f91f578c72ccbcd2ef75">00139</a> std::string <a class="code" href="class_t_c_l_a_p_1_1_values_constraint.html#aa895e35f1452f91f578c72ccbcd2ef75" title="Returns a description of the Constraint.">ValuesConstraint<T>::description</a>()<span class="keyword"> const</span> <a name="l00140"></a>00140 <span class="keyword"></span>{ <a name="l00141"></a>00141 <span class="keywordflow">return</span> _typeDesc; <a name="l00142"></a>00142 } <a name="l00143"></a>00143 <a name="l00144"></a>00144 <a name="l00145"></a>00145 } <span class="comment">//namespace TCLAP</span> <a name="l00146"></a>00146 <span class="preprocessor">#endif </span> <a name="l00147"></a>00147 <span class="preprocessor"></span> </pre></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>