<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: ost::CommandOptionParse Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classost_1_1_command_option_parse-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::CommandOptionParse Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<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="classost_1_1_command_option_parse.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cmdoptns_8h_source.html">cmdoptns.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac6bbdc6aaf36b83b14d91bee479f733d"><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 class="memdesc:ac6bbdc6aaf36b83b14d91bee479f733d"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor needed so that the object may be correctly deleted. <a href="#ac6bbdc6aaf36b83b14d91bee479f733d">More...</a><br/></td></tr>
<tr class="separator:ac6bbdc6aaf36b83b14d91bee479f733d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8f0828a668ba000ea6ecc4de1d2c5b3"><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 class="memdesc:af8f0828a668ba000ea6ecc4de1d2c5b3"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the error flag set if the parser encountered errors. <a href="#af8f0828a668ba000ea6ecc4de1d2c5b3">More...</a><br/></td></tr>
<tr class="separator:af8f0828a668ba000ea6ecc4de1d2c5b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2176dfc5ec12e3b4fb9f39334f5173a"><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 class="memdesc:af2176dfc5ec12e3b4fb9f39334f5173a"><td class="mdescLeft"> </td><td class="mdescRight">Return a string of text describing the list of errors encountered. <a href="#af2176dfc5ec12e3b4fb9f39334f5173a">More...</a><br/></td></tr>
<tr class="separator:af2176dfc5ec12e3b4fb9f39334f5173a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7dc375ddeff083528d143a1ffdb67e16"><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 class="memdesc:a7dc375ddeff083528d143a1ffdb67e16"><td class="mdescLeft"> </td><td class="mdescRight">Return a string that contains the usage description of this list of paramaters. <a href="#a7dc375ddeff083528d143a1ffdb67e16">More...</a><br/></td></tr>
<tr class="separator:a7dc375ddeff083528d143a1ffdb67e16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ca17c61a4e4c8f40102cfafed61702a"><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 class="memdesc:a1ca17c61a4e4c8f40102cfafed61702a"><td class="mdescLeft"> </td><td class="mdescRight">Register an error with this parser. <a href="#a1ca17c61a4e4c8f40102cfafed61702a">More...</a><br/></td></tr>
<tr class="separator:a1ca17c61a4e4c8f40102cfafed61702a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a060afd8cbb6e8395191cef1cb68520ea"><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 class="memdesc:a060afd8cbb6e8395191cef1cb68520ea"><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">More...</a><br/></td></tr>
<tr class="separator:a060afd8cbb6e8395191cef1cb68520ea"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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="section author"><dt>Author</dt><dd>Gianni Mariani <a href="#" onclick="location.href='mai'+'lto:'+'gia'+'nn'+'i@m'+'ar'+'ian'+'i.'+'ws'; return false;">giann<span style="display: none;">.nosp@m.</span>i@ma<span style="display: none;">.nosp@m.</span>riani<span style="display: none;">.nosp@m.</span>.ws</a> </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="cmdlineopt_8cpp-example.html#_a3">cmdlineopt.cpp</a>.</dd>
</dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac6bbdc6aaf36b83b14d91bee479f733d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ost::CommandOptionParse::~CommandOptionParse </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor needed so that the object may be correctly deleted. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af8f0828a668ba000ea6ecc4de1d2c5b3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::CommandOptionParse::argsHaveError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ost::CommandOptionParse::performTask </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* ost::CommandOptionParse::printErrors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* ost::CommandOptionParse::printUsage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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#a12">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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
