<!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::XorHandler 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_xor_handler.html">XorHandler</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::XorHandler Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="TCLAP::XorHandler" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>This class handles lists of Arg's that are to be XOR'd on the command line. </p> <p>This is used by <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> and you shouldn't ever use it. </p> </div> <p><code>#include <<a class="el" href="_xor_handler_8h_source.html">mrpt/otherlibs/tclap/XorHandler.h</a>></code></p> <p><a href="class_t_c_l_a_p_1_1_xor_handler-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_xor_handler.html#a195391f50b7fe5eb939c2f6d236f571e">XorHandler</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a195391f50b7fe5eb939c2f6d236f571e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html#a76f156bf36a8aede334801aa242f31b9">add</a> (<a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > &ors)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a list of Arg*'s that will be orred together. <a href="#a76f156bf36a8aede334801aa242f31b9"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html#a3df7722e4c4c5d331de69fc902336b00">check</a> (const <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> *a)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified <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> is in one of the xor lists and if it does match one, returns the size of the xor list that 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> matched. <a href="#a3df7722e4c4c5d331de69fc902336b00"></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_xor_handler.html#aca185a80e9df6e4250a230fa5aec7891">shortUsage</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the XOR specific short usage. <a href="#aca185a80e9df6e4250a230fa5aec7891"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html#a257a855934eb343a0fad3c4e5fe5ff57">printLongUsage</a> (<a class="el" href="classstd_1_1ostream.html">std::ostream</a> &os)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prints the XOR specific long usage. <a href="#a257a855934eb343a0fad3c4e5fe5ff57"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html#a1a74fab4667cc591a1e3094c91bc942d">contains</a> (const <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> *a)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Simply checks whether 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> is contained in one of the arg lists. <a href="#a1a74fab4667cc591a1e3094c91bc942d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html#a0e0d95c697d227cc51f82424b8530182">getXorList</a> ()</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>< <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1">_orList</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The list of of lists of Arg's to be or'd together. <a href="#a4ebd5b96e23a0ab03bdd431fe622d4e1"></a><br/></td></tr> </table> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a195391f50b7fe5eb939c2f6d236f571e"></a><!-- doxytag: member="TCLAP::XorHandler::XorHandler" ref="a195391f50b7fe5eb939c2f6d236f571e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TCLAP::XorHandler::XorHandler </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <p>Does nothing. </p> <p>Definition at line <a class="el" href="_xor_handler_8h_source.html#l00052">52</a> of file <a class="el" href="_xor_handler_8h_source.html">XorHandler.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a76f156bf36a8aede334801aa242f31b9"></a><!-- doxytag: member="TCLAP::XorHandler::add" ref="a76f156bf36a8aede334801aa242f31b9" args="(std::vector< Arg * > &ors)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::XorHandler::add </td> <td>(</td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > & </td> <td class="paramname"><em>ors</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Add a list of Arg*'s that will be orred together. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ors</td><td>- list of Arg* that will be xor'd. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_xor_handler_8h_source.html#l00095">95</a> of file <a class="el" href="_xor_handler_8h_source.html">XorHandler.h</a>.</p> <p>References <a class="el" href="_xor_handler_8h_source.html#l00045">_orList</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00335">TCLAP::CmdLine::xorAdd()</a>.</p> </div> </div> <a class="anchor" id="a3df7722e4c4c5d331de69fc902336b00"></a><!-- doxytag: member="TCLAP::XorHandler::check" ref="a3df7722e4c4c5d331de69fc902336b00" args="(const Arg *a)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int TCLAP::XorHandler::check </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * </td> <td class="paramname"><em>a</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Checks whether the specified <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> is in one of the xor lists and if it does match one, returns the size of the xor list that 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> matched. </p> <p>If 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> matches, then it also sets the rest of the Arg's in the list. You shouldn't use this. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>- 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 be checked. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_xor_handler_8h_source.html#l00100">100</a> of file <a class="el" href="_xor_handler_8h_source.html">XorHandler.h</a>.</p> <p>References <a class="el" href="_xor_handler_8h_source.html#l00045">_orList</a>, <a class="el" href="eigen__plugins_8h_source.html#l00046">begin()</a>, <a class="el" href="eigen__plugins_8h_source.html#l00047">end()</a>, and <a class="el" href="_arg_8h_source.html#l00471">TCLAP::Arg::isRequired()</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00375">TCLAP::CmdLine::parse()</a>.</p> </div> </div> <a class="anchor" id="a1a74fab4667cc591a1e3094c91bc942d"></a><!-- doxytag: member="TCLAP::XorHandler::contains" ref="a1a74fab4667cc591a1e3094c91bc942d" args="(const Arg *a)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool TCLAP::XorHandler::contains </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * </td> <td class="paramname"><em>a</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Simply checks whether 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> is contained in one of the arg lists. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>- 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 be checked. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_xor_handler_8h_source.html#l00131">131</a> of file <a class="el" href="_xor_handler_8h_source.html">XorHandler.h</a>.</p> <p>References <a class="el" href="_xor_handler_8h_source.html#l00045">_orList</a>, and <a class="el" href="eigen__plugins_8h_source.html#l00046">begin()</a>.</p> <p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00091">TCLAP::DocBookOutput::usage()</a>, <a class="el" href="_std_output_8h_source.html#l00164">TCLAP::StdOutput::_shortUsage()</a>, and <a class="el" href="_std_output_8h_source.html#l00198">TCLAP::StdOutput::_longUsage()</a>.</p> </div> </div> <a class="anchor" id="a0e0d95c697d227cc51f82424b8530182"></a><!-- doxytag: member="TCLAP::XorHandler::getXorList" ref="a0e0d95c697d227cc51f82424b8530182" 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>< <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > > & TCLAP::XorHandler::getXorList </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_xor_handler_8h_source.html#l00143">143</a> of file <a class="el" href="_xor_handler_8h_source.html">XorHandler.h</a>.</p> <p>References <a class="el" href="_xor_handler_8h_source.html#l00045">_orList</a>.</p> <p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00091">TCLAP::DocBookOutput::usage()</a>, <a class="el" href="_std_output_8h_source.html#l00164">TCLAP::StdOutput::_shortUsage()</a>, and <a class="el" href="_std_output_8h_source.html#l00198">TCLAP::StdOutput::_longUsage()</a>.</p> </div> </div> <a class="anchor" id="a257a855934eb343a0fad3c4e5fe5ff57"></a><!-- doxytag: member="TCLAP::XorHandler::printLongUsage" ref="a257a855934eb343a0fad3c4e5fe5ff57" args="(std::ostream &os)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::XorHandler::printLongUsage </td> <td>(</td> <td class="paramtype"><a class="el" href="classstd_1_1ostream.html">std::ostream</a> & </td> <td class="paramname"><em>os</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Prints the XOR specific long usage. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">os</td><td>- Stream to print to. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aca185a80e9df6e4250a230fa5aec7891"></a><!-- doxytag: member="TCLAP::XorHandler::shortUsage" ref="aca185a80e9df6e4250a230fa5aec7891" 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> TCLAP::XorHandler::shortUsage </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the XOR specific short usage. </p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a4ebd5b96e23a0ab03bdd431fe622d4e1"></a><!-- doxytag: member="TCLAP::XorHandler::_orList" ref="a4ebd5b96e23a0ab03bdd431fe622d4e1" 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>< <a class="el" href="classstd_1_1vector.html">std::vector</a><<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a>*> > <a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html#a4ebd5b96e23a0ab03bdd431fe622d4e1">TCLAP::XorHandler::_orList</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The list of of lists of Arg's to be or'd together. </p> <p>Definition at line <a class="el" href="_xor_handler_8h_source.html#l00045">45</a> of file <a class="el" href="_xor_handler_8h_source.html">XorHandler.h</a>.</p> <p>Referenced by <a class="el" href="_xor_handler_8h_source.html#l00095">add()</a>, <a class="el" href="_xor_handler_8h_source.html#l00100">check()</a>, <a class="el" href="_xor_handler_8h_source.html#l00131">contains()</a>, and <a class="el" href="_xor_handler_8h_source.html#l00143">getXorList()</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>