utilmm::cmdline_option Class Reference

Public Types
enum	ArgumentType { None = 0, Optional = 1, IntArgument = 2, BoolArgument = 4, StringArgument = 8, DefaultValue = 16, None = 0, Optional = 1, IntArgument = 2, BoolArgument = 4, StringArgument = 8, DefaultValue = 16 }
enum	ArgumentType { None = 0, Optional = 1, IntArgument = 2, BoolArgument = 4, StringArgument = 8, DefaultValue = 16, None = 0, Optional = 1, IntArgument = 2, BoolArgument = 4, StringArgument = 8, DefaultValue = 16 }
Public Member Functions
bool	checkArgument (const std::string &value) const
bool	checkArgument (const std::string &value) const
	cmdline_option (const std::string &description)
	cmdline_option (const std::string &description)
int	getArgumentFlags () const
int	getArgumentFlags () const
std::string	getConfigKey () const
std::string	getConfigKey () const
std::string	getDefaultValue () const
std::string	getDefaultValue () const
std::string	getHelp () const
std::string	getHelp () const
std::string	getLong () const
std::string	getLong () const
std::string	getShort () const
std::string	getShort () const
bool	hasArgument () const
bool	hasArgument () const
bool	hasDefaultValue () const
bool	hasDefaultValue () const
bool	isArgumentOptional () const
bool	isArgumentOptional () const
bool	isMultiple () const
bool	isMultiple () const
bool	isRequired () const
bool	isRequired () const
	~cmdline_option ()
	~cmdline_option ()
Private Attributes
int	m_argument_flags
std::string	m_config
std::string	m_default
std::string	m_help
std::string	m_long
bool	m_multiple
bool	m_required
std::string	m_short

Detailed Description

Each option description is parsed and transformed in a cmdline_option object. The command_line code then uses these objects

Argument types Each option may have zero or one option the option is described using a or-ed int of this enum

Enumerator:

None
Optional	no arguments
IntArgument	the argument may be ommitted
BoolArgument	the argument is an integer
StringArgument	the argument is a boolean, that is 0, 1, 'false' or 'true'
DefaultValue	the argument is a string
None
Optional	no arguments
IntArgument	the argument may be ommitted
BoolArgument	the argument is an integer
StringArgument	the argument is a boolean, that is 0, 1, 'false' or 'true'
DefaultValue	the argument is a string

Argument types Each option may have zero or one option the option is described using a or-ed int of this enum

Enumerator:

None
Optional	no arguments
IntArgument	the argument may be ommitted
BoolArgument	the argument is an integer
StringArgument	the argument is a boolean, that is 0, 1, 'false' or 'true'
DefaultValue	the argument is a string
None
Optional	no arguments
IntArgument	the argument may be ommitted
BoolArgument	the argument is an integer
StringArgument	the argument is a boolean, that is 0, 1, 'false' or 'true'
DefaultValue	the argument is a string

utilmm::cmdline_option::cmdline_option ( const std::string & description )

Builds an option using the option description syntax as in command_line

option the option description, see the command_line for its syntax If option is not a valid description string, the constructor returns and isValid() will return false

Definition at line 31 of file commandline.cc.

utilmm::cmdline_option::~cmdline_option ( )

Definition at line 108 of file commandline.cc.

utilmm::cmdline_option::cmdline_option ( const std::string & description )

Builds an option using the option description syntax as in command_line

option the option description, see the command_line for its syntax If option is not a valid description string, the constructor returns and isValid() will return false

utilmm::cmdline_option::~cmdline_option ( )