ecl::SwitchArg Class Reference

#include <switch_arg.hpp>

Inheritance diagram for ecl::SwitchArg:

List of all members.

Public Member Functions
bool	combinedSwitchesMatch (std::string &combined)
bool	getValue ()
virtual bool	processArg (int *i, std::vector< std::string > &args)
	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)
Protected Attributes
bool	_value

---

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 31 of file switch_arg.hpp.

---

Constructor & Destructor Documentation

ecl::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 108 of file switch_arg.hpp.

ecl::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 117 of file switch_arg.hpp.

---

Member Function Documentation

bool ecl::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 131 of file switch_arg.hpp.

bool ecl::SwitchArg::getValue

(

)

[inline]

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

Reimplemented in ecl::MultiSwitchArg.

Definition at line 129 of file switch_arg.hpp.

bool ecl::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 ecl::Arg.

Reimplemented in ecl::MultiSwitchArg.

Definition at line 160 of file switch_arg.hpp.

---

Member Data Documentation

bool ecl::SwitchArg::_value [protected]

The value of the switch.

Reimplemented in ecl::MultiSwitchArg.

Definition at line 38 of file switch_arg.hpp.

---

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

• switch_arg.hpp