popt::option_base Class Reference

Inheritance diagram for popt::option_base:
Inheritance graph
[legend]

Public Member Functions

 option_base (char const *option_name, char short_name, char const *help_str, char const *arg_help_str, void *data, unsigned int popt_flags)
virtual ~option_base ()
virtual void post_process ()

Protected Attributes

char const * option_name

Detailed Description

option_base - base class for implementation of a command line option

Every command line option added before calling parse_options() is of this type.

Definition at line 30 of file popt_options.cpp.


Constructor & Destructor Documentation

popt::option_base::option_base ( char const *  option_name,
char  short_name,
char const *  help_str,
char const *  arg_help_str,
void *  data,
unsigned int  popt_flags 
)

option_base - construct an option with the given options.

Parameters:
option_name name part of long form e.g. --option
short_name short form name e.g. -o
help_str short description of the option
arg_help_str short description of the argument (if any)
data a pointer to the data to fill in
popt_flags the popt library data type

Definition at line 249 of file popt_options.cpp.

References popt::options_list(), and popt::popt_options().

Here is the call graph for this function:

virtual popt::option_base::~option_base (  )  [inline, virtual]

Definition at line 45 of file popt_options.cpp.


Member Function Documentation

virtual void popt::option_base::post_process (  )  [inline, virtual]

post_process - perform any necessary post-processing

Reimplemented in popt::option_imp< void >, popt::option_imp< string >, and popt::option_imp< vector< string > >.

Definition at line 50 of file popt_options.cpp.


Field Documentation

char const* popt::option_base::option_name [protected]

Definition at line 53 of file popt_options.cpp.


The documentation for this class was generated from the following file:

Generated on 8 Nov 2012 for Oprofile by  doxygen 1.6.1