<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CommandOptionParse class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Thu Oct 4 15:32:59 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>CommandOptionParse Class Reference</h1>This is the CommandOptionParse interface class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cmdoptns_h-source.html">cmdoptns.h</a>></code>
<p>
<a href="class_commandoptionparse-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_commandoptionparse.html#a0">~CommandOptionParse</a> ()=0</td></tr>
<tr><td> </td><td><font size=-1><em>Virtual destructor needed so that the object may be correctly deleted.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="config_h.html#a17">bool</a> </td><td valign=bottom><a class="el" href="class_commandoptionparse.html#a1">ArgsHaveError</a> ()=0</td></tr>
<tr><td> </td><td><font size=-1><em>Get the value of the error flag set if the parser encountered errors.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_commandoptionparse.html#a2">PrintErrors</a> ()=0</td></tr>
<tr><td> </td><td><font size=-1><em>Return a string of text describing the list of errors encountered.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_commandoptionparse.html#a3">PrintUsage</a> ()=0</td></tr>
<tr><td> </td><td><font size=-1><em>Return a string that contains the usage description of this list of paramaters.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_commandoptionparse.html#a4">RegisterError</a> (const char *err_msg)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Register an error with this parser.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_commandoptionparse.html#a5">PerformTask</a> ()=0</td></tr>
<tr><td> </td><td><font size=-1><em>The method should be invoked by the main code once it has determined that the application should be started.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is the CommandOptionParse interface class.
<p>
To implement this object you can call <a class="el" href="cmdoptns_h.html#a1">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(s): </b><dd>
Gianni Mariani <<a href="mailto:gianni@mariani.ws">gianni@mariani.ws</a>> </dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="CommandOptionParse::~CommandOptionParse"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
CommandOptionParse::~CommandOptionParse (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></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 name="a1" doxytag="CommandOptionParse::ArgsHaveError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="config_h.html#a17">bool</a> CommandOptionParse::ArgsHaveError (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></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>
</td>
</tr>
</table>
<a name="a5" doxytag="CommandOptionParse::PerformTask"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void CommandOptionParse::PerformTask (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></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>
</td>
</tr>
</table>
<a name="a2" doxytag="CommandOptionParse::PrintErrors"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const char * CommandOptionParse::PrintErrors (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></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>
</td>
</tr>
</table>
<a name="a3" doxytag="CommandOptionParse::PrintUsage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const char * CommandOptionParse::PrintUsage (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></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>
</td>
</tr>
</table>
<a name="a4" doxytag="CommandOptionParse::RegisterError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void CommandOptionParse::RegisterError (
</b></td>
<td valign="bottom"><b>
const char * <em>err_msg</em> )<code> [pure virtual]</code>
</b></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. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cmdoptns_h-source.html">cmdoptns.h</a></ul>
<hr><address><small>Generated at Thu Oct 4 15:32:59 2001 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
117
