AmpGen 2.1
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AmpGen::NamedParameter< T > Class Template Reference

Detailed Description

template<class T>
class AmpGen::NamedParameter< T >

Stores a vector of values for a parameter.

Template Parameters
Tthe type of this named parameter, i.e. strings, or numbers or bools etc.

Definition at line 32 of file NamedParameter.h.

Public Member Functions

 NamedParameter (const std::string &name, const T &def=T(), const std::string &helpString="")
 
 NamedParameter (const std::string &name, const std::vector< T > &defVec, const std::string &helpString="")
 
void help (const T &def)
 
size_t size () const
 
const T getVal (int i=0) const
 
 operator T () const
 
 operator T ()
 
template<class G>
bool operator== (const G &other) const
 
template<class G>
bool operator!= (const G &other) const
 
const std::vector< T > & getVector () const
 
void setVal (const T &val, int i=0)
 
void setVal (const std::vector< T > &valList)
 
 operator std::vector< T > () const
 
NamedParameter< T > & operator= (const T &d)
 
NamedParameter< T > & operator= (const std::vector< T > &v)
 
const std::string & name () const
 

Static Public Member Functions

static std::vector< T > getVectorArgument (const std::string &name, const T &default_value)
 

Protected Member Functions

bool setFromOptionsParser ()
 < The value (array) of this parameter.
 

Protected Attributes

std::string m_name
 
std::string m_helpString
 < Name of this parameter
 
std::vector< T > m_valueArray
 < The helper string for this parameter, printed if the flag –help is used.
 

Constructor & Destructor Documentation

◆ NamedParameter() [1/2]

template<class T>
AmpGen::NamedParameter< T >::NamedParameter ( const std::string & name,
const T & def = T(),
const std::string & helpString = "" )
inline

Definition at line 61 of file NamedParameter.h.

◆ NamedParameter() [2/2]

template<class T>
AmpGen::NamedParameter< T >::NamedParameter ( const std::string & name,
const std::vector< T > & defVec,
const std::string & helpString = "" )
inline

Definition at line 70 of file NamedParameter.h.

Member Function Documentation

◆ getVal()

template<class T>
const T AmpGen::NamedParameter< T >::getVal ( int i = 0) const
inline

Definition at line 97 of file NamedParameter.h.

◆ getVector()

template<class T>
const std::vector< T > & AmpGen::NamedParameter< T >::getVector ( ) const
inline

Definition at line 111 of file NamedParameter.h.

◆ getVectorArgument()

template<class T>
static std::vector< T > AmpGen::NamedParameter< T >::getVectorArgument ( const std::string & name,
const T & default_value )
inlinestatic

Definition at line 139 of file NamedParameter.h.

◆ help()

template<class T>
void AmpGen::NamedParameter< T >::help ( const T & def)
inline

Definition at line 78 of file NamedParameter.h.

◆ name()

template<class T>
const std::string & AmpGen::NamedParameter< T >::name ( ) const
inline

Definition at line 137 of file NamedParameter.h.

◆ operator std::vector< T >()

template<class T>
AmpGen::NamedParameter< T >::operator std::vector< T > ( ) const
inline

Definition at line 126 of file NamedParameter.h.

◆ operator T() [1/2]

template<class T>
AmpGen::NamedParameter< T >::operator T ( )
inline

Definition at line 108 of file NamedParameter.h.

◆ operator T() [2/2]

template<class T>
AmpGen::NamedParameter< T >::operator T ( ) const
inline

Definition at line 107 of file NamedParameter.h.

◆ operator!=()

template<class T>
template<class G>
bool AmpGen::NamedParameter< T >::operator!= ( const G & other) const
inline

Definition at line 110 of file NamedParameter.h.

◆ operator=() [1/2]

template<class T>
NamedParameter< T > & AmpGen::NamedParameter< T >::operator= ( const std::vector< T > & v)
inline

Definition at line 132 of file NamedParameter.h.

◆ operator=() [2/2]

template<class T>
NamedParameter< T > & AmpGen::NamedParameter< T >::operator= ( const T & d)
inline

Definition at line 127 of file NamedParameter.h.

◆ operator==()

template<class T>
template<class G>
bool AmpGen::NamedParameter< T >::operator== ( const G & other) const
inline

Definition at line 109 of file NamedParameter.h.

◆ setFromOptionsParser()

template<class T>
bool AmpGen::NamedParameter< T >::setFromOptionsParser ( )
inlineprotected

Definition at line 39 of file NamedParameter.h.

◆ setVal() [1/2]

template<class T>
void AmpGen::NamedParameter< T >::setVal ( const std::vector< T > & valList)
inline

Definition at line 121 of file NamedParameter.h.

◆ setVal() [2/2]

template<class T>
void AmpGen::NamedParameter< T >::setVal ( const T & val,
int i = 0 )
inline

Definition at line 113 of file NamedParameter.h.

◆ size()

template<class T>
size_t AmpGen::NamedParameter< T >::size ( ) const
inline

Definition at line 95 of file NamedParameter.h.

Member Data Documentation

◆ m_helpString

template<class T>
std::string AmpGen::NamedParameter< T >::m_helpString
protected

Definition at line 36 of file NamedParameter.h.

◆ m_name

template<class T>
std::string AmpGen::NamedParameter< T >::m_name
protected

Definition at line 35 of file NamedParameter.h.

◆ m_valueArray

template<class T>
std::vector<T> AmpGen::NamedParameter< T >::m_valueArray
protected

Definition at line 37 of file NamedParameter.h.

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