<!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::CommandOptionWithArg 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_with_arg.html">CommandOptionWithArg</a>
</div>
</div>
<div class="contents">
<h1>ost::CommandOptionWithArg Class Reference</h1><!-- doxytag: class="ost::CommandOptionWithArg" --><!-- doxytag: inherits="ost::CommandOption" -->
<p>Derived class of <a class="el" href="classost_1_1_command_option.html" title="CommandOption is the base class for all command line options.">CommandOption</a> for options that have a value associated with them.
<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::CommandOptionWithArg:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_command_option_with_arg.png" usemap="#ost::CommandOptionWithArg_map" alt=""/>
<map id="ost::CommandOptionWithArg_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>
</div>
</div>
<p><a href="classost_1_1_command_option_with_arg-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_with_arg.html#a874400acc8820fe88023245903b471a8">CommandOptionWithArg</a> (const char *inOptionName, const char *inOptionLetter, const char *inDescription, <a class="el" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493">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#a3b701311bbf7cf16f954820e316f5766">defaultCommandOptionList</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classost_1_1_command_option_with_arg.html" title="Derived class of CommandOption for options that have a value associated with them...">CommandOptionWithArg</a> contructor. <a href="#a874400acc8820fe88023245903b471a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#aa2405c8615aef3b4503ead25d4e687b7">~CommandOptionWithArg</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#aa7a9e87b68ef493f84688355062fc9a8">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" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#a7e012538193acafda06b609dc1dee369">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" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#acf0c03d84b032dab059ae219922dadde">hasValue</a> ()</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#a5ccc2d9deb4a248d8414193385a1fc09">values</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Array of list of values collected for this option. <a href="#a5ccc2d9deb4a248d8414193385a1fc09"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_with_arg.html#a1fdb4121e6a385dd52e6599338019ce7">numValue</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classost_1_1_number.html" title="A number manipulation class.">Number</a> of values in the values array. <a href="#a1fdb4121e6a385dd52e6599338019ce7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Derived class of <a class="el" href="classost_1_1_command_option.html" title="CommandOption is the base class for all command line options.">CommandOption</a> for options that have a value associated with them. </p>
<p>Classes <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> and <a class="el" href="classost_1_1_command_option_arg.html" title="Class for options with an argument e.g.">CommandOptionArg</a> derive from this class. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a874400acc8820fe88023245903b471a8"></a><!-- doxytag: member="ost::CommandOptionWithArg::CommandOptionWithArg" ref="a874400acc8820fe88023245903b471a8" args="(const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::CommandOptionWithArg::CommandOptionWithArg </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"><a class="el" href="classost_1_1_command_option.html#ab56f222627bb3843d2b055d42ceaa493">OptionType</a> </td>
<td class="paramname"> <em>inOptionType</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_with_arg.html" title="Derived class of CommandOption for options that have a value associated with them...">CommandOptionWithArg</a> contructor. </p>
<p>Note the default values for required and ppNext.</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>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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa2405c8615aef3b4503ead25d4e687b7"></a><!-- doxytag: member="ost::CommandOptionWithArg::~CommandOptionWithArg" ref="aa2405c8615aef3b4503ead25d4e687b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::CommandOptionWithArg::~CommandOptionWithArg </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7e012538193acafda06b609dc1dee369"></a><!-- doxytag: member="ost::CommandOptionWithArg::foundOption" ref="a7e012538193acafda06b609dc1dee369" args="(CommandOptionParse *cop, const char **value, int num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::CommandOptionWithArg::foundOption </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * </td>
<td class="paramname"> <em>cop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>num</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_command_option.html#ac6597549063ded15f8d50d72e8cd9bf6">ost::CommandOption</a>.</p>
</div>
</div>
<a class="anchor" id="aa7a9e87b68ef493f84688355062fc9a8"></a><!-- doxytag: member="ost::CommandOptionWithArg::foundOption" ref="aa7a9e87b68ef493f84688355062fc9a8" args="(CommandOptionParse *cop, const char *value=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::CommandOptionWithArg::foundOption </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> * </td>
<td class="paramname"> <em>cop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_command_option.html#a70394fb2a025443e6890e0e076a94477">ost::CommandOption</a>.</p>
</div>
</div>
<a class="anchor" id="acf0c03d84b032dab059ae219922dadde"></a><!-- doxytag: member="ost::CommandOptionWithArg::hasValue" ref="acf0c03d84b032dab059ae219922dadde" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::CommandOptionWithArg::hasValue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_command_option.html#acf1272321b17a2cbe953ce23ffa6a5e8">ost::CommandOption</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1fdb4121e6a385dd52e6599338019ce7"></a><!-- doxytag: member="ost::CommandOptionWithArg::numValue" ref="a1fdb4121e6a385dd52e6599338019ce7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classost_1_1_command_option_with_arg.html#a1fdb4121e6a385dd52e6599338019ce7">ost::CommandOptionWithArg::numValue</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classost_1_1_number.html" title="A number manipulation class.">Number</a> of values in the values array. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="cmdlineopt_8cpp-example.html#a17">cmdlineopt.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5ccc2d9deb4a248d8414193385a1fc09"></a><!-- doxytag: member="ost::CommandOptionWithArg::values" ref="a5ccc2d9deb4a248d8414193385a1fc09" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char** <a class="el" href="classost_1_1_command_option_with_arg.html#a5ccc2d9deb4a248d8414193385a1fc09">ost::CommandOptionWithArg::values</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Array of list of values collected for this option. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="cmdlineopt_8cpp-example.html#a15">cmdlineopt.cpp</a>.</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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
118
