Util--  1.1
Public Types | Public Member Functions | List of all members
utilmm::cmdline_option Class Reference

#include <utilmm/configfile/commandline.hh>

Public Types

enum  ArgumentType {
  None = 0, Optional = 1, IntArgument = 2, BoolArgument = 4,
  StringArgument = 8, DefaultValue = 16
}
 

Public Member Functions

 cmdline_option (const std::string &description)
 
 ~cmdline_option ()
 
bool isMultiple () const
 
bool isRequired () const
 
std::string getConfigKey () const
 
std::string getLong () const
 
std::string getShort () const
 
std::string getHelp () const
 
int getArgumentFlags () const
 
bool hasArgument () const
 
bool isArgumentOptional () const
 
bool hasDefaultValue () const
 
std::string getDefaultValue () const
 
bool checkArgument (const std::string &value) const
 

Detailed Description

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

Member Enumeration Documentation

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

Constructor & Destructor Documentation

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 ( )

Member Function Documentation

bool utilmm::cmdline_option::checkArgument ( const std::string &  value) const

Checks that value is a valid string according to the argument type (int, bool or string)

int utilmm::cmdline_option::getArgumentFlags ( ) const
std::string utilmm::cmdline_option::getConfigKey ( ) const
std::string utilmm::cmdline_option::getDefaultValue ( ) const
std::string utilmm::cmdline_option::getHelp ( ) const
std::string utilmm::cmdline_option::getLong ( ) const
std::string utilmm::cmdline_option::getShort ( ) const
bool utilmm::cmdline_option::hasArgument ( ) const
bool utilmm::cmdline_option::hasDefaultValue ( ) const
bool utilmm::cmdline_option::isArgumentOptional ( ) const
bool utilmm::cmdline_option::isMultiple ( ) const
bool utilmm::cmdline_option::isRequired ( ) const

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

Generated on Tue Oct 9 2018 10:12:45 for Util-- by doxygen 1.8.6
SourceForge.net Project Page