<!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>ucommon: ucommon::shell::numericopt 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="main.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>Data Structures</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>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00129.html">shell</a>::<a class="el" href="a00136.html">numericopt</a>
</div>
</div>
<div class="contents">
<h1>ucommon::shell::numericopt Class Reference</h1><!-- doxytag: class="ucommon::shell::numericopt" --><!-- doxytag: inherits="ucommon::shell::Option" -->
<p>Numeric option for shell parsing.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00197_source.html">shell.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::shell::numericopt:</div>
<div class="dynsection">
<div class="center"><img src="a00519.png" border="0" usemap="#ucommon_1_1shell_1_1numericopt_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1shell_1_1numericopt_inherit__map" id="ucommon_1_1shell_1_1numericopt_inherit__map">
<area shape="rect" id="node2" href="a00137.html" title="A base class used to create parsable shell options." alt="" coords="25,229,268,256"/><area shape="rect" id="node4" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="25,155,268,181"/><area shape="rect" id="node6" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="31,80,263,107"/><area shape="rect" id="node8" href="a00095.html" title="A common base class for all managed objects." alt="" coords="21,5,272,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::shell::numericopt:</div>
<div class="dynsection">
<div class="center"><img src="a00520.png" border="0" usemap="#ucommon_1_1shell_1_1numericopt_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1shell_1_1numericopt_coll__map" id="ucommon_1_1shell_1_1numericopt_coll__map">
<area shape="rect" id="node2" href="a00137.html" title="A base class used to create parsable shell options." alt="" coords="25,253,268,280"/><area shape="rect" id="node4" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="25,176,268,203"/><area shape="rect" id="node6" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="31,91,263,117"/><area shape="rect" id="node8" href="a00095.html" title="A common base class for all managed objects." alt="" coords="21,5,272,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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"><a class="anchor" id="ae9beda454685f4c7bb80e0a76181c10d"></a><!-- doxytag: member="ucommon::shell::numericopt::numericopt" ref="ae9beda454685f4c7bb80e0a76181c10d" args="(char short_option, char *long_option=((void *) 0), char *help=((void *) 0), char *type="numeric", long def_value=0)" -->
</td><td class="memItemRight" valign="bottom"><b>numericopt</b> (char short_option, char *long_option=((void *) 0), char *help=((void *) 0), char *type="numeric", long def_value=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a065262674add9f52a04a2715a87a6d37"></a><!-- doxytag: member="ucommon::shell::numericopt::operator bool" ref="a065262674add9f52a04a2715a87a6d37" args="()" -->
</td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e6c56d7fd106b34668bed1ef18b8f7f"></a><!-- doxytag: member="ucommon::shell::numericopt::operator long" ref="a1e6c56d7fd106b34668bed1ef18b8f7f" args="()" -->
</td><td class="memItemRight" valign="bottom"><b>operator long</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4eb7d5ed38b572de5ccdcff5733700b6"></a><!-- doxytag: member="ucommon::shell::numericopt::operator!" ref="a4eb7d5ed38b572de5ccdcff5733700b6" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator!</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab800442bf7ac2e1b62462113b9b99fcd"></a><!-- doxytag: member="ucommon::shell::numericopt::operator*" ref="ab800442bf7ac2e1b62462113b9b99fcd" args="()" -->
long </td><td class="memItemRight" valign="bottom"><b>operator*</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a8b75747571f1eafa083662ff2d29c2"></a><!-- doxytag: member="ucommon::shell::numericopt::set" ref="a9a8b75747571f1eafa083662ff2d29c2" args="(long value)" -->
void </td><td class="memItemRight" valign="bottom"><b>set</b> (long value)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html#ad82b62e7d78a2e8c17172a51412dbbeb">assign</a> (char *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to send option into derived receiver. <a href="#ad82b62e7d78a2e8c17172a51412dbbeb"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec6f031963f407e78b9863c59f0e1e11"></a><!-- doxytag: member="ucommon::shell::numericopt::number" ref="aec6f031963f407e78b9863c59f0e1e11" args="" -->
long </td><td class="memItemRight" valign="bottom"><b>number</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Numeric option for shell parsing. </p>
<p>This offers a quick-use class to parse a shell flag, along with a numeric value that may be saved and a use counter, as multiple invocations is an error. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00197_source.html#l00495">495</a> of file <a class="el" href="a00197_source.html">shell.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad82b62e7d78a2e8c17172a51412dbbeb"></a><!-- doxytag: member="ucommon::shell::numericopt::assign" ref="ad82b62e7d78a2e8c17172a51412dbbeb" args="(char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual char* ucommon::shell::numericopt::assign </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to send option into derived receiver. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>option that was received. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL or error string to use. </dd></dl>
<p>Implements <a class="el" href="a00137.html#aa44b7ed754b92370aed1a686f54b478e">ucommon::shell::Option</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00197_source.html">shell.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:00 2011 for ucommon 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
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
4f5f2dc0f55b453456458df885792b0b
>
files
>
309
