A multiple switch argument. More...

Inheritance diagram for TCLAP::MultiSwitchArg:

Collaboration diagram for TCLAP::MultiSwitchArg:

Public Member Functions
	MultiSwitchArg (const std::string &flag, const std::string &name, const std::string &desc, int init=0, Visitor *v=NULL)
	MultiSwitchArg constructor.
	MultiSwitchArg (const std::string &flag, const std::string &name, const std::string &desc, CmdLineInterface &parser, int init=0, Visitor *v=NULL)
	MultiSwitchArg constructor.
virtual bool	processArg (int *i, std::vector< std::string > &args)
	Handles the processing of the argument.
int	getValue ()
	Returns int, the number of times the switch has been set.
std::string	shortID (const std::string &val) const
	Returns the shortID for this Arg.
std::string	longID (const std::string &val) const
	Returns the longID for this Arg.
void	reset ()
	Clears the Arg object and allows it to be reused by new command lines.
Protected Attributes
int	_value
	The value of the switch.
int	_default
	Used to support the reset() method so that ValueArg can be reset to their constructed value.

Detailed Description

A multiple switch argument.

If the switch is set on the command line, then the getValue method will return the number of times the switch appears.

Constructor & Destructor Documentation

TCLAP::MultiSwitchArg::MultiSwitchArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		int	init = `0`,
		Visitor *	v = `NULL`
	)		`[inline]`

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.
init	- Optional. The initial/default value of this Arg. Defaults to 0.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 130 of file MultiSwitchArg.h.

TCLAP::MultiSwitchArg::MultiSwitchArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		CmdLineInterface &	parser,
		int	init = `0`,
		Visitor *	v = `NULL`
	)		`[inline]`

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
init	- Optional. The initial/default value of this Arg. Defaults to 0.
v	- An optional visitor. You probably should not use this unless you have a very good reason.