Public Member Functions
CCmdFlagOption Class Reference

Command line option that translates a string to a set of flags. More...

#include <mia/core/cmdlineparser.hh>

Inheritance diagram for CCmdFlagOption:
CCmdOption

Public Member Functions

 CCmdFlagOption (int &val, const CFlagString &map, char short_opt, const char *long_opt, const char *long_help, const char *short_help, bool flags=false)
 
- Public Member Functions inherited from CCmdOption
void add_option (CShortoptionMap &sm, CLongoptionMap &lm)
 
 CCmdOption (char short_opt, const char *long_opt, const char *long_help, const char *short_help, bool required)
 
void get_long_help (std::ostream &os) const
 
std::string get_long_help_xml (xmlpp::Element &parent, HandlerHelpMap &handler_map) const
 
const char * get_long_option () const
 
size_t get_needed_args () const
 
void get_opt_help (std::ostream &os) const
 
char get_short_option () const
 
const std::string get_value_as_string () const
 
bool is_required () const
 
const char * long_help () const
 
void post_set ()
 
void print_short_help (std::ostream &os) const
 
void set_value (const char *str_value)
 
void write_value (std::ostream &os) const
 
virtual ~CCmdOption ()
 ensure virtual destruction More...
 

Additional Inherited Members

- Static Public Attributes inherited from CCmdOption
static const bool not_required
 readability constant to show that an option is not required More...
 
static const bool required
 readability constant to show that an option is required More...
 
- Protected Member Functions inherited from CCmdOption
void clear_required ()
 clear the "required" flag More...
 

Detailed Description

Command line option that translates a string to a set of flags.

Definition at line 133 of file cmdlineparser.hh.

Constructor & Destructor Documentation

CCmdFlagOption::CCmdFlagOption ( int &  val,
const CFlagString map,
char  short_opt,
const char *  long_opt,
const char *  long_help,
const char *  short_help,
bool  flags = false 
)

Constructor of the command option

Parameters
[in,out]valvariable to hold the parsed option value - pass in the default value -
mapthe lookup table for the option
short_optshort option name (or 0)
long_optlong option name (must not be NULL)
long_helplong help string (must not be NULL)
short_helpshort help string
flagsif this is set to true, extra checking will be done weather the option is really set

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