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

Groups arguments for presentation without imposing a selection rule. More...

#include <ArgGroup.h>

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

Public Member Functions

 AnyOf ()=default
 
 AnyOf (CmdLineInterface &parser)
 
bool validate () override
 Validates that the constraints of the ArgGroup are satisfied.
 
bool isExclusive () const override
 Returns true if this argument group is exclusive.
 
bool isRequired () const override
 Returns true if this argument group is required.
 
- Public Member Functions inherited from TCLAP::ArgGroup
 ~ArgGroup () override=default
 
ArgContainer & add (Arg &arg) override
 Add an argument to this arg group.
 
ArgContainer & add (Arg *arg) override
 Add an argument to this arg group.
 
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::ArgGroup
 ArgGroup ()
 
- Protected Attributes inherited from TCLAP::ArgGroup
CmdLineInterface * _parser
 
Container _args
 

Detailed Description

Groups arguments for presentation without imposing a selection rule.

Any combination of members may be selected, subject to each argument's own requirements. This group does not enforce conditional dependencies; applications must check any additional dependencies themselves.

Definition at line 185 of file ArgGroup.h.

Constructor & Destructor Documentation

◆ AnyOf() [1/2]

TCLAP::AnyOf::AnyOf ( )
default

◆ AnyOf() [2/2]

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

Definition at line 188 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
inlineoverridevirtual

Returns true if this argument group is exclusive.

Implements TCLAP::ArgGroup.

Definition at line 191 of file ArgGroup.h.

◆ isRequired()

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

Returns true if this argument group is required.

Implements TCLAP::ArgGroup.

Definition at line 192 of file ArgGroup.h.

◆ validate()

bool TCLAP::AnyOf::validate ( )
inlineoverridevirtual

Validates that the constraints of the ArgGroup are satisfied.

Implements TCLAP::ArgGroup.

Definition at line 190 of file ArgGroup.h.


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