BASIS  version 1.2.3 (revision 2104)
Classes | Files | Typedefs
Command-line Parsing Library
C++ Utilities

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

+ Collaboration diagram for Command-line Parsing Library:

Classes

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

Files

file  basis/CmdLine.h
 

Manages command line definition and parsing of arguments.


Typedefs

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

Detailed Description

Command-line parsing library for C++.

See Parsing the Command-line Arguments in C++ for details on how to use this library.


Typedef Documentation

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 120 of file CmdArgs.h.

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 133 of file CmdArgs.h.