<!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>XorHandler.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">XorHandler.h</div> </div>
</div>
<div class="contents">
<a href="_xor_handler_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 <span class="comment">/****************************************************************************** </span>
<a name="l00003"></a>00003 <span class="comment"> * </span>
<a name="l00004"></a>00004 <span class="comment"> * file: XorHandler.h</span>
<a name="l00005"></a>00005 <span class="comment"> * </span>
<a name="l00006"></a>00006 <span class="comment"> * Copyright (c) 2003, Michael E. Smoot .</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (c) 2004, Michael E. Smoot, Daniel Aarno.</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_XORHANDLER_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define TCLAP_XORHANDLER_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="_arg_8h.html">mrpt/otherlibs/tclap/Arg.h</a>></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <string></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <vector></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <algorithm></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <iostream></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">namespace </span>TCLAP {
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/**</span>
<a name="l00035"></a>00035 <span class="comment"> * This class handles lists of Arg's that are to be XOR'd on the command</span>
<a name="l00036"></a>00036 <span class="comment"> * line. This is used by CmdLine and you shouldn't ever use it.</span>
<a name="l00037"></a>00037 <span class="comment"> */</span>
<a name="l00038"></a>00038 <span class="keyword">class </span>XorHandler
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">protected</span>:
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> /**</span>
<a name="l00043"></a>00043 <span class="comment"> * The list of of lists of Arg's to be or'd together.</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a><a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1">00045</a> std::vector< std::vector<Arg*> > <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">public</span>:
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment"> /**</span>
<a name="l00050"></a>00050 <span class="comment"> * Constructor. Does nothing.</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a><a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a195391f50b7fe5eb939c2f6d236f571e">00052</a> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a195391f50b7fe5eb939c2f6d236f571e" title="Constructor.">XorHandler</a>( ) {}
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /**</span>
<a name="l00055"></a>00055 <span class="comment"> * Add a list of Arg*'s that will be orred together.</span>
<a name="l00056"></a>00056 <span class="comment"> * \param ors - list of Arg* that will be xor'd.</span>
<a name="l00057"></a>00057 <span class="comment"> */</span>
<a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a76f156bf36a8aede334801aa242f31b9" title="Add a list of Arg*'s that will be orred together.">add</a>( <a class="code" href="classstd_1_1vector.html" title="STL class.">std::vector<Arg*></a>& ors );
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> /**</span>
<a name="l00061"></a>00061 <span class="comment"> * Checks whether the specified Arg is in one of the xor lists and</span>
<a name="l00062"></a>00062 <span class="comment"> * if it does match one, returns the size of the xor list that the</span>
<a name="l00063"></a>00063 <span class="comment"> * Arg matched. If the Arg matches, then it also sets the rest of</span>
<a name="l00064"></a>00064 <span class="comment"> * the Arg's in the list. You shouldn't use this. </span>
<a name="l00065"></a>00065 <span class="comment"> * \param a - The Arg to be checked.</span>
<a name="l00066"></a>00066 <span class="comment"> */</span>
<a name="l00067"></a>00067 <span class="keywordtype">int</span> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a3df7722e4c4c5d331de69fc902336b00" title="Checks whether the specified Arg is in one of the xor lists and if it does match one, returns the size of the xor list that the Arg matched.">check</a>( <span class="keyword">const</span> <a class="code" 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>* a );
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment"> /**</span>
<a name="l00070"></a>00070 <span class="comment"> * Returns the XOR specific short usage.</span>
<a name="l00071"></a>00071 <span class="comment"> */</span>
<a name="l00072"></a>00072 std::string <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#aca185a80e9df6e4250a230fa5aec7891" title="Returns the XOR specific short usage.">shortUsage</a>();
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment"> /**</span>
<a name="l00075"></a>00075 <span class="comment"> * Prints the XOR specific long usage.</span>
<a name="l00076"></a>00076 <span class="comment"> * \param os - Stream to print to.</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a>00078 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a257a855934eb343a0fad3c4e5fe5ff57" title="Prints the XOR specific long usage.">printLongUsage</a>(<a class="code" href="classstd_1_1ostream.html" title="STL class.">std::ostream</a>& os);
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /**</span>
<a name="l00081"></a>00081 <span class="comment"> * Simply checks whether the Arg is contained in one of the arg</span>
<a name="l00082"></a>00082 <span class="comment"> * lists.</span>
<a name="l00083"></a>00083 <span class="comment"> * \param a - The Arg to be checked.</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085 <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a1a74fab4667cc591a1e3094c91bc942d" title="Simply checks whether the Arg is contained in one of the arg lists.">contains</a>( <span class="keyword">const</span> <a class="code" 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>* a );
<a name="l00086"></a>00086
<a name="l00087"></a>00087 std::vector< std::vector<Arg*> >& <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a0e0d95c697d227cc51f82424b8530182">getXorList</a>();
<a name="l00088"></a>00088
<a name="l00089"></a>00089 };
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment">//////////////////////////////////////////////////////////////////////</span>
<a name="l00093"></a>00093 <span class="comment"></span><span class="comment">//BEGIN XOR.cpp</span><span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment">//////////////////////////////////////////////////////////////////////</span>
<a name="l00095"></a><a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a76f156bf36a8aede334801aa242f31b9">00095</a> <span class="comment"></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a76f156bf36a8aede334801aa242f31b9" title="Add a list of Arg*'s that will be orred together.">XorHandler::add</a>( <a class="code" href="classstd_1_1vector.html" title="STL class.">std::vector<Arg*></a>& ors )
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>.push_back( ors );
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099
<a name="l00100"></a><a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a3df7722e4c4c5d331de69fc902336b00">00100</a> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a3df7722e4c4c5d331de69fc902336b00" title="Checks whether the specified Arg is in one of the xor lists and if it does match one, returns the size of the xor list that the Arg matched.">XorHandler::check</a>( <span class="keyword">const</span> <a class="code" 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>* a )
<a name="l00101"></a>00101 {
<a name="l00102"></a>00102 <span class="comment">// iterate over each XOR list</span>
<a name="l00103"></a>00103 <span class="keywordflow">for</span> ( <span class="keywordtype">int</span> i = 0; <span class="keyword">static_cast<</span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span><span class="keyword">></span>(i) < <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>.size(); i++ )
<a name="l00104"></a>00104 {
<a name="l00105"></a>00105 <span class="comment">// if the XOR list contains the arg..</span>
<a name="l00106"></a>00106 <a class="code" href="classstd_1_1vector_1_1iterator.html" title="STL iterator class.">ArgVectorIterator</a> ait = std::find( <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>[i].<a class="code" href="eigen__plugins_8h.html#ab295fd8164bf1b1acecbcb29520d62b7">begin</a>(),
<a name="l00107"></a>00107 <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>[i].<a class="code" href="eigen__plugins_8h.html#ade5b39864c905cbb824d0ff6eb0d888c">end</a>(), a );
<a name="l00108"></a>00108 <span class="keywordflow">if</span> ( ait != <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>[i].<a class="code" href="eigen__plugins_8h.html#ade5b39864c905cbb824d0ff6eb0d888c">end</a>() )
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 <span class="comment">// go through and set each arg that is not a</span>
<a name="l00111"></a>00111 <span class="keywordflow">for</span> ( <a class="code" href="classstd_1_1vector_1_1iterator.html" title="STL iterator class.">ArgVectorIterator</a> it = <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>[i].<a class="code" href="eigen__plugins_8h.html#ab295fd8164bf1b1acecbcb29520d62b7">begin</a>();
<a name="l00112"></a>00112 it != <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>[i].end();
<a name="l00113"></a>00113 it++ )
<a name="l00114"></a>00114 <span class="keywordflow">if</span> ( a != (*it) )
<a name="l00115"></a>00115 (*it)->xorSet();
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">// return the number of required args that have now been set</span>
<a name="l00118"></a>00118 <span class="keywordflow">if</span> ( (*ait)->allowMore() )
<a name="l00119"></a>00119 <span class="keywordflow">return</span> 0;
<a name="l00120"></a>00120 <span class="keywordflow">else</span>
<a name="l00121"></a>00121 <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">int</span><span class="keyword">></span>(<a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>[i].size());
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="keywordflow">if</span> ( a-><a class="code" href="class_t_c_l_a_p_1_1_arg.html#a00a3cfdb2b6e9a111ad39cbd4978b96c" title="Indicates whether the argument is required.">isRequired</a>() )
<a name="l00126"></a>00126 <span class="keywordflow">return</span> 1;
<a name="l00127"></a>00127 <span class="keywordflow">else</span>
<a name="l00128"></a>00128 <span class="keywordflow">return</span> 0;
<a name="l00129"></a>00129 }
<a name="l00130"></a>00130
<a name="l00131"></a><a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a1a74fab4667cc591a1e3094c91bc942d">00131</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a1a74fab4667cc591a1e3094c91bc942d" title="Simply checks whether the Arg is contained in one of the arg lists.">XorHandler::contains</a>( <span class="keyword">const</span> <a class="code" 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>* a )
<a name="l00132"></a>00132 {
<a name="l00133"></a>00133 <span class="keywordflow">for</span> ( <span class="keywordtype">int</span> i = 0; <span class="keyword">static_cast<</span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span><span class="keyword">></span>(i) < <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>.size(); i++ )
<a name="l00134"></a>00134 <span class="keywordflow">for</span> ( <a class="code" href="classstd_1_1vector_1_1iterator.html" title="STL iterator class.">ArgVectorIterator</a> it = <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>[i].<a class="code" href="eigen__plugins_8h.html#ab295fd8164bf1b1acecbcb29520d62b7">begin</a>();
<a name="l00135"></a>00135 it != <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>[i].end();
<a name="l00136"></a>00136 it++ )
<a name="l00137"></a>00137 <span class="keywordflow">if</span> ( a == (*it) )
<a name="l00138"></a>00138 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00141"></a>00141 }
<a name="l00142"></a>00142
<a name="l00143"></a><a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a0e0d95c697d227cc51f82424b8530182">00143</a> <span class="keyword">inline</span> std::vector< std::vector<Arg*> >& <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a0e0d95c697d227cc51f82424b8530182">XorHandler::getXorList</a>()
<a name="l00144"></a>00144 {
<a name="l00145"></a>00145 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1" title="The list of of lists of Arg's to be or'd together.">_orList</a>;
<a name="l00146"></a>00146 }
<a name="l00147"></a>00147
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment">//////////////////////////////////////////////////////////////////////</span>
<a name="l00151"></a>00151 <span class="comment"></span><span class="comment">//END XOR.cpp</span><span class="comment"></span>
<a name="l00152"></a>00152 <span class="comment">//////////////////////////////////////////////////////////////////////</span>
<a name="l00153"></a>00153 <span class="comment"></span>
<a name="l00154"></a>00154 } <span class="comment">//namespace TCLAP</span>
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="preprocessor">#endif </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>
