tclap  1.2.2
Classes | Typedefs | Functions
TCLAP Namespace Reference

Classes

class  Arg
 A virtual base class that defines the essential data for all arguments. More...
 
class  ArgException
 A simple class that defines and argument exception. 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  DocBookOutput
 A class that generates DocBook output for usage() method for the given CmdLine and its Args. 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  OptionalUnlabeledTracker
 
class  SpecificationException
 Thrown from Arg and CmdLine when an Arg is improperly specified, e.g. More...
 
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...
 
class  XorHandler
 This class handles lists of Arg's that are to be XOR'd on the command line. More...
 
class  ZshCompletionOutput
 A class that generates a Zsh completion function as output from the usage() method for the given CmdLine and its Args. 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)
 
template<typename T >
void DelPtr (T ptr)
 
template<typename C >
void ClearContainer (C &c)
 
template<typename T >
void SetString (T &dst, const std::string &src)
 

Typedef Documentation

◆ ArgListIterator

typedef std::list<Arg*>::const_iterator TCLAP::ArgListIterator

Typedef of an Arg list iterator.

Definition at line 387 of file Arg.h.

◆ ArgVectorIterator

typedef std::vector<Arg*>::const_iterator TCLAP::ArgVectorIterator

Typedef of an Arg vector iterator.

Definition at line 392 of file Arg.h.

◆ istringstream

typedef std::istringstream TCLAP::istringstream

Definition at line 37 of file sstream.h.

◆ ostringstream

typedef std::ostringstream TCLAP::ostringstream

Definition at line 38 of file sstream.h.

◆ VisitorListIterator

typedef std::list<Visitor*>::const_iterator TCLAP::VisitorListIterator

Typedef of a Visitor list iterator.

Definition at line 397 of file Arg.h.

Function Documentation

◆ ClearContainer()

template<typename C >
void TCLAP::ClearContainer ( C &  c)

Definition at line 58 of file CmdLine.h.

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

◆ DelPtr()

template<typename T >
void TCLAP::DelPtr ( ptr)

Definition at line 53 of file CmdLine.h.

◆ ExtractValue() [1/2]

template<typename T >
void TCLAP::ExtractValue ( T &  destVal,
const std::string &  strVal,
ValueLike  vl 
)

◆ ExtractValue() [2/2]

template<typename T >
void TCLAP::ExtractValue ( T &  destVal,
const std::string &  strVal,
StringLike  sl 
)

Definition at line 443 of file Arg.h.

References SetString().

Here is the call graph for this function:

◆ SetString()

template<typename T >
void TCLAP::SetString ( T &  dst,
const std::string &  src 
)

Definition at line 55 of file StandardTraits.h.

Referenced by ExtractValue().