A simple switch argument. More...

Inheritance diagram for DtCmdLine::SwitchArg:

Collaboration diagram for DtCmdLine::SwitchArg:

Public Member Functions
	SwitchArg (const std::string &flag, const std::string &name, const std::string &desc, bool def, Visitor *v=NULL)
	SwitchArg constructor. More...

	SwitchArg (const std::string &flag, const std::string &name, const std::string &desc, bool def, CmdLineInterface &parser, Visitor *v=NULL)
	SwitchArg constructor. More...

virtual bool	processArg (int *i, std::vector< std::string > &args)
	Handles the processing of the argument. More...

bool	combinedSwitchesMatch (std::string &combined)
	Checks a string to see if any of the chars in the string match the flag for this Switch. More...

bool	getValue () const
	Returns bool, whether or not the switch has been set. More...

bool	getDefault () const
	Returns bool, the default value. More...

	operator bool ()
	implicit conversion to bool More...

Public Member Functions inherited from DtCmdLine::Arg
virtual	~Arg ()
	Destructor. More...

virtual void	addToList (std::list< Arg * > &argList) const
	Adds this to the specified list of Args. More...

virtual bool	operator== (const Arg &a)
	Operator ==. More...

const std::string &	getFlag () const
	Returns the argument flag. More...

const std::string &	getName () const
	Returns the argument name. More...

std::string	getDescription () const
	Returns the argument description. More...

virtual bool	isRequired () const
	Indicates whether the argument is required. More...

void	forceRequired ()
	Sets _required to true. More...

void	xorSet ()
	Sets the _alreadySet value to true. More...

bool	isValueRequired () const
	Indicates whether a value must be specified for argument. More...

bool	isSet () const
	Indicates whether the argument has already been set. More...

bool	isIgnoreable () const
	Indicates whether the argument can be ignored, if desired. More...

virtual bool	argMatches (const std::string &s) const
	A method that tests whether a string matches this argument. More...

virtual std::string	toString () const
	Returns a simple string representation of the argument. More...

virtual std::string	shortID (const std::string &valueId="val") const
	Returns a short ID for the usage. More...

virtual std::string	longID (const std::string &valueId="val") const
	Returns a long ID for the usage. More...

virtual void	trimFlag (std::string &flag, std::string &value) const
	Trims a value off of the flag. More...

bool	_hasBlanks (const std::string &s) const
	Checks whether a given string has blank chars, indicating that it is a combined SwitchArg. More...

void	setRequireLabel (const std::string &s)
	Sets the requireLabel. More...

Protected Attributes
bool	_value
	The value of the switch. More...

bool	myDefault
	The default value of the switch. More...

Protected Attributes inherited from DtCmdLine::Arg
std::string	_flag
	The single char flag used to identify the argument. More...

std::string	_name
	A single work namd indentifying the argument. More...

std::string	_description
	Description of the argument. More...

bool	_required
	Indicating whether the argument is required. More...

std::string	_requireLabel
	Label to be used in usage description. More...

bool	_valueRequired
	Indicates whether a value is required for the argument. More...

bool	_alreadySet
	Indicates whether the argument has been set. More...

Visitor *	_visitor
	A pointer to a vistitor object. More...

bool	_ignoreable
	Whether this argument can be ignored, if desired. More...

bool	_xorSet
	Indicates that the arg was set as part of an XOR and not on the command line. More...

Additional Inherited Members
Static Public Member Functions inherited from DtCmdLine::Arg
static void	beginIgnoring ()
	Begin ignoring arguments since the "--" argument was specified. More...

static bool	ignoreRest ()
	Whether to ignore the rest. More...

static char	delimiter ()
	The delimiter that separates an argument flag/name from the value. More...

static const char	blankChar ()
	The char used as a place holder when SwitchArgs are combined. More...

static const char	flagStartChar ()
	The char that indicates the beginning of a flag. More...

static const std::string	flagStartString ()
	The sting that indicates the beginning of a flag. More...

static const std::string	nameStartString ()
	The sting that indicates the beginning of a name. More...

static const std::string	ignoreNameString ()
	The name used to identify the ignore rest argument. More...

static void	setDelimiter (char c)
	Sets the delimiter for all arguments. More...

Protected Member Functions inherited from DtCmdLine::Arg
void	_checkWithVisitor () const
	Performs the special handling described by the Vistitor. More...

	Arg (const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL)
	Primary constructor. More...

Detailed Description

A simple switch argument.

If the switch is set on the command line, then the getValue method will return the opposite of the default value for the switch.

Constructor & Destructor Documentation

DtCmdLine::SwitchArg::SwitchArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	def,
		Visitor *	v = `NULL`
	)

inline

SwitchArg constructor.

Parameters

flag	- The one character flag that identifies this argument on the command line.
name	- A one word name for the argument. Can be used as a long flag on the command line.
desc	- A description of what the argument is for or does.
def	- The default value for this Switch.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

DtCmdLine::SwitchArg::SwitchArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	def,
		CmdLineInterface &	parser,
		Visitor *	v = `NULL`
	)

inline

SwitchArg constructor.

Parameters

flag	- The one character flag that identifies this argument on the command line.
name	- A one word name for the argument. Can be used as a long flag on the command line.
desc	- A description of what the argument is for or does.
parser	- A CmdLine parser object to add this Arg to
def	- The default value for this Switch.
v	- An optional visitor. You probably should not use this unless you have a very good reason.