<!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>GNU CommonC++: ost::CommandOptionWithArg Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a></div>
<h1>ost::CommandOptionWithArg Class Reference</h1><!-- doxytag: class="ost::CommandOptionWithArg" --><!-- doxytag: inherits="ost::CommandOption" -->Derived class of <a class="el" href="classost_1_1_command_option.html">CommandOption</a> for options that have a value associated with them.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cmdoptns_8h-source.html">cmdoptns.h</a>></code>
<p>
<p>Inheritance diagram for ost::CommandOptionWithArg:
<p><center><img src="classost_1_1_command_option_with_arg.png" usemap="#ost::CommandOptionWithArg_map" border="0" alt=""></center>
<map name="ost::CommandOptionWithArg_map">
<area href="classost_1_1_command_option.html" alt="ost::CommandOption" shape="rect" coords="181,0,352,24">
<area href="classost_1_1_command_option_arg.html" alt="ost::CommandOptionArg" shape="rect" coords="0,112,171,136">
<area href="classost_1_1_command_option_collect.html" alt="ost::CommandOptionCollect" shape="rect" coords="181,112,352,136">
<area href="classost_1_1_command_option_rest.html" alt="ost::CommandOptionRest" shape="rect" coords="362,112,533,136">
</map>
<a href="classost_1_1_command_option_with_arg-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#874400acc8820fe88023245903b471a8">CommandOptionWithArg</a> (const char *inOptionName, const char *inOptionLetter, const char *inDescription, <a class="el" href="classost_1_1_command_option.html#b56f222627bb3843d2b055d42ceaa493">OptionType</a> inOptionType, bool inRequired=false, <a class="el" href="classost_1_1_command_option.html">CommandOption</a> **ppNext=&<a class="el" href="namespaceost.html#3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a> contructor. <a href="#874400acc8820fe88023245903b471a8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#a2405c8615aef3b4503ead25d4e687b7">~CommandOptionWithArg</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#a7a9e87b68ef493f84688355062fc9a8">foundOption</a> (<a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> *cop, const char *value=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#7e012538193acafda06b609dc1dee369">foundOption</a> (<a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> *cop, const char **value, int num)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#cf0c03d84b032dab059ae219922dadde">hasValue</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#5ccc2d9deb4a248d8414193385a1fc09">values</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Array of list of values collected for this option. <a href="#5ccc2d9deb4a248d8414193385a1fc09"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#1fdb4121e6a385dd52e6599338019ce7">numValue</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classost_1_1_number.html">Number</a> of values in the values array. <a href="#1fdb4121e6a385dd52e6599338019ce7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Derived class of <a class="el" href="classost_1_1_command_option.html">CommandOption</a> for options that have a value associated with them.
<p>
Classes <a class="el" href="classost_1_1_command_option_rest.html">CommandOptionRest</a> and <a class="el" href="classost_1_1_command_option_arg.html">CommandOptionArg</a> derive from this class.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="874400acc8820fe88023245903b471a8"></a><!-- doxytag: member="ost::CommandOptionWithArg::CommandOptionWithArg" ref="874400acc8820fe88023245903b471a8" args="(const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::CommandOptionWithArg::CommandOptionWithArg </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>inOptionName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>inOptionLetter</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>inDescription</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classost_1_1_command_option.html#b56f222627bb3843d2b055d42ceaa493">OptionType</a> </td>
<td class="mdname" nowrap> <em>inOptionType</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>inRequired</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classost_1_1_command_option.html">CommandOption</a> ** </td>
<td class="mdname" nowrap> <em>ppNext</em> = <code>&<a class="el" href="namespaceost.html#3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a></code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a> contructor.
<p>
Note the default values for required and ppNext.<p>
<dl compact><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>inOptionType</em> </td><td>the type of this 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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2405c8615aef3b4503ead25d4e687b7"></a><!-- doxytag: member="ost::CommandOptionWithArg::~CommandOptionWithArg" ref="a2405c8615aef3b4503ead25d4e687b7" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::CommandOptionWithArg::~CommandOptionWithArg </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7e012538193acafda06b609dc1dee369"></a><!-- doxytag: member="ost::CommandOptionWithArg::foundOption" ref="7e012538193acafda06b609dc1dee369" args="(CommandOptionParse *cop, const char **value, int num)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::CommandOptionWithArg::foundOption </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * </td>
<td class="mdname" nowrap> <em>cop</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char ** </td>
<td class="mdname" nowrap> <em>value</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>num</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_command_option.html#c6597549063ded15f8d50d72e8cd9bf6">ost::CommandOption</a>. </td>
</tr>
</table>
<a class="anchor" name="a7a9e87b68ef493f84688355062fc9a8"></a><!-- doxytag: member="ost::CommandOptionWithArg::foundOption" ref="a7a9e87b68ef493f84688355062fc9a8" args="(CommandOptionParse *cop, const char *value=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::CommandOptionWithArg::foundOption </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * </td>
<td class="mdname" nowrap> <em>cop</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>value</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_command_option.html#70394fb2a025443e6890e0e076a94477">ost::CommandOption</a>. </td>
</tr>
</table>
<a class="anchor" name="cf0c03d84b032dab059ae219922dadde"></a><!-- doxytag: member="ost::CommandOptionWithArg::hasValue" ref="cf0c03d84b032dab059ae219922dadde" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool ost::CommandOptionWithArg::hasValue </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_command_option.html#cf1272321b17a2cbe953ce23ffa6a5e8">ost::CommandOption</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="1fdb4121e6a385dd52e6599338019ce7"></a><!-- doxytag: member="ost::CommandOptionWithArg::numValue" ref="1fdb4121e6a385dd52e6599338019ce7" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="classost_1_1_command_option_with_arg.html#1fdb4121e6a385dd52e6599338019ce7">ost::CommandOptionWithArg::numValue</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classost_1_1_number.html">Number</a> of values in the values array.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="cmdlineopt_8cpp-example.html#a22">cmdlineopt.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="5ccc2d9deb4a248d8414193385a1fc09"></a><!-- doxytag: member="ost::CommandOptionWithArg::values" ref="5ccc2d9deb4a248d8414193385a1fc09" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char** <a class="el" href="classost_1_1_command_option_with_arg.html#5ccc2d9deb4a248d8414193385a1fc09">ost::CommandOptionWithArg::values</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Array of list of values collected for this option.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="cmdlineopt_8cpp-example.html#a20">cmdlineopt.cpp</a>.</dl> </td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
