CmdArgs.h File Reference

Definition of commonly used command-line arguments. More...

#include <sbia/tclap/SwitchArg.h>
#include <sbia/tclap/MultiSwitchArg.h>
#include <sbia/tclap/UnlabeledValueArg.h>
#include <sbia/tclap/UnlabeledMultiArg.h>
#include <sbia/basis/ValueArg.h>
#include <sbia/basis/MultiArg.h>
#include <sbia/tclap/Constraint.h>
#include <sbia/basis/path.h>

Include dependency graph for CmdArgs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
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::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::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...
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

Definition of commonly used command-line arguments.

This include file mainly redefines the TCLAP command-line argument types in the namespace of BASIS itself. It only defines commonly used argument types without template parameters.

Copyright (c) 2011 University of Pennsylvania. All rights reserved.
See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.

Contact: SBIA Group <sbia-software at uphs.upenn.edu>

Definition in file CmdArgs.h.