clockUtils::argParser::Parser Class Reference

class handling all known variables being able to be parsed and offering parse functionality More...

#include <Parser.h>

Static Public Member Functions
static ClockError	parseArguments (const char **argv, int argc)
	parses argument line More...
static ClockError	parseArguments (char **argv, int argc)
	parses argument line More...
static std::string	getLastParserError ()
	returns last error or empty string More...
static void	registerArgumentsVector (std::vector< std::string > *args)
	registers a vector for arguments at end of input More...
static void	setErrorOnFlag (bool b)
	sets bool determining whether an error shall occure if an extra flag is given that wasn't registered More...
static bool	wasHelpSet ()
	returns true if –help was found in argument line More...
static std::string	getHelpText ()
	returns help text as string More...
static void	addHelpTextLine (const std::pair< std::string, std::string > &line)
	add a line for help text More...

Friends
class	BasicVariable

Detailed Description

class handling all known variables being able to be parsed and offering parse functionality

Definition at line 43 of file Parser.h.

Member Function Documentation

addHelpTextLine()

static void clockUtils::argParser::Parser::addHelpTextLine ( const std::pair< std::string, std::string > &  line )

inlinestatic

add a line for help text

Definition at line 97 of file Parser.h.

getHelpText()

static std::string clockUtils::argParser::Parser::getHelpText ( )

static

returns help text as string

getLastParserError()

static std::string clockUtils::argParser::Parser::getLastParserError ( )

static

returns last error or empty string

parseArguments() [1/2]

static ClockError clockUtils::argParser::Parser::parseArguments ( const char **  argv, int  argc  )

static

parses argument line

Parameters

[in]	argv	list of all strings in the argument line
[in]	argc	amount of entries in the list

parseArguments() [2/2]

static ClockError clockUtils::argParser::Parser::parseArguments ( char **  argv, int  argc  )

inlinestatic

parses argument line

Parameters

[in]	argv	list of all strings in the argument line
[in]	argc	amount of entries in the list

Definition at line 59 of file Parser.h.

registerArgumentsVector()

static void clockUtils::argParser::Parser::registerArgumentsVector ( std::vector< std::string > *  args )

inlinestatic

registers a vector for arguments at end of input

Definition at line 71 of file Parser.h.

setErrorOnFlag()

static void clockUtils::argParser::Parser::setErrorOnFlag ( bool  b )

inlinestatic

sets bool determining whether an error shall occure if an extra flag is given that wasn't registered

Definition at line 78 of file Parser.h.

wasHelpSet()

static bool clockUtils::argParser::Parser::wasHelpSet ( )

inlinestatic

returns true if –help was found in argument line

Definition at line 85 of file Parser.h.

Friends And Related Function Documentation

BasicVariable

friend class BasicVariable

friend

Definition at line 44 of file Parser.h.

---

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

• Parser.h