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

Implements common functionality for exclusive argument groups. More...

#include <ArgGroup.h>

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

Public Member Functions

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
 
virtual bool isRequired () const =0
 Returns true if this argument group is required.
 
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
 

Protected Member Functions

 ExclusiveArgGroup ()=default
 
 ExclusiveArgGroup (CmdLineInterface &parser)
 
- Protected Member Functions inherited from TCLAP::ArgGroup
 ArgGroup ()
 

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 Attributes inherited from TCLAP::ArgGroup
CmdLineInterface * _parser
 
Container _args
 

Detailed Description

Implements common functionality for exclusive argument groups.

Definition at line 135 of file ArgGroup.h.

Constructor & Destructor Documentation

◆ ExclusiveArgGroup() [1/2]

TCLAP::ExclusiveArgGroup::ExclusiveArgGroup ( )
protecteddefault

◆ ExclusiveArgGroup() [2/2]

TCLAP::ExclusiveArgGroup::ExclusiveArgGroup ( CmdLineInterface &  parser)
inlineexplicitprotected

Definition at line 153 of file ArgGroup.h.

References TCLAP::CmdLineInterface::add().

Here is the call graph for this function:

Member Function Documentation

◆ add() [1/2]

ArgContainer & TCLAP::ExclusiveArgGroup::add ( Arg &  arg)
inlineoverridevirtual

Add an argument to this arg group.

Reimplemented from TCLAP::ArgGroup.

Definition at line 139 of file ArgGroup.h.

References add().

Referenced by add().

Here is the call graph for this function:

◆ add() [2/2]

ArgContainer & TCLAP::ExclusiveArgGroup::add ( Arg *  arg)
inlineoverridevirtual

Add an argument to this arg group.

Reimplemented from TCLAP::ArgGroup.

Definition at line 140 of file ArgGroup.h.

References TCLAP::ArgGroup::add(), TCLAP::Arg::isRequired(), and TCLAP::Arg::longID().

Here is the call graph for this function:

◆ isExclusive()

bool TCLAP::ExclusiveArgGroup::isExclusive ( ) const
inlineoverridevirtual

Returns true if this argument group is exclusive.

Implements TCLAP::ArgGroup.

Definition at line 138 of file ArgGroup.h.

◆ validate()

bool TCLAP::ExclusiveArgGroup::validate ( )
inlineoverridevirtual

Validates that the constraints of the ArgGroup are satisfied.

Implements TCLAP::ArgGroup.

Definition at line 213 of file ArgGroup.h.

References TCLAP::ArgGroup::isRequired(), and TCLAP::Arg::setBy().

Here is the call graph for this function:

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