Template Class MultiArg
Defined in File multi_arg.hpp
Inheritance Relationships
Base Type
public ecl::Arg(Class Arg)
Derived Type
public ecl::UnlabeledMultiArg< T >(Template Class UnlabeledMultiArg)
Class Documentation
-
template<class T>
class MultiArg : public ecl::Arg An argument that allows multiple values of type T to be specified. Very similar to a ValueArg, except a vector of values will be returned instead of just one.
Subclassed by ecl::UnlabeledMultiArg< T >
Public Functions
-
MultiArg(const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, Visitor *v = NULL)
Constructor.
- Parameters
flag – - The one character flag that identifies this argument on the command line.
name – - A one word name for the argument. Can be used as a long flag on the command line.
desc – - A description of what the argument is for or does.
req – - Whether the argument is required on the command line.
typeDesc – - A short, human readable description of the type that this object expects. This is used in the generation of the USAGE statement. The goal is to be helpful to the end user of the program.
v – - An optional visitor. You probably should not use this unless you have a very good reason.
-
MultiArg(const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, Visitor *v = NULL)
Constructor.
- Parameters
flag – - The one character flag that identifies this argument on the command line.
name – - A one word name for the argument. Can be used as a long flag on the command line.
desc – - A description of what the argument is for or does.
req – - Whether the argument is required on the command line.
typeDesc – - A short, human readable description of the type that this object expects. This is used in the generation of the USAGE statement. The goal is to be helpful to the end user of the program.
v – - An optional visitor. You probably should not use this unless you have a very good reason.
-
MultiArg(const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint<T> *constraint, Visitor *v = NULL)
Constructor.
- Parameters
flag – - The one character flag that identifies this argument on the command line.
name – - A one word name for the argument. Can be used as a long flag on the command line.
desc – - A description of what the argument is for or does.
req – - Whether the argument is required on the command line.
constraint – - A pointer to a Constraint object used to constrain this Arg.
v – - An optional visitor. You probably should not use this unless you have a very good reason.
-
MultiArg(const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint<T> *constraint, CmdLineInterface &parser, Visitor *v = NULL)
Constructor.
- Parameters
flag – - The one character flag that identifies this argument on the command line.
name – - A one word name for the argument. Can be used as a long flag on the command line.
desc – - A description of what the argument is for or does.
req – - Whether the argument is required on the command line.
constraint – - A pointer to a Constraint object used to constrain this Arg.
v – - An optional visitor. You probably should not use this unless you have a very good reason.
-
virtual bool processArg(int *i, std::vector<std::string> &args)
Handles the processing of the argument. This re-implements the Arg version of this method to set the _value of the argument appropriately. It knows the difference between labeled and unlabeled.
- Parameters
i – - Pointer the the current argument in the list.
args – - Mutable list of strings. Passed from main().
-
const std::vector<T> &getValue()
Returns a vector of type T containing the values parsed from the command line.
-
virtual std::string shortID(const std::string &val = "val") const
Returns the a short id string. Used in the usage.
- Parameters
val – - value to be used.
-
virtual std::string longID(const std::string &val = "val") const
Returns the a long id string. Used in the usage.
- Parameters
val – - value to be used.
-
virtual bool isRequired() const
Once we’ve matched the first value, then the arg is no longer required.
-
virtual bool allowMore()
Protected Functions
-
void _extractValue(const std::string &val)
Extracts the value from the string. Attempts to parse string as type T, if this fails an exception is thrown.
- Parameters
val – - The string to be read.
-
MultiArg(const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, Visitor *v = NULL)