tclap 1.6.0
Public Member Functions | List of all members
TCLAP::EitherOf Class Reference

Implements a group of arguments where at most one can be selected. More...

#include <ArgGroup.h>

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

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from TCLAP::ArgGroup
using Container = std::list< Arg * >
 
using iterator = Container::iterator
 
using const_iterator = Container::const_iterator
 
- Protected Member Functions inherited from TCLAP::ExclusiveArgGroup
 ExclusiveArgGroup ()=default
 
 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 at most one can be selected.

Definition at line 159 of file ArgGroup.h.

Constructor & Destructor Documentation

◆ EitherOf() [1/2]

TCLAP::EitherOf::EitherOf ( )
default

◆ EitherOf() [2/2]

TCLAP::EitherOf::EitherOf ( CmdLineInterface &  parser)
inlineexplicit

Definition at line 162 of file ArgGroup.h.

Member Function Documentation

◆ isRequired()

bool TCLAP::EitherOf::isRequired ( ) const
inlineoverridevirtual

Returns true if this argument group is required.

Implements TCLAP::ArgGroup.

Definition at line 164 of file ArgGroup.h.


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