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

#include <value_arg.hpp>

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

Public Member Functions

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

Protected Member Functions

void _extractValue (const std::string &val)
 

Protected Attributes

Constraint< T > * _constraint
 
std::string _typeDesc
 
_value
 

Detailed Description

template<class T>
class ecl::ValueArg< T >

The basic labeled argument that parses a value. This is a template class, which means the type T defines the type that a given object will attempt to parse when the flag/name is matched on the command line. While there is nothing stopping you from creating an unflagged ValueArg, it is unwise and would cause significant problems. Instead use an UnlabeledValueArg.

Definition at line 36 of file value_arg.hpp.

Constructor & Destructor Documentation

◆ ValueArg() [1/4]

template<class T >
ecl::ValueArg< T >::ValueArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
value,
const std::string &  typeDesc,
Visitor v = NULL 
)

Labeled ValueArg constructor. You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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.
value- The default value assigned to this argument if it is not present 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.

Constructor implementation.

Definition at line 351 of file value_arg.hpp.

◆ ValueArg() [2/4]

template<class T >
ecl::ValueArg< T >::ValueArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
value,
const std::string &  typeDesc,
CmdLineInterface parser,
Visitor v = NULL 
)

Labeled ValueArg constructor. You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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.
value- The default value assigned to this argument if it is not present 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 365 of file value_arg.hpp.

◆ ValueArg() [3/4]

template<class T >
ecl::ValueArg< T >::ValueArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
value,
Constraint< T > *  constraint,
CmdLineInterface parser,
Visitor v = NULL 
)

Labeled ValueArg constructor. You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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.
value- The default value assigned to this argument if it is not present 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 396 of file value_arg.hpp.

◆ ValueArg() [4/4]

template<class T >
ecl::ValueArg< T >::ValueArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
value,
Constraint< T > *  constraint,
Visitor v = NULL 
)

Labeled ValueArg constructor. You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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.
value- The default value assigned to this argument if it is not present 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 382 of file value_arg.hpp.

Member Function Documentation

◆ _extractValue()

template<class T >
void ecl::ValueArg< 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- value to be parsed.

Definition at line 487 of file value_arg.hpp.

◆ getValue()

template<class T >
T & ecl::ValueArg< T >::getValue

Returns the value of the argument.

Implementation of getValue().

Definition at line 417 of file value_arg.hpp.

◆ longID()

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

Specialization of longID.

Parameters
val- value to be used.

Implementation of longID.

Reimplemented in ecl::UnlabeledValueArg< T >.

Definition at line 480 of file value_arg.hpp.

◆ processArg()

template<class T >
bool ecl::ValueArg< 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 in from main().

Implementation of processArg().

Reimplemented in ecl::UnlabeledValueArg< T >.

Definition at line 423 of file value_arg.hpp.

◆ shortID()

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

Specialization of shortID.

Parameters
val- value to be used.

Implementation of shortID.

Reimplemented in ecl::UnlabeledValueArg< T >.

Definition at line 470 of file value_arg.hpp.

Member Data Documentation

◆ _constraint

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

A Constraint this Arg must conform to.

Definition at line 179 of file value_arg.hpp.

◆ _typeDesc

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

A human readable description of the type to be parsed. This is a hack, plain and simple. Ideally we would use RTTI to return the name of type T, but until there is some sort of consistent support for human readable names, we are left to our own devices.

Definition at line 174 of file value_arg.hpp.

◆ _value

template<class T >
T ecl::ValueArg< T >::_value
protected

The value parsed from the command line. Can be of any type, as long as the >> operator for the type is defined.

Definition at line 165 of file value_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