<!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::CommandOptionParse 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_parse.html">CommandOptionParse</a>
</div>
</div>
<div class="contents">
<h1>ost::CommandOptionParse Class Reference</h1><!-- doxytag: class="ost::CommandOptionParse" -->
<p>This is the <a class="el" href="classost_1_1_command_option_parse.html" title="This is the CommandOptionParse interface class.">CommandOptionParse</a> interface class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cmdoptns_8h_source.html">cmdoptns.h</a>></code></p>
<p><a href="classost_1_1_command_option_parse-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_parse.html#ac6bbdc6aaf36b83b14d91bee479f733d">~CommandOptionParse</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor needed so that the object may be correctly deleted. <a href="#ac6bbdc6aaf36b83b14d91bee479f733d"></a><br/></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_parse.html#af8f0828a668ba000ea6ecc4de1d2c5b3">argsHaveError</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the error flag set if the parser encountered errors. <a href="#af8f0828a668ba000ea6ecc4de1d2c5b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_parse.html#af2176dfc5ec12e3b4fb9f39334f5173a">printErrors</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string of text describing the list of errors encountered. <a href="#af2176dfc5ec12e3b4fb9f39334f5173a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_parse.html#a7dc375ddeff083528d143a1ffdb67e16">printUsage</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string that contains the usage description of this list of paramaters. <a href="#a7dc375ddeff083528d143a1ffdb67e16"></a><br/></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_parse.html#a1ca17c61a4e4c8f40102cfafed61702a">registerError</a> (const char *errMsg)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register an error with this parser. <a href="#a1ca17c61a4e4c8f40102cfafed61702a"></a><br/></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_parse.html#a060afd8cbb6e8395191cef1cb68520ea">performTask</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The method should be invoked by the main code once it has determined that the application should be started. <a href="#a060afd8cbb6e8395191cef1cb68520ea"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is the <a class="el" href="classost_1_1_command_option_parse.html" title="This is the CommandOptionParse interface class.">CommandOptionParse</a> interface class. </p>
<p>To implement this object you can call <a class="el" href="namespaceost.html#a282d97c4c4323467d6e8b82cb93ec89d" title="makeCommandOptionParse will create an implementation of a CommandOptionParse object...">makeCommandOptionParse()</a>; This will instantiate a dynamically allocated version of this class and parse the command line for the list of command options that are passed in.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Gianni Mariani <<a href="mailto:gianni@mariani.ws">gianni@mariani.ws</a>> </dd></dl>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="cmdlineopt_8cpp-example.html#_a3">cmdlineopt.cpp</a>.</p>
</dd>
</dl><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac6bbdc6aaf36b83b14d91bee479f733d"></a><!-- doxytag: member="ost::CommandOptionParse::~CommandOptionParse" ref="ac6bbdc6aaf36b83b14d91bee479f733d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::CommandOptionParse::~CommandOptionParse </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual destructor needed so that the object may be correctly deleted. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af8f0828a668ba000ea6ecc4de1d2c5b3"></a><!-- doxytag: member="ost::CommandOptionParse::argsHaveError" ref="af8f0828a668ba000ea6ecc4de1d2c5b3" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::CommandOptionParse::argsHaveError </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the value of the error flag set if the parser encountered errors. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="cmdlineopt_8cpp-example.html#a6">cmdlineopt.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a060afd8cbb6e8395191cef1cb68520ea"></a><!-- doxytag: member="ost::CommandOptionParse::performTask" ref="a060afd8cbb6e8395191cef1cb68520ea" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::CommandOptionParse::performTask </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The method should be invoked by the main code once it has determined that the application should be started. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="cmdlineopt_8cpp-example.html#a8">cmdlineopt.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="af2176dfc5ec12e3b4fb9f39334f5173a"></a><!-- doxytag: member="ost::CommandOptionParse::printErrors" ref="af2176dfc5ec12e3b4fb9f39334f5173a" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* ost::CommandOptionParse::printErrors </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a string of text describing the list of errors encountered. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="cmdlineopt_8cpp-example.html#a7">cmdlineopt.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7dc375ddeff083528d143a1ffdb67e16"></a><!-- doxytag: member="ost::CommandOptionParse::printUsage" ref="a7dc375ddeff083528d143a1ffdb67e16" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* ost::CommandOptionParse::printUsage </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a string that contains the usage description of this list of paramaters. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="cmdlineopt_8cpp-example.html#a5">cmdlineopt.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1ca17c61a4e4c8f40102cfafed61702a"></a><!-- doxytag: member="ost::CommandOptionParse::registerError" ref="a1ca17c61a4e4c8f40102cfafed61702a" args="(const char *errMsg)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::CommandOptionParse::registerError </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>errMsg</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register an error with this parser. </p>
<p>This string will be appended to the errors already buffered in this object. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="cmdlineopt_8cpp-example.html#a13">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
>
113
