Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ecl::MultiArg< T > Class Template Reference

#include <multi_arg.hpp>

Inheritance diagram for ecl::MultiArg< T >:
Inheritance graph
[legend]

Public Member Functions

virtual bool allowMore ()
 
const std::vector< T > & getValue ()
 
virtual bool isRequired () const
 
virtual std::string longID (const std::string &val="val") const
 
 MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, Visitor *v=NULL)
 
 MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, Visitor *v=NULL)
 
 MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, CmdLineInterface &parser, Visitor *v=NULL)
 
 MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, Visitor *v=NULL)
 
virtual bool processArg (int *i, std::vector< std::string > &args)
 
virtual std::string shortID (const std::string &val="val") const
 

Protected Member Functions

void _extractValue (const std::string &val)
 

Protected Attributes

bool _allowMore
 
Constraint< T > * _constraint
 
std::string _typeDesc
 
std::vector< T > _values
 

Detailed Description

template<class T>
class ecl::MultiArg< T >

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.

Definition at line 36 of file multi_arg.hpp.

Constructor & Destructor Documentation

◆ MultiArg() [1/4]

template<class T >
ecl::MultiArg< T >::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.

Definition at line 325 of file multi_arg.hpp.

◆ MultiArg() [2/4]

template<class T >
ecl::MultiArg< T >::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.
parser- A CmdLine parser object to add this Arg to
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 340 of file multi_arg.hpp.

◆ MultiArg() [3/4]

template<class T >
ecl::MultiArg< T >::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.

Definition at line 360 of file multi_arg.hpp.

◆ MultiArg() [4/4]

template<class T >
ecl::MultiArg< T >::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.
parser- A CmdLine parser object to add this Arg to
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 375 of file multi_arg.hpp.

Member Function Documentation

◆ _extractValue()

template<class T >
void ecl::MultiArg< T >::_extractValue ( const std::string &  val)
protected

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.

Definition at line 487 of file multi_arg.hpp.

◆ allowMore()

template<class T >
bool ecl::MultiArg< T >::allowMore
virtual

Definition at line 510 of file multi_arg.hpp.

◆ getValue()

template<class T >
const std::vector< T > & ecl::MultiArg< T >::getValue

Returns a vector of type T containing the values parsed from the command line.

Definition at line 392 of file multi_arg.hpp.

◆ isRequired()

template<class T >
bool ecl::MultiArg< T >::isRequired
virtual

Once we've matched the first value, then the arg is no longer required.

Definition at line 472 of file multi_arg.hpp.

◆ longID()

template<class T >
std::string ecl::MultiArg< T >::longID ( const std::string &  val = "val") const
virtual

Returns the a long id string. Used in the usage.

Parameters
val- value to be used.

Reimplemented in ecl::UnlabeledMultiArg< T >.

Definition at line 460 of file multi_arg.hpp.

◆ processArg()

template<class T >
bool ecl::MultiArg< T >::processArg ( int *  i,
std::vector< std::string > &  args 
)
virtual

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().

Reimplemented in ecl::UnlabeledMultiArg< T >.

Definition at line 395 of file multi_arg.hpp.

◆ shortID()

template<class T >
std::string ecl::MultiArg< T >::shortID ( const std::string &  val = "val") const
virtual

Returns the a short id string. Used in the usage.

Parameters
val- value to be used.

Reimplemented in ecl::UnlabeledMultiArg< T >.

Definition at line 449 of file multi_arg.hpp.

Member Data Documentation

◆ _allowMore

template<class T >
bool ecl::MultiArg< T >::_allowMore
protected

Definition at line 186 of file multi_arg.hpp.

◆ _constraint

template<class T >
Constraint<T>* ecl::MultiArg< T >::_constraint
protected

A list of constraint on this Arg.

Definition at line 176 of file multi_arg.hpp.

◆ _typeDesc

template<class T >
std::string ecl::MultiArg< T >::_typeDesc
protected

The description of type T to be used in the usage.

Definition at line 171 of file multi_arg.hpp.

◆ _values

template<class T >
std::vector<T> ecl::MultiArg< T >::_values
protected

The list of values parsed from the CmdLine.

Definition at line 166 of file multi_arg.hpp.


The documentation for this class was generated from the following file:


ecl_command_line
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:03