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::Arg Class Referenceabstract

Detailed Description

A virtual base class that defines the essential data for all arguments.

This class, or one of its existing children, must be subclassed to do anything.

Definition at line 51 of file Arg.h.

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

Inheritance diagram for TCLAP::Arg:
Inheritance graph

Public Member Functions

virtual ~Arg ()
 Destructor.
 
virtual void addToList (std::list< Arg * > &argList) const
 Adds this to the specified list of Args.
 
virtual bool processArg (int *i, std::vector< std::string > &args)=0
 Pure virtual method meant to handle the parsing and value assignment of the string on the command line.
 
virtual bool operator== (const Arg &a) const
 Operator ==.
 
const std::string & getFlag () const
 Returns the argument flag.
 
const std::string & getName () const
 Returns the argument name.
 
std::string getDescription () const
 Returns the argument description.
 
virtual bool isRequired () const
 Indicates whether the argument is required.
 
void forceRequired ()
 Sets _required to true.
 
void xorSet ()
 Sets the _alreadySet value to true.
 
bool isValueRequired () const
 Indicates whether a value must be specified for argument.
 
bool isSet () const
 Indicates whether the argument has already been set.
 
bool isIgnoreable () const
 Indicates whether the argument can be ignored, if desired.
 
virtual bool argMatches (const std::string &s) const
 A method that tests whether a string matches this argument.
 
virtual std::string toString () const
 Returns a simple string representation of the argument.
 
virtual std::string shortID (const std::string &valueId="val") const
 Returns a short ID for the usage.
 
virtual std::string longID (const std::string &valueId="val") const
 Returns a long ID for the usage.
 
virtual void trimFlag (std::string &flag, std::string &value) const
 Trims a value off of the flag.
 
bool _hasBlanks (const std::string &s) const
 Checks whether a given string has blank chars, indicating that it is a combined SwitchArg.
 
void setRequireLabel (const std::string &s)
 Sets the requireLabel.
 
virtual bool allowMore ()
 
virtual bool acceptsMultipleValues ()
 

Static Public Member Functions

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

Protected Member Functions

void _checkWithVisitor () const
 Performs the special handling described by the Vistitor.
 
 Arg (const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL)
 Primary constructor.
 

Protected Attributes

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

Static Private Member Functions

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

Constructor & Destructor Documentation

◆ Arg()

TCLAP::Arg::Arg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
bool  valreq,
Visitor v = NULL 
)
inlineprotected

Primary constructor.

YOU (yes you) should NEVER construct an Arg directly, this is a base class that is extended by various children that are meant to be used. Use SwitchArg, ValueArg, MultiArg, UnlabeledValueArg, or UnlabeledMultiArg instead.

Parameters
flag- The flag identifying the argument.
name- The name identifying the argument.
desc- The description of the argument, used in the usage.
req- Whether the argument is required.
valreq- Whether the a value is required for the argument.
v- The visitor checked by the argument. Defaults to NULL.

Definition at line 367 of file Arg.h.

References _flag, _name, flagStartString(), ignoreNameString(), nameStartString(), and toString().

◆ ~Arg()

TCLAP::Arg::~Arg ( )
inlinevirtual

Destructor.

Definition at line 408 of file Arg.h.

Member Function Documentation

◆ _checkWithVisitor()

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

Performs the special handling described by the Vistitor.

Definition at line 519 of file Arg.h.

References _visitor, and TCLAP::Visitor::visit().

Referenced by TCLAP::SwitchArg::processArg().

◆ _hasBlanks()

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

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 549 of file Arg.h.

References blankChar().

◆ acceptsMultipleValues()

bool TCLAP::Arg::acceptsMultipleValues ( )
inlinevirtual

Definition at line 582 of file Arg.h.

References _acceptsMultipleValues.

Referenced by TCLAP::DocBookOutput::printShortArg().

◆ addToList()

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

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::UnlabeledMultiArg< T >, and TCLAP::UnlabeledValueArg< T >.

Definition at line 572 of file Arg.h.

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

◆ allowMore()

bool TCLAP::Arg::allowMore ( )
inlinevirtual

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 577 of file Arg.h.

◆ argMatches()

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

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 498 of file Arg.h.

References _flag, _name, flagStartString(), and nameStartString().

Referenced by TCLAP::SwitchArg::processArg().

◆ beginIgnoring()

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

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

Definition at line 178 of file Arg.h.

References ignoreRestRef().

Referenced by TCLAP::IgnoreRestVisitor::visit().

◆ blankChar()

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

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 196 of file Arg.h.

Referenced by TCLAP::CmdLine::_emptyCombined(), _hasBlanks(), and TCLAP::SwitchArg::combinedSwitchesMatch().

◆ delimiter()

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

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

Definition at line 189 of file Arg.h.

References delimiterRef().

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

◆ delimiterRef()

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

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

Definition at line 64 of file Arg.h.

Referenced by delimiter(), and setDelimiter().

◆ flagStartChar()

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

The char that indicates the beginning of a flag.

Currently '-'.

Definition at line 201 of file Arg.h.

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

◆ flagStartString()

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

The sting that indicates the beginning of a flag.

Currently "-". Should be identical to flagStartChar.

Definition at line 207 of file Arg.h.

Referenced by TCLAP::CmdLine::_constructor(), Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), longID(), shortID(), and toString().

◆ forceRequired()

void TCLAP::Arg::forceRequired ( )
inline

Sets _required to true.

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

Definition at line 558 of file Arg.h.

References _required.

◆ getDescription()

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

Returns the argument description.

Definition at line 462 of file Arg.h.

References _description, _required, and _requireLabel.

Referenced by TCLAP::UnlabeledMultiArg< T >::operator==(), TCLAP::UnlabeledValueArg< T >::operator==(), and TCLAP::DocBookOutput::printLongArg().

◆ getFlag()

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

Returns the argument flag.

Definition at line 475 of file Arg.h.

References _flag.

◆ getName()

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

Returns the argument name.

Definition at line 477 of file Arg.h.

References _name.

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

◆ ignoreNameString()

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

The name used to identify the ignore rest argument.

Definition at line 218 of file Arg.h.

Referenced by TCLAP::CmdLine::_constructor(), and Arg().

◆ ignoreRest()

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

◆ ignoreRestRef()

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

Indicates whether the rest of the arguments should be ignored.

Definition at line 58 of file Arg.h.

Referenced by beginIgnoring(), and ignoreRest().

◆ isIgnoreable()

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

Indicates whether the argument can be ignored, if desired.

Definition at line 491 of file Arg.h.

References _ignoreable.

◆ isRequired()

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

Indicates whether the argument is required.

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 479 of file Arg.h.

References _required.

Referenced by TCLAP::CmdLine::add(), TCLAP::XorHandler::check(), and TCLAP::DocBookOutput::printShortArg().

◆ isSet()

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

Indicates whether the argument has already been set.

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

Definition at line 483 of file Arg.h.

References _alreadySet, and _xorSet.

◆ isValueRequired()

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

Indicates whether a value must be specified for argument.

Definition at line 481 of file Arg.h.

References _valueRequired.

◆ longID()

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

◆ nameStartString()

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

The sting that indicates the beginning of a name.

Currently "--". Should be flagStartChar twice.

Definition at line 213 of file Arg.h.

Referenced by Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), longID(), shortID(), and toString().

◆ operator==()

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

Operator ==.

Equality operator. Must be virtual to handle unlabeled args.

Parameters
a- The Arg to be compared to this.

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

Definition at line 454 of file Arg.h.

References _flag, and _name.

◆ processArg()

virtual bool TCLAP::Arg::processArg ( int *  i,
std::vector< std::string > &  args 
)
pure virtual

Pure virtual method meant to handle the parsing and value assignment of the string on the command line.

Parameters
i- Pointer the the current argument in the list.
args- Mutable list of strings. What is passed in from main.

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

◆ setDelimiter()

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

Sets the delimiter for all arguments.

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

Definition at line 224 of file Arg.h.

References delimiterRef().

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

◆ setRequireLabel()

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

Sets the requireLabel.

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

Parameters
s- Set the requireLabel to this value.

Definition at line 493 of file Arg.h.

References _requireLabel.

◆ shortID()

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

◆ toString()

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

Returns a simple string representation of the argument.

Primarily for debugging.

Definition at line 507 of file Arg.h.

References _flag, _name, flagStartString(), and nameStartString().

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

◆ trimFlag()

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

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 528 of file Arg.h.

References delimiter().

◆ xorSet()

void TCLAP::Arg::xorSet ( )
inline

Sets the _alreadySet value to true.

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

Definition at line 563 of file Arg.h.

References _alreadySet, and _xorSet.

Member Data Documentation

◆ _acceptsMultipleValues

bool TCLAP::Arg::_acceptsMultipleValues
protected

Definition at line 136 of file Arg.h.

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

◆ _alreadySet

bool TCLAP::Arg::_alreadySet
protected

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 115 of file Arg.h.

Referenced by isSet(), TCLAP::SwitchArg::processArg(), and xorSet().

◆ _description

std::string TCLAP::Arg::_description
protected

Description of the argument.

Definition at line 90 of file Arg.h.

Referenced by getDescription().

◆ _flag

std::string TCLAP::Arg::_flag
protected

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 76 of file Arg.h.

Referenced by Arg(), argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), getFlag(), longID(), operator==(), shortID(), and toString().

◆ _ignoreable

bool TCLAP::Arg::_ignoreable
protected

Whether this argument can be ignored, if desired.

Definition at line 128 of file Arg.h.

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

◆ _name

std::string TCLAP::Arg::_name
protected

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 85 of file Arg.h.

Referenced by Arg(), argMatches(), getName(), longID(), operator==(), shortID(), and toString().

◆ _required

bool TCLAP::Arg::_required
protected

Indicating whether the argument is required.

Definition at line 95 of file Arg.h.

Referenced by forceRequired(), getDescription(), isRequired(), and shortID().

◆ _requireLabel

std::string TCLAP::Arg::_requireLabel
protected

Label to be used in usage description.

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

Definition at line 101 of file Arg.h.

Referenced by getDescription(), and setRequireLabel().

◆ _valueRequired

bool TCLAP::Arg::_valueRequired
protected

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 108 of file Arg.h.

Referenced by isValueRequired(), longID(), and shortID().

◆ _visitor

Visitor* TCLAP::Arg::_visitor
protected

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 123 of file Arg.h.

Referenced by _checkWithVisitor().

◆ _xorSet

bool TCLAP::Arg::_xorSet
protected

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

Definition at line 134 of file Arg.h.

Referenced by isSet(), and xorSet().




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Sat Jan 21 06:46:15 UTC 2023