Public Member Functions | List of all members
spore::GetStatus Class Reference

Generic parameter getter class. More...

#include <param_utils.h>

Public Member Functions

 GetStatus (DictionaryDatum &d)
 
template<typename T >
void parameter (const T &val, const Name &name, T)
 Define parameter without constraint. More...
 
template<typename T >
void parameter (const T &val, const Name &name, T, const pc::Con< T > &)
 Define parameter with 1 constraint. More...
 
template<typename T >
void parameter (const T &val, const Name &name, T, const pc::Con< T > &, const pc::Con< T > &)
 Define parameter with 2 constraints. More...
 
template<typename T >
void parameter (const T &val, const Name &name, T, const pc::Con< T > &, const pc::Con< T > &, const pc::Con< T > &)
 Define parameter with 3 constraints. More...
 

Detailed Description

Generic parameter getter class.

Constructor & Destructor Documentation

◆ GetStatus()

spore::GetStatus::GetStatus ( DictionaryDatum &  d)

Constructor.

Member Function Documentation

◆ parameter() [1/4]

template<typename T >
void spore::GetStatus::parameter ( const T &  val,
const Name &  name,
 
)
inline

Define parameter without constraint.

Parameters
valReference to the variable that holds the parameter.
nameThe name assigned to the parameter.
default_valdefault value of the parameter.

◆ parameter() [2/4]

template<typename T >
void spore::GetStatus::parameter ( const T &  val,
const Name &  name,
,
const pc::Con< T > &   
)
inline

Define parameter with 1 constraint.

Parameters
valReference to the variable that holds the parameter.
nameThe name assigned to the parameter.
default_valdefault value of the parameter.
con1constraint to the parameter.

◆ parameter() [3/4]

template<typename T >
void spore::GetStatus::parameter ( const T &  val,
const Name &  name,
,
const pc::Con< T > &  ,
const pc::Con< T > &   
)
inline

Define parameter with 2 constraints.

Parameters
valReference to the variable that holds the parameter.
nameThe name assigned to the parameter.
default_valdefault value of the parameter.
con1,con2constraints to the parameter.

◆ parameter() [4/4]

template<typename T >
void spore::GetStatus::parameter ( const T &  val,
const Name &  name,
,
const pc::Con< T > &  ,
const pc::Con< T > &  ,
const pc::Con< T > &   
)
inline

Define parameter with 3 constraints.

Parameters
valReference to the variable that holds the parameter.
nameThe name assigned to the parameter.
default_valdefault value of the parameter.
con1,con2,con3constraints to the parameter.

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