\section{ost::Command\-Option\-Parse Class Reference}
\label{classost_1_1_command_option_parse}\index{ost::CommandOptionParse@{ost::CommandOptionParse}}
This is the {\bf Command\-Option\-Parse}{\rm (p.\,\pageref{classost_1_1_command_option_parse})} interface class.  


{\tt \#include $<$cmdoptns.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
virtual {\bf $\sim$Command\-Option\-Parse} ()=0
\begin{CompactList}\small\item\em Virtual destructor needed so that the object may be correctly deleted. \item\end{CompactList}\item 
virtual bool {\bf args\-Have\-Error} ()=0
\begin{CompactList}\small\item\em Get the value of the error flag set if the parser encountered errors. \item\end{CompactList}\item 
virtual const char $\ast$ {\bf print\-Errors} ()=0
\begin{CompactList}\small\item\em Return a string of text describing the list of errors encountered. \item\end{CompactList}\item 
virtual const char $\ast$ {\bf print\-Usage} ()=0
\begin{CompactList}\small\item\em Return a string that contains the usage description of this list of paramaters. \item\end{CompactList}\item 
virtual void {\bf register\-Error} (const char $\ast$err\-Msg)=0
\begin{CompactList}\small\item\em Register an error with this parser. \item\end{CompactList}\item 
virtual void {\bf perform\-Task} ()=0
\begin{CompactList}\small\item\em The method should be invoked by the main code once it has determined that the application should be started. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
This is the {\bf Command\-Option\-Parse}{\rm (p.\,\pageref{classost_1_1_command_option_parse})} interface class. 

To implement this object you can call {\bf make\-Command\-Option\-Parse()}{\rm (p.\,\pageref{namespaceost_9c8722a3e68ba930b72211f47eacc5eb})}; 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.

\begin{Desc}
\item[Author:]Gianni Mariani $<${\tt gianni@mariani.ws}$>$ \end{Desc}
\begin{Desc}
\item[Examples: ]\par


{\bf cmdlineopt.cpp}.\end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{ost::CommandOptionParse@{ost::Command\-Option\-Parse}!~CommandOptionParse@{$\sim$CommandOptionParse}}
\index{~CommandOptionParse@{$\sim$CommandOptionParse}!ost::CommandOptionParse@{ost::Command\-Option\-Parse}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::Command\-Option\-Parse::$\sim$Command\-Option\-Parse ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classost_1_1_command_option_parse_c6bbdc6aaf36b83b14d91bee479f733d}


Virtual destructor needed so that the object may be correctly deleted. 



\subsection{Member Function Documentation}
\index{ost::CommandOptionParse@{ost::Command\-Option\-Parse}!argsHaveError@{argsHaveError}}
\index{argsHaveError@{argsHaveError}!ost::CommandOptionParse@{ost::Command\-Option\-Parse}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::Command\-Option\-Parse::args\-Have\-Error ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classost_1_1_command_option_parse_f8f0828a668ba000ea6ecc4de1d2c5b3}


Get the value of the error flag set if the parser encountered errors. 

\begin{Desc}
\item[Examples: ]\par
{\bf cmdlineopt.cpp}.\end{Desc}
\index{ost::CommandOptionParse@{ost::Command\-Option\-Parse}!performTask@{performTask}}
\index{performTask@{performTask}!ost::CommandOptionParse@{ost::Command\-Option\-Parse}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Command\-Option\-Parse::perform\-Task ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classost_1_1_command_option_parse_060afd8cbb6e8395191cef1cb68520ea}


The method should be invoked by the main code once it has determined that the application should be started. 

\begin{Desc}
\item[Examples: ]\par
{\bf cmdlineopt.cpp}.\end{Desc}
\index{ost::CommandOptionParse@{ost::Command\-Option\-Parse}!printErrors@{printErrors}}
\index{printErrors@{printErrors}!ost::CommandOptionParse@{ost::Command\-Option\-Parse}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual const char$\ast$ ost::Command\-Option\-Parse::print\-Errors ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classost_1_1_command_option_parse_f2176dfc5ec12e3b4fb9f39334f5173a}


Return a string of text describing the list of errors encountered. 

\begin{Desc}
\item[Examples: ]\par
{\bf cmdlineopt.cpp}.\end{Desc}
\index{ost::CommandOptionParse@{ost::Command\-Option\-Parse}!printUsage@{printUsage}}
\index{printUsage@{printUsage}!ost::CommandOptionParse@{ost::Command\-Option\-Parse}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual const char$\ast$ ost::Command\-Option\-Parse::print\-Usage ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classost_1_1_command_option_parse_7dc375ddeff083528d143a1ffdb67e16}


Return a string that contains the usage description of this list of paramaters. 

\begin{Desc}
\item[Examples: ]\par
{\bf cmdlineopt.cpp}.\end{Desc}
\index{ost::CommandOptionParse@{ost::Command\-Option\-Parse}!registerError@{registerError}}
\index{registerError@{registerError}!ost::CommandOptionParse@{ost::Command\-Option\-Parse}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Command\-Option\-Parse::register\-Error (const char $\ast$ {\em err\-Msg})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classost_1_1_command_option_parse_1ca17c61a4e4c8f40102cfafed61702a}


Register an error with this parser. 

This string will be appended to the errors already buffered in this object. \begin{Desc}
\item[Examples: ]\par
{\bf cmdlineopt.cpp}.\end{Desc}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf cmdoptns.h}\end{CompactItemize}