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

#include <unlabeled_value_arg.hpp>

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

Public Member Functions

virtual void addToList (std::list< Arg * > &argList) const
 
virtual std::string longID (const std::string &val="val") const
 
virtual bool operator== (const Arg &a) const
 
virtual bool processArg (int *i, std::vector< std::string > &args)
 
virtual std::string shortID (const std::string &val="val") const
 
 UnlabeledValueArg (const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL)
 
 UnlabeledValueArg (const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)
 
 UnlabeledValueArg (const std::string &name, const std::string &desc, bool req, T value, Constraint< T > *constraint, bool ignoreable=false, Visitor *v=NULL)
 
 UnlabeledValueArg (const std::string &name, const std::string &desc, bool req, T value, Constraint< T > *constraint, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)
 
- Public Member Functions inherited from ecl::ValueArg< T >
T & getValue ()
 
 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)
 

Additional Inherited Members

- Protected Member Functions inherited from ecl::ValueArg< T >
void _extractValue (const std::string &val)
 
- Protected Attributes inherited from ecl::ValueArg< T >
Constraint< T > * _constraint
 
std::string _typeDesc
 
_value
 

Detailed Description

template<class T>
class ecl::UnlabeledValueArg< T >

The basic unlabeled 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 an UnlabeledValueArg is reached in the list of args that the CmdLine iterates over.

Definition at line 36 of file unlabeled_value_arg.hpp.

Constructor & Destructor Documentation

◆ UnlabeledValueArg() [1/4]

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

UnlabeledValueArg constructor.

Parameters
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.
ignoreable- Allows you to specify that this argument can be ignored if the '–' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored.
v- Optional Vistor. You should leave this blank unless you have a very good reason.

Constructor implemenation.

Definition at line 206 of file unlabeled_value_arg.hpp.

◆ UnlabeledValueArg() [2/4]

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

UnlabeledValueArg constructor.

Parameters
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
ignoreable- Allows you to specify that this argument can be ignored if the '–' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored.
v- Optional Vistor. You should leave this blank unless you have a very good reason.

Definition at line 222 of file unlabeled_value_arg.hpp.

◆ UnlabeledValueArg() [3/4]

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

UnlabeledValueArg constructor.

Parameters
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.
ignoreable- Allows you to specify that this argument can be ignored if the '–' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored.
v- Optional Vistor. You should leave this blank unless you have a very good reason.

Constructor implemenation.

Definition at line 241 of file unlabeled_value_arg.hpp.

◆ UnlabeledValueArg() [4/4]

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

UnlabeledValueArg constructor.

Parameters
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
ignoreable- Allows you to specify that this argument can be ignored if the '–' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored.
v- Optional Vistor. You should leave this blank unless you have a very good reason.

Definition at line 255 of file unlabeled_value_arg.hpp.

Member Function Documentation

◆ addToList()

template<class T >
void ecl::UnlabeledValueArg< T >::addToList ( std::list< Arg * > &  argList) const
virtual

Instead of pushing to the front of list, push to the back.

Parameters
argList- The list to add this to.

Definition at line 328 of file unlabeled_value_arg.hpp.

◆ longID()

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

Overrides longID for specific behavior.

Overriding longID for specific output.

Reimplemented from ecl::ValueArg< T >.

Definition at line 305 of file unlabeled_value_arg.hpp.

◆ operator==()

template<class T >
bool ecl::UnlabeledValueArg< T >::operator== ( const Arg a) const
virtual

Overrides operator== for specific behavior.

Overriding operator== for specific behavior.

Definition at line 319 of file unlabeled_value_arg.hpp.

◆ processArg()

template<class T >
bool ecl::UnlabeledValueArg< 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. Handling specific to unlabled arguments.

Parameters
i- Pointer the the current argument in the list.
args- Mutable list of strings.

Implementation of processArg().

Reimplemented from ecl::ValueArg< T >.

Definition at line 274 of file unlabeled_value_arg.hpp.

◆ shortID()

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

Overrides shortID for specific behavior.

Overriding shortID for specific output.

Reimplemented from ecl::ValueArg< T >.

Definition at line 294 of file unlabeled_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