TCLAP::SwitchArg Class Reference

A simple switch argument. More...

#include <SwitchArg.h>

Inheritance diagram for TCLAP::SwitchArg:

[legend]Collaboration diagram for TCLAP::SwitchArg:

[legend]List of all members.

Public Member Functions
	SwitchArg (const std::string &flag, const std::string &name, const std::string &desc, bool def, Visitor *v=NULL)
	SwitchArg constructor.
	SwitchArg (const std::string &flag, const std::string &name, const std::string &desc, bool def, CmdLineInterface &parser, Visitor *v=NULL)
	SwitchArg constructor.
virtual bool	processArg (int *i, std::vector< std::string > &args)
	Handles the processing of the argument.
bool	combinedSwitchesMatch (std::string &combined)
	Checks a string to see if any of the chars in the string match the flag for this Switch.
bool	getValue ()
	Returns bool, whether or not the switch has been set.
Protected Attributes
bool	_value
	The value of the switch.

---

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

TCLAP::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.

TCLAP::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.

---

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.

bool TCLAP::SwitchArg::getValue

(

)

[inline]

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

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

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.

---

Member Data Documentation

bool TCLAP::SwitchArg::_value [protected]

The value of the switch.

---

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

• tclap/SwitchArg.h

---