TCLAP::AnyOf Class Reference

Implements a group of arguments where any combination is possible (including all or none). More...

#include <ArgGroup.h>

Inheritance diagram for TCLAP::AnyOf:

Collaboration diagram for TCLAP::AnyOf:

Public Member Functions
	AnyOf ()
	AnyOf (CmdLineInterface &parser)
bool	validate ()
	Validates that the constraints of the ArgGroup are satisfied. More...
bool	isExclusive () const
	Returns true if this argument group is exclusive. More...
bool	isRequired () const
	Returns true if this argument group is required. More...
Public Member Functions inherited from TCLAP::ArgGroup
virtual	~ArgGroup ()
virtual ArgContainer &	add (Arg &arg)
	Add an argument to this arg group. More...
virtual ArgContainer &	add (Arg *arg)
	Add an argument to this arg group. More...
void	setParser (CmdLineInterface &parser)
	Used by the parser to connect itself to this arg group. More...
virtual bool	showAsGroup () const
	If arguments in this group should show up as grouped in help. More...
const std::string	getName () const
	Returns the argument group's name. More...
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
Public Member Functions inherited from TCLAP::ArgContainer
virtual	~ArgContainer ()

Additional Inherited Members
Public Types inherited from TCLAP::ArgGroup
typedef std::list< Arg * >	Container
typedef Container::iterator	iterator
typedef Container::const_iterator	const_iterator
Protected Member Functions inherited from TCLAP::ArgGroup
	ArgGroup ()
Protected Attributes inherited from TCLAP::ArgGroup
CmdLineInterface *	_parser
Container	_args

Detailed Description

Implements a group of arguments where any combination is possible (including all or none).

This is mostly used in case one optional argument allows additional arguments to be specified (for example [-c [-de] [-n <int>]]).

Definition at line 182 of file ArgGroup.h.

Constructor & Destructor Documentation

AnyOf() [1/2]

TCLAP::AnyOf::AnyOf ( )

inline

Definition at line 184 of file ArgGroup.h.

AnyOf() [2/2]

TCLAP::AnyOf::AnyOf ( CmdLineInterface &  parser )

inlineexplicit

Definition at line 185 of file ArgGroup.h.

References TCLAP::CmdLineInterface::add().

Here is the call graph for this function:

Member Function Documentation

isExclusive()

bool TCLAP::AnyOf::isExclusive ( ) const

inlinevirtual

Returns true if this argument group is exclusive.

Implements TCLAP::ArgGroup.

Definition at line 188 of file ArgGroup.h.

isRequired()

bool TCLAP::AnyOf::isRequired ( ) const

inlinevirtual

Returns true if this argument group is required.

Implements TCLAP::ArgGroup.

Definition at line 189 of file ArgGroup.h.

validate()

bool TCLAP::AnyOf::validate ( )

inlinevirtual

Validates that the constraints of the ArgGroup are satisfied.

Implements TCLAP::ArgGroup.

Definition at line 187 of file ArgGroup.h.

---

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

• ArgGroup.h