Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Member Functions
TCLAP::SwitchArg Class Reference

Detailed Description

A simple switch argument.

If the switch is set on the command line, then the getValue method will return the opposite of the default value for the switch.

Definition at line 64 of file SwitchArg.h.

#include <mrpt/otherlibs/tclap/SwitchArg.h>

Inheritance diagram for TCLAP::SwitchArg:
Inheritance graph

Public Member Functions

 SwitchArg (const std::string &flag, const std::string &name, const std::string &desc, bool def=false, Visitor *v=NULL)
 SwitchArg constructor. More...
 
 SwitchArg (const std::string &flag, const std::string &name, const std::string &desc, CmdLineInterface &parser, bool def=false, Visitor *v=NULL)
 SwitchArg constructor. More...
 
virtual bool processArg (int *i, std::vector< std::string > &args)
 Handles the processing of the argument. More...
 
bool combinedSwitchesMatch (std::string &combined)
 Checks a string to see if any of the chars in the string match the flag for this Switch. More...
 
bool getValue ()
 Returns bool, whether or not the switch has been set. More...
 
virtual void addToList (std::list< Arg * > &argList) const
 Adds this to the specified list of Args. More...
 
virtual bool operator== (const Arg &a) const
 Operator ==. More...
 
const std::string & getFlag () const
 Returns the argument flag. More...
 
const std::string & getName () const
 Returns the argument name. More...
 
std::string getDescription () const
 Returns the argument description. More...
 
virtual bool isRequired () const
 Indicates whether the argument is required. More...
 
void forceRequired ()
 Sets _required to true. More...
 
void xorSet ()
 Sets the _alreadySet value to true. More...
 
bool isValueRequired () const
 Indicates whether a value must be specified for argument. More...
 
bool isSet () const
 Indicates whether the argument has already been set. More...
 
bool isIgnoreable () const
 Indicates whether the argument can be ignored, if desired. More...
 
virtual bool argMatches (const std::string &s) const
 A method that tests whether a string matches this argument. More...
 
virtual std::string toString () const
 Returns a simple string representation of the argument. More...
 
virtual std::string shortID (const std::string &valueId="val") const
 Returns a short ID for the usage. More...
 
virtual std::string longID (const std::string &valueId="val") const
 Returns a long ID for the usage. More...
 
virtual void trimFlag (std::string &flag, std::string &value) const
 Trims a value off of the flag. More...
 
bool _hasBlanks (const std::string &s) const
 Checks whether a given string has blank chars, indicating that it is a combined SwitchArg. More...
 
void setRequireLabel (const std::string &s)
 Sets the requireLabel. More...
 
virtual bool allowMore ()
 
virtual bool acceptsMultipleValues ()
 

Static Public Member Functions

static void beginIgnoring ()
 Begin ignoring arguments since the "--" argument was specified. More...
 
static bool ignoreRest ()
 Whether to ignore the rest. More...
 
static char delimiter ()
 The delimiter that separates an argument flag/name from the value. More...
 
static char blankChar ()
 The char used as a place holder when SwitchArgs are combined. More...
 
static char flagStartChar ()
 The char that indicates the beginning of a flag. More...
 
static const std::string flagStartString ()
 The sting that indicates the beginning of a flag. More...
 
static const std::string nameStartString ()
 The sting that indicates the beginning of a name. More...
 
static const std::string ignoreNameString ()
 The name used to identify the ignore rest argument. More...
 
static void setDelimiter (char c)
 Sets the delimiter for all arguments. More...
 

Protected Member Functions

void _checkWithVisitor () const
 Performs the special handling described by the Vistitor. More...
 

Protected Attributes

bool _value
 The value of the switch. More...
 
std::string _flag
 The single char flag used to identify the argument. More...
 
std::string _name
 A single work namd indentifying the argument. More...
 
std::string _description
 Description of the argument. More...
 
bool _required
 Indicating whether the argument is required. More...
 
std::string _requireLabel
 Label to be used in usage description. More...
 
bool _valueRequired
 Indicates whether a value is required for the argument. More...
 
bool _alreadySet
 Indicates whether the argument has been set. More...
 
Visitor_visitor
 A pointer to a vistitor object. More...
 
bool _ignoreable
 Whether this argument can be ignored, if desired. More...
 
bool _xorSet
 Indicates that the arg was set as part of an XOR and not on the command line. More...
 
bool _acceptsMultipleValues
 

Static Private Member Functions

static bool & ignoreRestRef ()
 Indicates whether the rest of the arguments should be ignored. More...
 
static char & delimiterRef ()
 The delimiter that separates an argument flag/name from the value. More...
 

Constructor & Destructor Documentation

◆ SwitchArg() [1/2]

TCLAP::SwitchArg::SwitchArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  def = false,
Visitor v = NULL 
)
inline

SwitchArg constructor.

Parameters
flag- The one character flag that identifies this argument on the command line.
name- A one word name for the argument. Can be used as a long flag on the command line.
desc- A description of what the argument is for or does.
def- The default value for this Switch.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 141 of file SwitchArg.h.

◆ SwitchArg() [2/2]

TCLAP::SwitchArg::SwitchArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
CmdLineInterface parser,
bool  def = false,
Visitor v = NULL 
)
inline

SwitchArg constructor.

Parameters
flag- The one character flag that identifies this argument on the command line.
name- A one word name for the argument. Can be used as a long flag on the command line.
desc- A description of what the argument is for or does.
parser- A CmdLine parser object to add this Arg to
def- The default value for this Switch.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 150 of file SwitchArg.h.

Member Function Documentation

◆ _checkWithVisitor()

void TCLAP::Arg::_checkWithVisitor ( ) const
inlineprotectedinherited

Performs the special handling described by the Vistitor.

Definition at line 537 of file Arg.h.

◆ _hasBlanks()

bool TCLAP::Arg::_hasBlanks ( const std::string &  s) const
inlineinherited

Checks whether a given string has blank chars, indicating that it is a combined SwitchArg.

Implementation of _hasBlanks.

If so, return true, otherwise return false.

Parameters
s- string to be checked.

Definition at line 567 of file Arg.h.

◆ acceptsMultipleValues()

bool TCLAP::Arg::acceptsMultipleValues ( )
inlinevirtualinherited

Definition at line 600 of file Arg.h.

◆ addToList()

void TCLAP::Arg::addToList ( std::list< Arg * > &  argList) const
inlinevirtualinherited

Adds this to the specified list of Args.

Overridden by Args that need to added to the end of the list.

Parameters
argList- The list to add this to.

Reimplemented in TCLAP::UnlabeledValueArg< T >, and TCLAP::UnlabeledMultiArg< T >.

Definition at line 590 of file Arg.h.

◆ allowMore()

bool TCLAP::Arg::allowMore ( )
inlinevirtualinherited

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 595 of file Arg.h.

◆ argMatches()

bool TCLAP::Arg::argMatches ( const std::string &  s) const
inlinevirtualinherited

A method that tests whether a string matches this argument.

This is generally called by the processArg() method. This method could be re-implemented by a child to change how arguments are specified on the command line.

Parameters
s- The string to be compared to the flag/name to determine whether the arg matches.

Definition at line 516 of file Arg.h.

◆ beginIgnoring()

static void TCLAP::Arg::beginIgnoring ( )
inlinestaticinherited

Begin ignoring arguments since the "--" argument was specified.

Definition at line 214 of file Arg.h.

◆ blankChar()

static char TCLAP::Arg::blankChar ( )
inlinestaticinherited

The char used as a place holder when SwitchArgs are combined.

Currently set to '*', which shouldn't cause many problems since *'s are expanded by most shells on the command line.

Definition at line 232 of file Arg.h.

Referenced by TCLAP::Arg::trimFlag().

◆ combinedSwitchesMatch()

bool TCLAP::SwitchArg::combinedSwitchesMatch ( std::string &  combined)
inline

Checks a string to see if any of the chars in the string match the flag for this Switch.

Definition at line 164 of file SwitchArg.h.

◆ delimiter()

static char TCLAP::Arg::delimiter ( )
inlinestaticinherited

The delimiter that separates an argument flag/name from the value.

Definition at line 225 of file Arg.h.

Referenced by TCLAP::MultiArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), and TCLAP::Arg::toString().

◆ delimiterRef()

static char& TCLAP::Arg::delimiterRef ( )
inlinestaticprivateinherited

The delimiter that separates an argument flag/name from the value.

Definition at line 100 of file Arg.h.

Referenced by TCLAP::Arg::ignoreRest().

◆ flagStartChar()

static char TCLAP::Arg::flagStartChar ( )
inlinestaticinherited

The char that indicates the beginning of a flag.

Currently '-'.

Definition at line 237 of file Arg.h.

◆ flagStartString()

static const std::string TCLAP::Arg::flagStartString ( )
inlinestaticinherited

The sting that indicates the beginning of a flag.

Currently "-". Should be identical to flagStartChar.

Definition at line 243 of file Arg.h.

Referenced by TCLAP::Arg::isValueRequired().

◆ forceRequired()

void TCLAP::Arg::forceRequired ( )
inlineinherited

Sets _required to true.

This is used by the XorHandler. You really have no reason to ever use it.

Definition at line 576 of file Arg.h.

◆ getDescription()

std::string TCLAP::Arg::getDescription ( ) const
inlineinherited

Returns the argument description.

Definition at line 480 of file Arg.h.

References TCLAP::Arg::_valueRequired.

Referenced by TCLAP::UnlabeledMultiArg< T >::shortID().

◆ getFlag()

const std::string & TCLAP::Arg::getFlag ( ) const
inlineinherited

Returns the argument flag.

Definition at line 493 of file Arg.h.

◆ getName()

const std::string & TCLAP::Arg::getName ( ) const
inlineinherited

Returns the argument name.

Definition at line 495 of file Arg.h.

Referenced by TCLAP::UnlabeledMultiArg< T >::shortID().

◆ getValue()

bool TCLAP::SwitchArg::getValue ( )
inline

Returns bool, whether or not the switch has been set.

Definition at line 162 of file SwitchArg.h.

◆ ignoreNameString()

static const std::string TCLAP::Arg::ignoreNameString ( )
inlinestaticinherited

The name used to identify the ignore rest argument.

Definition at line 254 of file Arg.h.

◆ ignoreRest()

static bool TCLAP::Arg::ignoreRest ( )
inlinestaticinherited

Whether to ignore the rest.

Definition at line 219 of file Arg.h.

References TCLAP::Arg::delimiterRef().

Referenced by TCLAP::MultiArg< T >::processArg(), and TCLAP::ValueArg< T >::processArg().

◆ ignoreRestRef()

static bool& TCLAP::Arg::ignoreRestRef ( )
inlinestaticprivateinherited

Indicates whether the rest of the arguments should be ignored.

Definition at line 94 of file Arg.h.

◆ isIgnoreable()

bool TCLAP::Arg::isIgnoreable ( ) const
inlineinherited

Indicates whether the argument can be ignored, if desired.

Definition at line 509 of file Arg.h.

◆ isRequired()

bool TCLAP::Arg::isRequired ( ) const
inlinevirtualinherited

Indicates whether the argument is required.

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 497 of file Arg.h.

◆ isSet()

bool TCLAP::Arg::isSet ( ) const
inlineinherited

Indicates whether the argument has already been set.

Only true if the arg has been matched on the command line.

Definition at line 501 of file Arg.h.

◆ isValueRequired()

bool TCLAP::Arg::isValueRequired ( ) const
inlineinherited

Indicates whether a value must be specified for argument.

Definition at line 499 of file Arg.h.

References TCLAP::Arg::_flag, and TCLAP::Arg::flagStartString().

◆ longID()

std::string TCLAP::Arg::longID ( const std::string &  valueId = "val") const
inlinevirtualinherited

Returns a long ID for the usage.

Parameters
valueId- The value used in the id.

Reimplemented in TCLAP::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, and TCLAP::MultiSwitchArg< DUMMY >.

Definition at line 449 of file Arg.h.

Referenced by TCLAP::MultiArg< T >::longID(), and TCLAP::ValueArg< T >::longID().

◆ nameStartString()

static const std::string TCLAP::Arg::nameStartString ( )
inlinestaticinherited

The sting that indicates the beginning of a name.

Currently "--". Should be flagStartChar twice.

Definition at line 249 of file Arg.h.

◆ operator==()

bool TCLAP::Arg::operator== ( const Arg a) const
inlinevirtualinherited

Operator ==.

Equality operator. Must be virtual to handle unlabeled args.

Parameters
a- The Arg to be compared to this.

Reimplemented in TCLAP::UnlabeledValueArg< T >, and TCLAP::UnlabeledMultiArg< T >.

Definition at line 472 of file Arg.h.

◆ processArg()

bool TCLAP::SwitchArg::processArg ( int *  i,
std::vector< std::string > &  args 
)
inlinevirtual

Handles the processing of the argument.

This re-implements the Arg version of this method to set the _value of the argument appropriately.

Parameters
i- Pointer the the current argument in the list.
args- Mutable list of strings. Passed in from main().

Implements TCLAP::Arg.

Reimplemented in TCLAP::MultiSwitchArg< DUMMY >.

Definition at line 193 of file SwitchArg.h.

◆ setDelimiter()

static void TCLAP::Arg::setDelimiter ( char  c)
inlinestaticinherited

Sets the delimiter for all arguments.

Parameters
c- The character that delimits flags/names from values.

Definition at line 260 of file Arg.h.

Referenced by TCLAP::CmdLine::~CmdLine().

◆ setRequireLabel()

void TCLAP::Arg::setRequireLabel ( const std::string &  s)
inlineinherited

Sets the requireLabel.

Used by XorHandler. You shouldn't ever use this.

Parameters
s- Set the requireLabel to this value.

Definition at line 511 of file Arg.h.

◆ shortID()

std::string TCLAP::Arg::shortID ( const std::string &  valueId = "val") const
inlinevirtualinherited

Returns a short ID for the usage.

Parameters
valueId- The value used in the id.

Reimplemented in TCLAP::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, and TCLAP::MultiSwitchArg< DUMMY >.

Definition at line 428 of file Arg.h.

Referenced by TCLAP::MultiArg< T >::shortID(), and TCLAP::ValueArg< T >::shortID().

◆ toString()

std::string TCLAP::Arg::toString ( ) const
inlinevirtualinherited

Returns a simple string representation of the argument.

Primarily for debugging.

Definition at line 525 of file Arg.h.

References TCLAP::Arg::delimiter().

Referenced by TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().

◆ trimFlag()

void TCLAP::Arg::trimFlag ( std::string &  flag,
std::string &  value 
) const
inlinevirtualinherited

Trims a value off of the flag.

Implementation of trimFlag.

Parameters
flag- The string from which the flag and value will be trimmed. Contains the flag once the value has been trimmed.
value- Where the value trimmed from the string will be stored.

Definition at line 546 of file Arg.h.

References TCLAP::Arg::blankChar().

◆ xorSet()

void TCLAP::Arg::xorSet ( )
inlineinherited

Sets the _alreadySet value to true.

This is used by the XorHandler. You really have no reason to ever use it.

Definition at line 581 of file Arg.h.

References TCLAP::Arg::_acceptsMultipleValues.

Member Data Documentation

◆ _acceptsMultipleValues

bool TCLAP::Arg::_acceptsMultipleValues
protectedinherited

Definition at line 172 of file Arg.h.

Referenced by TCLAP::MultiArg< T >::MultiArg(), and TCLAP::Arg::xorSet().

◆ _alreadySet

bool TCLAP::Arg::_alreadySet
protectedinherited

Indicates whether the argument has been set.

Indicates that a value on the command line has matched the name/flag of this argument and the values have been set accordingly.

Definition at line 151 of file Arg.h.

◆ _description

std::string TCLAP::Arg::_description
protectedinherited

Description of the argument.

Definition at line 126 of file Arg.h.

◆ _flag

std::string TCLAP::Arg::_flag
protectedinherited

The single char flag used to identify the argument.

This value (preceded by a dash {-}), can be used to identify an argument on the command line. The _flag can be blank, in fact this is how unlabeled args work. Unlabeled args must override appropriate functions to get correct handling. Note that the _flag does NOT include the dash as part of the flag.

Definition at line 112 of file Arg.h.

Referenced by TCLAP::Arg::isValueRequired().

◆ _ignoreable

bool TCLAP::Arg::_ignoreable
protectedinherited

Whether this argument can be ignored, if desired.

Definition at line 164 of file Arg.h.

Referenced by TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().

◆ _name

std::string TCLAP::Arg::_name
protectedinherited

A single work namd indentifying the argument.

This value (preceded by two dashed {–}) can also be used to identify an argument on the command line. Note that the _name does NOT include the two dashes as part of the _name. The _name cannot be blank.

Definition at line 121 of file Arg.h.

◆ _required

bool TCLAP::Arg::_required
protectedinherited

Indicating whether the argument is required.

Definition at line 131 of file Arg.h.

◆ _requireLabel

std::string TCLAP::Arg::_requireLabel
protectedinherited

Label to be used in usage description.

Normally set to "required", but can be changed when necessary.

Definition at line 137 of file Arg.h.

◆ _value

bool TCLAP::SwitchArg::_value
protected

The value of the switch.

Definition at line 89 of file SwitchArg.h.

◆ _valueRequired

bool TCLAP::Arg::_valueRequired
protectedinherited

Indicates whether a value is required for the argument.

Note that the value may be required but the argument/value combination may not be, as specified by _required.

Definition at line 144 of file Arg.h.

Referenced by TCLAP::Arg::getDescription().

◆ _visitor

Visitor* TCLAP::Arg::_visitor
protectedinherited

A pointer to a vistitor object.

The visitor allows special handling to occur as soon as the argument is matched. This defaults to NULL and should not be used unless absolutely necessary.

Definition at line 159 of file Arg.h.

◆ _xorSet

bool TCLAP::Arg::_xorSet
protectedinherited

Indicates that the arg was set as part of an XOR and not on the command line.

Definition at line 170 of file Arg.h.




Page generated by Doxygen 1.8.16 for MRPT 1.4.0 SVN: at Mon Oct 14 23:11:08 UTC 2019