tclap  1.4.0
Public Member Functions | List of all members
TCLAP::OneOf Class Reference

Implements a group of arguments where exactly one must be selected. More...

#include <ArgGroup.h>

Inheritance diagram for TCLAP::OneOf:
Inheritance graph
[legend]
Collaboration diagram for TCLAP::OneOf:
Collaboration graph
[legend]

Public Member Functions

 OneOf ()
 
 OneOf (CmdLineInterface &parser)
 
bool isRequired () const
 Returns true if this argument group is required. More...
 
- Public Member Functions inherited from TCLAP::ExclusiveArgGroup
bool validate ()
 Validates that the constraints of the ArgGroup are satisfied. More...
 
bool isExclusive () const
 Returns true if this argument group is exclusive. More...
 
ArgContaineradd (Arg &arg)
 Add an argument to this arg group. More...
 
ArgContaineradd (Arg *arg)
 Add an argument to this arg group. More...
 
- Public Member Functions inherited from TCLAP::ArgGroup
virtual ~ArgGroup ()
 
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::ExclusiveArgGroup
 ExclusiveArgGroup ()
 
 ExclusiveArgGroup (CmdLineInterface &parser)
 
- 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 exactly one must be selected.

This corresponds to the deprecated "xoradd".

Definition at line 168 of file ArgGroup.h.

Constructor & Destructor Documentation

◆ OneOf() [1/2]

TCLAP::OneOf::OneOf ( )
inline

Definition at line 170 of file ArgGroup.h.

◆ OneOf() [2/2]

TCLAP::OneOf::OneOf ( CmdLineInterface parser)
inlineexplicit

Definition at line 171 of file ArgGroup.h.

Member Function Documentation

◆ isRequired()

bool TCLAP::OneOf::isRequired ( ) const
inlinevirtual

Returns true if this argument group is required.

Implements TCLAP::ArgGroup.

Definition at line 173 of file ArgGroup.h.


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