<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU CommonC++: ost::CommandOptionRest Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</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><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <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="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_command_option_rest.html">CommandOptionRest</a> </div> </div> <div class="contents"> <h1>ost::CommandOptionRest Class Reference</h1><!-- doxytag: class="ost::CommandOptionRest" --><!-- doxytag: inherits="ost::CommandOptionWithArg" --> <p>It only makes sense to have a single one of these set and it is exclusive with <a class="el" href="classost_1_1_command_option_collect.html" title="It only makes sense to have a single one of these set and it is also exclusive with...">CommandOptionCollect</a>. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="cmdoptns_8h_source.html">cmdoptns.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ost::CommandOptionRest:</div> <div class="dynsection"> <div class="center"> <img src="classost_1_1_command_option_rest.png" usemap="#ost::CommandOptionRest_map" alt=""/> <map id="ost::CommandOptionRest_map" name="ost::CommandOptionRest_map"> <area href="classost_1_1_command_option_with_arg.html" alt="ost::CommandOptionWithArg" shape="rect" coords="0,56,171,80"/> <area href="classost_1_1_command_option.html" alt="ost::CommandOption" shape="rect" coords="0,0,171,24"/> </map> </div> </div> <p><a href="classost_1_1_command_option_rest-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_rest.html#adf9824e9309fd733c2deb4f5652353c9">CommandOptionRest</a> (const char *inOptionName, const char *inOptionLetter, const char *inDescription, bool inRequired=false, <a class="el" href="classost_1_1_command_option.html">CommandOption</a> **ppNext=&<a class="el" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classost_1_1_command_option_rest.html" title="It only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect...">CommandOptionRest</a> contructor. <a href="#adf9824e9309fd733c2deb4f5652353c9"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>It only makes sense to have a single one of these set and it is exclusive with <a class="el" href="classost_1_1_command_option_collect.html" title="It only makes sense to have a single one of these set and it is also exclusive with...">CommandOptionCollect</a>. </p> <p>It is the option that takes the rest of the command line options that are not part of any other options. e.g. "strace -ofile command arg1 arg2". The "command arg1 arg2" part is placed in objects of this class.</p> <p><a class="el" href="classost_1_1_command_option.html" title="CommandOption is the base class for all command line options.">CommandOption</a> to take the rest of the command line </p> <dl><dt><b>Examples: </b></dt><dd> <p><a class="el" href="cmdlineopt_8cpp-example.html#_a10">cmdlineopt.cpp</a>.</p> </dd> </dl><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="adf9824e9309fd733c2deb4f5652353c9"></a><!-- doxytag: member="ost::CommandOptionRest::CommandOptionRest" ref="adf9824e9309fd733c2deb4f5652353c9" args="(const char *inOptionName, const char *inOptionLetter, const char *inDescription, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::CommandOptionRest::CommandOptionRest </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>inOptionName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>inOptionLetter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>inDescription</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>inRequired</em> = <code>false</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classost_1_1_command_option.html">CommandOption</a> ** </td> <td class="paramname"> <em>ppNext</em> = <code>&<a class="el" href="namespaceost.html#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="classost_1_1_command_option_rest.html" title="It only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect...">CommandOptionRest</a> contructor. </p> <p>This sets the optionType for this object to Trailing.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>inOptionName</em> </td><td>long option name </td></tr> <tr><td valign="top"></td><td valign="top"><em>inOptionLetter</em> </td><td>short letter name </td></tr> <tr><td valign="top"></td><td valign="top"><em>inDescription</em> </td><td>short description of the option </td></tr> <tr><td valign="top"></td><td valign="top"><em>inRequired</em> </td><td>true if option is required </td></tr> <tr><td valign="top"></td><td valign="top"><em>ppNext</em> </td><td>the linked list header </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="cmdoptns_8h_source.html">cmdoptns.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:46 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>