#include <SwitchArg.h>

Inheritance diagram for TCLAP::SwitchArg:

Public Member Functions
bool	combinedSwitchesMatch (std::string &combined)

bool	getValue ()

virtual bool	processArg (int *i, std::vector< std::string > &args)

virtual void	reset ()

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

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

Public Member Functions inherited from TCLAP::Arg
bool	_hasBlanks (const std::string &s) const

virtual bool	acceptsMultipleValues ()

virtual void	addToList (std::list< Arg * > &argList) const

virtual bool	allowMore ()

virtual bool	argMatches (const std::string &s) const

void	forceRequired ()

std::string	getDescription () const

const std::string &	getFlag () const

const std::string &	getName () const

bool	isIgnoreable () const

virtual bool	isRequired () const

bool	isSet () const

bool	isValueRequired () const

virtual std::string	longID (const std::string &valueId="val") const

virtual bool	operator== (const Arg &a) const

void	setRequireLabel (const std::string &s)

virtual std::string	shortID (const std::string &valueId="val") const

virtual std::string	toString () const

virtual void	trimFlag (std::string &flag, std::string &value) const

void	xorSet ()

virtual	~Arg ()

Protected Attributes
bool	_default

bool	_value

Protected Attributes inherited from TCLAP::Arg
bool	_acceptsMultipleValues

bool	_alreadySet

std::string	_description

std::string	_flag

bool	_ignoreable

std::string	_name

bool	_required

std::string	_requireLabel

bool	_valueRequired

Visitor *	_visitor

bool	_xorSet

Private Member Functions
void	commonProcessing ()

bool	lastCombined (std::string &combined)

Additional Inherited Members
Static Public Member Functions inherited from TCLAP::Arg
static void	beginIgnoring ()

static char	blankChar ()

static char	delimiter ()

static char	flagStartChar ()

static const std::string	flagStartString ()

static const std::string	ignoreNameString ()

static bool	ignoreRest ()

static const std::string	nameStartString ()

static void	setDelimiter (char c)

Protected Member Functions inherited from TCLAP::Arg
void	_checkWithVisitor () const

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

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.

Definition at line 39 of file SwitchArg.h.

Constructor & Destructor Documentation

TCLAP::SwitchArg::SwitchArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	def = `false`,
		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.

Definition at line 135 of file SwitchArg.h.

TCLAP::SwitchArg::SwitchArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		CmdLineInterface &	parser,
		bool	def = `false`,
		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.

Definition at line 145 of file SwitchArg.h.

Member Function Documentation

bool TCLAP::SwitchArg::combinedSwitchesMatch ( std::string & combined )

inline

Checks a string to see if any of the chars in the string match the flag for this Switch.

Definition at line 169 of file SwitchArg.h.

void TCLAP::SwitchArg::commonProcessing ( )

inlineprivate

Does the common processing of processArg.

Definition at line 204 of file SwitchArg.h.

bool TCLAP::SwitchArg::getValue ( )

inline

Returns bool, whether or not the switch has been set.

Definition at line 158 of file SwitchArg.h.

bool TCLAP::SwitchArg::lastCombined ( std::string & combined )

inlineprivate

Checks to see if we've found the last match in a combined string.

Definition at line 160 of file SwitchArg.h.

bool TCLAP::SwitchArg::processArg	(	int *	i,
		std::vector< std::string > &	args
	)

inlinevirtual

Handles the processing of the argument. This re-implements the Arg version of this method to set the _value of the argument appropriately.

Parameters

i	- Pointer the the current argument in the list.
args	- Mutable list of strings. Passed in from main().

Implements TCLAP::Arg.

Reimplemented in TCLAP::MultiSwitchArg.

Definition at line 223 of file SwitchArg.h.

void TCLAP::SwitchArg::reset ( void )

inlinevirtual

Clears the Arg object and allows it to be reused by new command lines.

Reimplemented from TCLAP::Arg.

Reimplemented in TCLAP::MultiSwitchArg.

Definition at line 255 of file SwitchArg.h.

Member Data Documentation

bool TCLAP::SwitchArg::_default

protected

Used to support the reset() method so that ValueArg can be reset to their constructed value.

Definition at line 52 of file SwitchArg.h.

bool TCLAP::SwitchArg::_value

protected

The value of the switch.

Definition at line 46 of file SwitchArg.h.

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

SwitchArg.h

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation