Sophie

Sophie

distrib > Mandriva > 2007.0 > i586 > by-pkgid > ad1ba1135a9c9eeffc2e538163e00373 > files > 641

libCommonC++2_1.4-devel-1.4.1-1mdv2007.0.i586.rpm

\section{ost::Command\-Option\-With\-Arg Class Reference}
\label{classost_1_1_command_option_with_arg}\index{ost::CommandOptionWithArg@{ost::CommandOptionWithArg}}
Derived class of {\bf Command\-Option}{\rm (p.\,\pageref{classost_1_1_command_option})} for options that have a value associated with them.  


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

Inheritance diagram for ost::Command\-Option\-With\-Arg::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3cm]{classost_1_1_command_option_with_arg}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Command\-Option\-With\-Arg} (const char $\ast$in\-Option\-Name, const char $\ast$in\-Option\-Letter, const char $\ast$in\-Description, {\bf Option\-Type} in\-Option\-Type, bool in\-Required=false, {\bf Command\-Option} $\ast$$\ast$pp\-Next=\&{\bf default\-Command\-Option\-List})
\begin{CompactList}\small\item\em {\bf Command\-Option\-With\-Arg}{\rm (p.\,\pageref{classost_1_1_command_option_with_arg})} contructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Command\-Option\-With\-Arg} ()
\item 
virtual void {\bf found\-Option} ({\bf Command\-Option\-Parse} $\ast$cop, const char $\ast$value=0)
\item 
virtual void {\bf found\-Option} ({\bf Command\-Option\-Parse} $\ast$cop, const char $\ast$$\ast$value, int num)
\item 
virtual bool {\bf has\-Value} ()
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
const char $\ast$$\ast$ {\bf values}
\begin{CompactList}\small\item\em Array of list of values collected for this option. \item\end{CompactList}\item 
int {\bf num\-Value}
\begin{CompactList}\small\item\em {\bf Number}{\rm (p.\,\pageref{classost_1_1_number})} of values in the values array. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Derived class of {\bf Command\-Option}{\rm (p.\,\pageref{classost_1_1_command_option})} for options that have a value associated with them. 

Classes {\bf Command\-Option\-Rest}{\rm (p.\,\pageref{classost_1_1_command_option_rest})} and {\bf Command\-Option\-Arg}{\rm (p.\,\pageref{classost_1_1_command_option_arg})} derive from this class. 



\subsection{Constructor \& Destructor Documentation}
\index{ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}!CommandOptionWithArg@{CommandOptionWithArg}}
\index{CommandOptionWithArg@{CommandOptionWithArg}!ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Command\-Option\-With\-Arg::Command\-Option\-With\-Arg (const char $\ast$ {\em in\-Option\-Name}, const char $\ast$ {\em in\-Option\-Letter}, const char $\ast$ {\em in\-Description}, {\bf Option\-Type} {\em in\-Option\-Type}, bool {\em in\-Required} = {\tt false}, {\bf Command\-Option} $\ast$$\ast$ {\em pp\-Next} = {\tt \&{\bf default\-Command\-Option\-List}})}\label{classost_1_1_command_option_with_arg_874400acc8820fe88023245903b471a8}


{\bf Command\-Option\-With\-Arg}{\rm (p.\,\pageref{classost_1_1_command_option_with_arg})} contructor. 

Note the default values for required and pp\-Next.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em in\-Option\-Name}]long option name \item[{\em in\-Option\-Letter}]short letter name \item[{\em in\-Description}]short description of the option \item[{\em in\-Option\-Type}]the type of this option \item[{\em in\-Required}]true if option is required \item[{\em pp\-Next}]the linked list header \end{description}
\end{Desc}
\index{ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}!~CommandOptionWithArg@{$\sim$CommandOptionWithArg}}
\index{~CommandOptionWithArg@{$\sim$CommandOptionWithArg}!ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::Command\-Option\-With\-Arg::$\sim$Command\-Option\-With\-Arg ()\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_command_option_with_arg_a2405c8615aef3b4503ead25d4e687b7}




\subsection{Member Function Documentation}
\index{ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}!foundOption@{foundOption}}
\index{foundOption@{foundOption}!ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Command\-Option\-With\-Arg::found\-Option ({\bf Command\-Option\-Parse} $\ast$ {\em cop}, const char $\ast$$\ast$ {\em value}, int {\em num})\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_command_option_with_arg_7e012538193acafda06b609dc1dee369}




Reimplemented from {\bf ost::Command\-Option} {\rm (p.\,\pageref{classost_1_1_command_option_c6597549063ded15f8d50d72e8cd9bf6})}.\index{ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}!foundOption@{foundOption}}
\index{foundOption@{foundOption}!ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Command\-Option\-With\-Arg::found\-Option ({\bf Command\-Option\-Parse} $\ast$ {\em cop}, const char $\ast$ {\em value} = {\tt 0})\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_command_option_with_arg_a7a9e87b68ef493f84688355062fc9a8}




Reimplemented from {\bf ost::Command\-Option} {\rm (p.\,\pageref{classost_1_1_command_option_70394fb2a025443e6890e0e076a94477})}.\index{ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}!hasValue@{hasValue}}
\index{hasValue@{hasValue}!ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::Command\-Option\-With\-Arg::has\-Value ()\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_command_option_with_arg_cf0c03d84b032dab059ae219922dadde}




Reimplemented from {\bf ost::Command\-Option} {\rm (p.\,\pageref{classost_1_1_command_option_cf1272321b17a2cbe953ce23ffa6a5e8})}.

\subsection{Member Data Documentation}
\index{ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}!numValue@{numValue}}
\index{numValue@{numValue}!ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf ost::Command\-Option\-With\-Arg::num\-Value}}\label{classost_1_1_command_option_with_arg_1fdb4121e6a385dd52e6599338019ce7}


{\bf Number}{\rm (p.\,\pageref{classost_1_1_number})} of values in the values array. 

\begin{Desc}
\item[Examples: ]\par
{\bf cmdlineopt.cpp}.\end{Desc}
\index{ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}!values@{values}}
\index{values@{values}!ost::CommandOptionWithArg@{ost::Command\-Option\-With\-Arg}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$$\ast$ {\bf ost::Command\-Option\-With\-Arg::values}}\label{classost_1_1_command_option_with_arg_5ccc2d9deb4a248d8414193385a1fc09}


Array of list of values collected for this option. 

\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}