<!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::CommandOptionParse 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_parse.html">CommandOptionParse</a></div>
<h1>ost::CommandOptionParse Class Reference</h1><!-- doxytag: class="ost::CommandOptionParse" -->This is the <a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> interface class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cmdoptns_8h-source.html">cmdoptns.h</a>></code>
<p>
<a href="classost_1_1_command_option_parse-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_parse.html#c6bbdc6aaf36b83b14d91bee479f733d">~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="#c6bbdc6aaf36b83b14d91bee479f733d"></a><br></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_parse.html#f8f0828a668ba000ea6ecc4de1d2c5b3">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="#f8f0828a668ba000ea6ecc4de1d2c5b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_parse.html#f2176dfc5ec12e3b4fb9f39334f5173a">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="#f2176dfc5ec12e3b4fb9f39334f5173a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_command_option_parse.html#7dc375ddeff083528d143a1ffdb67e16">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="#7dc375ddeff083528d143a1ffdb67e16"></a><br></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_parse.html#1ca17c61a4e4c8f40102cfafed61702a">registerError</a> (const char *errMsg)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register an error with this parser. <a href="#1ca17c61a4e4c8f40102cfafed61702a"></a><br></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_parse.html#060afd8cbb6e8395191cef1cb68520ea">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="#060afd8cbb6e8395191cef1cb68520ea"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is the <a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> interface class.
<p>
To implement this object you can call <a class="el" href="namespaceost.html#9c8722a3e68ba930b72211f47eacc5eb">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 compact><dt><b>Author:</b></dt><dd>Gianni Mariani <<a href="mailto:gianni@mariani.ws">gianni@mariani.ws</a>> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="cmdlineopt_8cpp-example.html#_a8">cmdlineopt.cpp</a>.</dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c6bbdc6aaf36b83b14d91bee479f733d"></a><!-- doxytag: member="ost::CommandOptionParse::~CommandOptionParse" ref="c6bbdc6aaf36b83b14d91bee479f733d" args="()=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 ost::CommandOptionParse::~CommandOptionParse </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Virtual destructor needed so that the object may be correctly deleted.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f8f0828a668ba000ea6ecc4de1d2c5b3"></a><!-- doxytag: member="ost::CommandOptionParse::argsHaveError" ref="f8f0828a668ba000ea6ecc4de1d2c5b3" args="()=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 bool ost::CommandOptionParse::argsHaveError </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the value of the error flag set if the parser encountered errors.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="cmdlineopt_8cpp-example.html#a11">cmdlineopt.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="060afd8cbb6e8395191cef1cb68520ea"></a><!-- doxytag: member="ost::CommandOptionParse::performTask" ref="060afd8cbb6e8395191cef1cb68520ea" args="()=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::CommandOptionParse::performTask </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The method should be invoked by the main code once it has determined that the application should be started.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="cmdlineopt_8cpp-example.html#a13">cmdlineopt.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="f2176dfc5ec12e3b4fb9f39334f5173a"></a><!-- doxytag: member="ost::CommandOptionParse::printErrors" ref="f2176dfc5ec12e3b4fb9f39334f5173a" args="()=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 const char* ost::CommandOptionParse::printErrors </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return a string of text describing the list of errors encountered.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="cmdlineopt_8cpp-example.html#a12">cmdlineopt.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="7dc375ddeff083528d143a1ffdb67e16"></a><!-- doxytag: member="ost::CommandOptionParse::printUsage" ref="7dc375ddeff083528d143a1ffdb67e16" args="()=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 const char* ost::CommandOptionParse::printUsage </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return a string that contains the usage description of this list of paramaters.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="cmdlineopt_8cpp-example.html#a10">cmdlineopt.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="1ca17c61a4e4c8f40102cfafed61702a"></a><!-- doxytag: member="ost::CommandOptionParse::registerError" ref="1ca17c61a4e4c8f40102cfafed61702a" args="(const char *errMsg)=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::CommandOptionParse::registerError </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>errMsg</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Register an error with this parser.
<p>
This string will be appended to the errors already buffered in this object. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="cmdlineopt_8cpp-example.html#a18">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>
