BASIS  r3148
Command-line Parsing Library

Command-line parsing library for C++. More...

+ Collaboration diagram for Command-line Parsing Library:

Classes

class  basis::CmdLine
 Manages command line definition and parsing of arguments. More...
class  basis::ExistingDirectoryConstraint
 Constrain argument values to paths of existing directories. More...
class  basis::ExistingFileConstraint
 Constrain argument values to paths of existing files. More...
class  basis::MultiArg< T >
 An argument that allows multiple values of type T to be specified. More...
class  basis::NegativeValueConstraint< T >
 Constrain argument values to negative values. More...
class  basis::NonZeroValueConstraint< T >
 Constrain argument values to non-zero values. More...
class  basis::PositiveValueConstraint< T >
 Constrain argument values to positive values. More...
class  basis::ValueArg< T >
 An argument that allows multiple values of type T to be specified. More...
class  basis::ZeroOrNegativeValueConstraint< T >
 Constrain argument values to zero or negative values. More...
class  basis::ZeroOrPositiveValueConstraint< T >
 Constrain argument values to zero or positive values. More...

Files

file  CmdLine.h
 

Manages command line definition and parsing of arguments.


Typedefs

typedef TCLAP::Arg basis::Arg
 Base type of command-line arguments.
typedef basis::ValueArg< double > basis::DoubleArg
 Floating-point argument (double precision).
typedef basis::ValueArg< float > basis::FloatArg
 Floating-point argument.
typedef basis::ValueArg< int > basis::Int32Arg
 Signed 32-bit integer argument.
typedef basis::ValueArg< long > basis::Int64Arg
 Signed 64-bit integer argument.
typedef basis::ValueArg< int > basis::IntArg
 Alias for Int32Arg.
typedef basis::MultiArg< double > basis::MultiDoubleArg
 Floating-point argument (double precision, multiple occurrences allowed).
typedef basis::MultiArg< float > basis::MultiFloatArg
 Floating-point argument (multiple occurrences allowed).
typedef basis::MultiArg< int > basis::MultiInt32Arg
 Signed 32-bit integer argument (multiple occurrences allowed).
typedef basis::MultiArg< long > basis::MultiInt64Arg
 Signed 64-bit integer argument (multiple occurrences allowed).
typedef basis::MultiArg< int > basis::MultiIntArg
 Alias for MultiInt32Arg.
typedef basis::MultiArg
< std::string > 
basis::MultiStringArg
 String argument (multiple occurrences allowed).
typedef TCLAP::MultiSwitchArg basis::MultiSwitchArg
 Counts occurrences of option switch.
typedef basis::MultiArg
< unsigned int > 
basis::MultiUInt32Arg
 Unsigned 32-bit integer argument (multiple occurrences allowed).
typedef basis::MultiArg
< unsigned long > 
basis::MultiUInt64Arg
 Unsigned 64-bit integer argument (multiple occurrences allowed).
typedef basis::MultiArg
< unsigned int > 
basis::MultiUIntArg
 Alias for MultiUInt32Arg.
typedef
TCLAP::UnlabeledValueArg
< std::string > 
basis::PositionalArg
 Positional argument.
typedef
TCLAP::UnlabeledMultiArg
< std::string > 
basis::PositionalArgs
 Positional arguments.
typedef basis::ValueArg
< std::string > 
basis::StringArg
 String argument.
typedef
TCLAP::ValuesConstraint
< std::string > 
basis::StringValuesConstraint
 Constrains string arguments to allow only predefined values.
typedef TCLAP::SwitchArg basis::SwitchArg
 Switch to enable/disable option.
typedef basis::ValueArg
< unsigned int > 
basis::UInt32Arg
 Unsigned 32-bit integer argument.
typedef basis::ValueArg
< unsigned long > 
basis::UInt64Arg
 Unsigned 64-bit integer argument.
typedef basis::ValueArg
< unsigned int > 
basis::UIntArg
 Alias for UInt32Arg.

Detailed Description

Command-line parsing library for C++.


Typedef Documentation

typedef TCLAP::Arg basis::Arg

Base type of command-line arguments.

Definition at line 43 of file CmdArgs.h.

Floating-point argument (double precision).

Definition at line 76 of file CmdArgs.h.

Floating-point argument.

Definition at line 74 of file CmdArgs.h.

Signed 32-bit integer argument.

Definition at line 62 of file CmdArgs.h.

Signed 64-bit integer argument.

Definition at line 66 of file CmdArgs.h.

Alias for Int32Arg.

Definition at line 70 of file CmdArgs.h.

Floating-point argument (double precision, multiple occurrences allowed).

Definition at line 97 of file CmdArgs.h.

Floating-point argument (multiple occurrences allowed).

Definition at line 95 of file CmdArgs.h.

Signed 32-bit integer argument (multiple occurrences allowed).

Definition at line 87 of file CmdArgs.h.

Signed 64-bit integer argument (multiple occurrences allowed).

Definition at line 91 of file CmdArgs.h.

Alias for MultiInt32Arg.

Definition at line 99 of file CmdArgs.h.

typedef basis::MultiArg<std::string> basis::MultiStringArg

String argument (multiple occurrences allowed).

Definition at line 85 of file CmdArgs.h.

typedef TCLAP::MultiSwitchArg basis::MultiSwitchArg

Counts occurrences of option switch.

Definition at line 51 of file CmdArgs.h.

typedef basis::MultiArg<unsigned int> basis::MultiUInt32Arg

Unsigned 32-bit integer argument (multiple occurrences allowed).

Definition at line 89 of file CmdArgs.h.

typedef basis::MultiArg<unsigned long> basis::MultiUInt64Arg

Unsigned 64-bit integer argument (multiple occurrences allowed).

Definition at line 93 of file CmdArgs.h.

typedef basis::MultiArg<unsigned int> basis::MultiUIntArg

Alias for MultiUInt32Arg.

Definition at line 101 of file CmdArgs.h.

typedef TCLAP::UnlabeledValueArg<std::string> basis::PositionalArg

Positional argument.

Processes only one positional argument. Add the positional arguments in the right order to the command-line.

Note:
The other unlabeled arguments as supported by TCLAP are intentionally not available through BASIS itself. Any non-string argument should more likely be a labeled argument, i.e., one with an option flag.

Definition at line 116 of file CmdArgs.h.

typedef TCLAP::UnlabeledMultiArg<std::string> basis::PositionalArgs

Positional arguments.

Use only one positional argument per command-line. Must be the last argument added to the command-line as it is greedy and will aggregate all remaining command-line arguments.

Note:
The other unlabeled arguments as supported by TCLAP are intentionally not available through BASIS itself. Any non-string argument should more likely be a labeled argument, i.e., one with an option flag.

Definition at line 129 of file CmdArgs.h.

typedef basis::ValueArg<std::string> basis::StringArg

String argument.

Definition at line 60 of file CmdArgs.h.

typedef TCLAP::ValuesConstraint<std::string> basis::StringValuesConstraint

Constrains string arguments to allow only predefined values.

Definition at line 142 of file CmdArgs.h.

typedef TCLAP::SwitchArg basis::SwitchArg

Switch to enable/disable option.

Definition at line 49 of file CmdArgs.h.

typedef basis::ValueArg<unsigned int> basis::UInt32Arg

Unsigned 32-bit integer argument.

Definition at line 64 of file CmdArgs.h.

typedef basis::ValueArg<unsigned long> basis::UInt64Arg

Unsigned 64-bit integer argument.

Definition at line 68 of file CmdArgs.h.

typedef basis::ValueArg<unsigned int> basis::UIntArg

Alias for UInt32Arg.

Definition at line 72 of file CmdArgs.h.