Static Value-Flow Analysis
Loading...
Searching...
No Matches
OptionMap< T > Class Template Reference

#include <CommandLine.h>

Inheritance diagram for OptionMap< T >:
OptionBase

Public Types

typedef std::vector< OptionPossibility< T > > OptionPossibilities

Public Member Functions

 OptionMap (std::string name, std::string description, T init, OptionPossibilities possibilities)
virtual bool canSet (void) const override
 Can this option be set?
virtual bool parseAndSetValue (const std::string s) override
 From a given string, set the value of this option.
T operator() (void) const

Private Attributes

bool isExplicitlySet
T value
OptionPossibilities possibilities

Additional Inherited Members

Static Public Member Functions inherited from OptionBase
static std::vector< std::string > parseOptions (int argc, char *argv[], std::string description, std::string callFormat)
Protected Types inherited from OptionBase
typedef std::pair< std::string, std::string > PossibilityDescription
 Name/description pairs.
typedef std::vector< std::pair< std::string, std::string > > PossibilityDescriptions
template<typename T>
using OptionPossibility = std::tuple<T, std::string, std::string>
Protected Member Functions inherited from OptionBase
 OptionBase (std::string name, std::string description)
 OptionBase (std::string name, std::string description, PossibilityDescriptions possibilityDescriptions)
virtual bool isBool (void) const
virtual bool isMultiple (void) const
 Whether this option is an OptionMultiple.
Static Protected Member Functions inherited from OptionBase
template<typename T>
static PossibilityDescriptions extractPossibilityDescriptions (const std::vector< OptionPossibility< T > > possibilities)
static std::map< std::string, OptionBase * > & getOptionsMap (void)
Protected Attributes inherited from OptionBase
std::string name
std::string description
PossibilityDescriptions possibilityDescriptions
 For when we have possibilities like in an OptionMap.

Detailed Description

template<typename T>
class OptionMap< T >

Option allowing a limited range of values, probably corresponding to an enum. Opt() gives the value.

Definition at line 414 of file CommandLine.h.

Member Typedef Documentation

◆ OptionPossibilities

template<typename T>
typedef std::vector<OptionPossibility<T> > OptionMap< T >::OptionPossibilities

Definition at line 417 of file CommandLine.h.

Constructor & Destructor Documentation

◆ OptionMap()

template<typename T>
OptionMap< T >::OptionMap ( std::string name,
std::string description,
T init,
OptionPossibilities possibilities )
inline

Definition at line 419 of file CommandLine.h.

422 {
423 assert(!name.empty() && "OptionMap: empty option name given");
424 }
static PossibilityDescriptions extractPossibilityDescriptions(const std::vector< OptionPossibility< T > > possibilities)
std::string name
std::string description
OptionBase(std::string name, std::string description)
Definition CommandLine.h:33
OptionPossibilities possibilities
bool isExplicitlySet

Member Function Documentation

◆ canSet()

template<typename T>
virtual bool OptionMap< T >::canSet ( void ) const
inlineoverridevirtual

Can this option be set?

Implements OptionBase.

Definition at line 426 of file CommandLine.h.

427 {
428 return !isExplicitlySet;
429 }

◆ operator()()

template<typename T>
T OptionMap< T >::operator() ( void ) const
inline

Definition at line 448 of file CommandLine.h.

449 {
450 return value;
451 }

◆ parseAndSetValue()

template<typename T>
virtual bool OptionMap< T >::parseAndSetValue ( const std::string value)
inlineoverridevirtual

From a given string, set the value of this option.

Implements OptionBase.

Definition at line 431 of file CommandLine.h.

432 {
434 {
435 // Check if the given string is a valid one.
436 if (s == std::get<1>(op))
437 {
438 // What that string maps to.
440 isExplicitlySet = true;
441 break;
442 }
443 }
444
445 return isExplicitlySet;
446 }
std::tuple< T, std::string, std::string > OptionPossibility
Definition CommandLine.h:30

Member Data Documentation

◆ isExplicitlySet

template<typename T>
bool OptionMap< T >::isExplicitlySet
private

Definition at line 454 of file CommandLine.h.

◆ possibilities

template<typename T>
OptionPossibilities OptionMap< T >::possibilities
private

Definition at line 456 of file CommandLine.h.

◆ value

template<typename T>
T OptionMap< T >::value
private

Definition at line 455 of file CommandLine.h.


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