TCLAP::Arg Class Reference
#include <Arg.h>
Inherited by TCLAP::MultiArg< T >, TCLAP::SwitchArg, and TCLAP::ValueArg< T >.
List of all members.
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.
Constructor & Destructor Documentation
| TCLAP::Arg::Arg |
( |
const std::string & |
flag, |
|
|
const std::string & |
name, |
|
|
const std::string & |
desc, |
|
|
bool |
req, |
|
|
bool |
valreq, |
|
|
Visitor * |
v = NULL | |
|
) |
| | [inline, protected] |
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. |
| TCLAP::Arg::~Arg |
( |
|
) |
[inline, virtual] |
Member Function Documentation
| void TCLAP::Arg::_checkWithVisitor |
( |
|
) |
const [inline, protected] |
Performs the special handling described by the Vistitor.
| 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. If so, return true, otherwise return false.
- Parameters:
-
| s | - string to be checked. |
Implementation of _hasBlanks.
| void TCLAP::Arg::addToList |
( |
std::list< Arg * > & |
argList |
) |
const [inline, virtual] |
| bool TCLAP::Arg::argMatches |
( |
const std::string & |
s |
) |
const [inline, virtual] |
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. |
| static void TCLAP::Arg::beginIgnoring |
( |
|
) |
[inline, static] |
Begin ignoring arguments since the "--" argument was specified.
| static const char TCLAP::Arg::blankChar |
( |
|
) |
[inline, static] |
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.
| static char TCLAP::Arg::delimiter |
( |
|
) |
[inline, static] |
The delimiter that separates an argument flag/name from the value.
| static const char TCLAP::Arg::flagStartChar |
( |
|
) |
[inline, static] |
The char that indicates the beginning of a flag. Currently '-'.
| static const std::string TCLAP::Arg::flagStartString |
( |
|
) |
[inline, static] |
The sting that indicates the beginning of a flag. Currently "-". Should be identical to flagStartChar.
| void TCLAP::Arg::forceRequired |
( |
|
) |
[inline] |
Sets _required to true. This is used by the XorHandler. You really have no reason to ever use it.
| std::string TCLAP::Arg::getDescription |
( |
|
) |
const [inline] |
Returns the argument description.
| const std::string & TCLAP::Arg::getFlag |
( |
|
) |
const [inline] |
Returns the argument flag.
| const std::string & TCLAP::Arg::getName |
( |
|
) |
const [inline] |
Returns the argument name.
| static const std::string TCLAP::Arg::ignoreNameString |
( |
|
) |
[inline, static] |
The name used to identify the ignore rest argument.
| static bool TCLAP::Arg::ignoreRest |
( |
|
) |
[inline, static] |
Whether to ignore the rest.
| bool TCLAP::Arg::isIgnoreable |
( |
|
) |
const [inline] |
Indicates whether the argument can be ignored, if desired.
| bool TCLAP::Arg::isRequired |
( |
|
) |
const [inline, virtual] |
| 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.
| bool TCLAP::Arg::isValueRequired |
( |
|
) |
const [inline] |
Indicates whether a value must be specified for argument.
| std::string TCLAP::Arg::longID |
( |
const std::string & |
valueId = "val" |
) |
const [inline, virtual] |
| static const std::string TCLAP::Arg::nameStartString |
( |
|
) |
[inline, static] |
The sting that indicates the beginning of a name. Currently "--". Should be flagStartChar twice.
| bool TCLAP::Arg::operator== |
( |
const Arg & |
a |
) |
[inline, virtual] |
Operator ==. Equality operator. Must be virtual to handle unlabeled args.
- Parameters:
-
| a | - The Arg to be compared to this. |
| virtual bool TCLAP::Arg::processArg |
( |
int * |
i, |
|
|
std::vector< std::string > & |
args | |
|
) |
| | [pure virtual] |
| static void TCLAP::Arg::setDelimiter |
( |
char |
c |
) |
[inline, static] |
Sets the delimiter for all arguments.
- Parameters:
-
| c | - The character that delimits flags/names from values. |
| 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. |
| std::string TCLAP::Arg::shortID |
( |
const std::string & |
valueId = "val" |
) |
const [inline, virtual] |
| std::string TCLAP::Arg::toString |
( |
|
) |
const [inline, virtual] |
Returns a simple string representation of the argument. Primarily for debugging.
| void TCLAP::Arg::trimFlag |
( |
std::string & |
flag, |
|
|
std::string & |
value | |
|
) |
| | const [inline, virtual] |
Trims a value off of the flag.
- 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. |
Implementation of trimFlag.
| 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.
Member Data Documentation
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.
Description of the argument.
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.
Whether this argument can be ignored, if desired.
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.
Indicating whether the argument is required.
Label to be used in usage description. Normally set to "required", but can be changed when necessary.
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.
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.
Indicates that the arg was set as part of an XOR and not on the command line.
1.6.3