Namespaces | |
| internal | |
Classes | |
| class | AnyOf |
| Implements a group of arguments where any combination is possible (including all or none). More... | |
| class | Arg |
| A virtual base class that defines the essential data for all arguments. More... | |
| class | ArgContainer |
| Interface that allows adding an Arg to a "container". More... | |
| class | ArgException |
| A simple class that defines and argument exception. More... | |
| class | ArgGroup |
| ArgGroup is the base class for implementing groups of arguments that are mutually exclusive (it replaces the deprecated xor handler). More... | |
| class | ArgParseException |
| Thrown from within the child Arg classes when it fails to properly parse the argument it has been passed. More... | |
| class | ArgTraits |
| Arg traits are used to get compile type specialization when parsing argument values. More... | |
| struct | ArgTraits< std::string > |
| class | CmdLine |
| The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes. More... | |
| class | CmdLineInterface |
| The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes. More... | |
| class | CmdLineOutput |
| The interface that any output object must implement. More... | |
| class | CmdLineParseException |
| Thrown from CmdLine when the arguments on the command line are not properly specified, e.g. More... | |
| class | Constraint |
| The interface that defines the interaction between the Arg and Constraint. More... | |
| class | DeferDelete |
| DeferDelete can be used by objects that need to allocate arbitrary other objects to live for the duration of the first object. More... | |
| class | DocBookOutput |
| A class that generates DocBook output for usage() method for the given CmdLine and its Args. More... | |
| class | EitherOf |
| Implements a group of arguments where at most one can be selected. More... | |
| class | ExclusiveArgGroup |
| Implements common functionality for exclusive argument groups. More... | |
| class | ExitException |
| Thrown when TCLAP thinks the program should exit. More... | |
| class | HelpVisitor |
| A Visitor object that calls the usage method of the given CmdLineOutput object for the specified CmdLine object. More... | |
| class | IgnoreRestVisitor |
| A Visitor that tells the CmdLine to begin ignoring arguments after this one is parsed. More... | |
| class | MultiArg |
| An argument that allows multiple values of type T to be specified. More... | |
| class | MultiSwitchArg |
| A multiple switch argument. More... | |
| class | OneOf |
| Implements a group of arguments where exactly one must be selected. More... | |
| class | OptionalUnlabeledTracker |
| class | SpecificationException |
| Thrown from Arg and CmdLine when an Arg is improperly specified, e.g. More... | |
| class | StandaloneArgs |
| class | StdOutput |
| A class that isolates any output from the CmdLine object so that it may be easily modified. More... | |
| struct | StringLike |
| A string like argument value type is a value that can be set using operator=(string). More... | |
| struct | StringLikeTrait |
| A class can inherit from this object to make it have string like traits. More... | |
| class | SwitchArg |
| A simple switch argument. More... | |
| class | UnlabeledMultiArg |
| Just like a MultiArg, except that the arguments are unlabeled. More... | |
| class | UnlabeledValueArg |
| The basic unlabeled argument that parses a value. More... | |
| class | ValueArg |
| The basic labeled argument that parses a value. More... | |
| struct | ValueLike |
| A value like argument value type is a value that can be set using operator>>. More... | |
| struct | ValueLikeTrait |
| A class can inherit from this object to make it have value like traits. More... | |
| class | ValuesConstraint |
| A Constraint that constrains the Arg to only those values specified in the constraint. More... | |
| class | VersionVisitor |
| A Visitor that will call the version method of the given CmdLineOutput for the specified CmdLine object and then exit. More... | |
| class | Visitor |
| A base class that defines the interface for visitors. More... | |
Typedefs | |
| typedef std::list< Arg * >::const_iterator | ArgListIterator |
| Typedef of an Arg list iterator. More... | |
| typedef std::vector< Arg * >::const_iterator | ArgVectorIterator |
| Typedef of an Arg vector iterator. More... | |
| typedef std::list< Visitor * >::const_iterator | VisitorListIterator |
| Typedef of a Visitor list iterator. More... | |
| typedef std::istringstream | istringstream |
| typedef std::ostringstream | ostringstream |
Functions | |
| template<typename T > | |
| void | ExtractValue (T &destVal, const std::string &strVal, ValueLike vl) |
| template<typename T > | |
| void | ExtractValue (T &destVal, const std::string &strVal, StringLike sl) |
| int | CountVisibleArgs (const ArgGroup &g) |
| bool | isInArgGroup (const Arg *arg, const std::list< ArgGroup *> &argSets) |
| void | removeArgsInArgGroups (std::list< Arg *> &argList, const std::list< ArgGroup *> &argSets) |
| std::string | basename (std::string s) |
| template<typename T > | |
| void | SetString (T &dst, const std::string &src) |
| void | removeChar (std::string &s, char r) |
| bool | cmpSwitch (const char &a, const char &b) |
Typedef Documentation
◆ ArgListIterator
| typedef std::list<Arg *>::const_iterator TCLAP::ArgListIterator |
◆ ArgVectorIterator
| typedef std::vector<Arg *>::const_iterator TCLAP::ArgVectorIterator |
◆ istringstream
| typedef std::istringstream TCLAP::istringstream |
◆ ostringstream
| typedef std::ostringstream TCLAP::ostringstream |
◆ VisitorListIterator
| typedef std::list<Visitor *>::const_iterator TCLAP::VisitorListIterator |
Function Documentation
◆ basename()
|
inline |
Definition at line 94 of file CmdLineOutput.h.
Referenced by TCLAP::CmdLine::parse().
◆ cmpSwitch()
|
inline |
Definition at line 154 of file StdOutput.h.
Referenced by TCLAP::StdOutput::_shortUsage().
◆ CountVisibleArgs()
|
inline |
Definition at line 243 of file ArgGroup.h.
References TCLAP::ArgGroup::begin(), and TCLAP::ArgGroup::end().
Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), and TCLAP::DocBookOutput::usage().
Here is the call graph for this function:
◆ ExtractValue() [1/2]
template<typename T >
| void TCLAP::ExtractValue | ( | T & | destVal, |
| const std::string & | strVal, | ||
| ValueLike | vl | ||
| ) |
Definition at line 399 of file Arg.h.
Referenced by TCLAP::MultiArg< T >::_extractValue(), and TCLAP::ValueArg< T >::_extractValue().
◆ ExtractValue() [2/2]
template<typename T >
| void TCLAP::ExtractValue | ( | T & | destVal, |
| const std::string & | strVal, | ||
| StringLike | sl | ||
| ) |
Definition at line 437 of file Arg.h.
References SetString().
Here is the call graph for this function:
◆ isInArgGroup()
Definition at line 72 of file CmdLineOutput.h.
Referenced by removeArgsInArgGroups().
◆ removeArgsInArgGroups()
|
inline |
Definition at line 82 of file CmdLineOutput.h.
References isInArgGroup().
Here is the call graph for this function:
◆ removeChar()
|
inline |
Definition at line 147 of file StdOutput.h.
◆ SetString()
template<typename T >
| void TCLAP::SetString | ( | T & | dst, |
| const std::string & | src | ||
| ) |
Definition at line 53 of file StandardTraits.h.
Referenced by ExtractValue().
