spore::CheckParameters Class Reference

Generic class to check parameters. More...

#include <param_utils.h>

Public Member Functions
	CheckParameters (const DictionaryDatum &d)
template<typename T >
void	parameter (const T &, const Name &, T)
	Define parameter without constraint. More...
template<typename T >
void	parameter (const T &, const Name &name, T, const pc::Con< T > &con1)
	Define parameter with 1 constraint. More...
template<typename T >
void	parameter (const T &, const Name &name, T, const pc::Con< T > &con1, const pc::Con< T > &con2)
	Define parameter with 2 constraints. More...
template<typename T >
void	parameter (const T &, const Name &name, T, const pc::Con< T > &con1, const pc::Con< T > &con2, const pc::Con< T > &con3)
	Define parameter with 3 constraints. More...

Detailed Description

Generic class to check parameters.

Constructor & Destructor Documentation

CheckParameters()

spore::CheckParameters::CheckParameters

(

const DictionaryDatum &

d

)

Constructor.

Member Function Documentation

parameter() [1/4]

template<typename T >

void spore::CheckParameters::parameter ( const T &  , const Name &  , T    )

inline

Define parameter without constraint.

Parameters

val	Reference to the variable that holds the parameter.
name	The name assigned to the parameter.
default_val	default value of the parameter.

parameter() [2/4]

template<typename T >

void spore::CheckParameters::parameter ( const T &  , const Name &  name, T  , const pc::Con< T > &  con1  )

inline

Define parameter with 1 constraint.

Parameters

val	Reference to the variable that holds the parameter.
name	The name assigned to the parameter.
default_val	default value of the parameter.
con1	constraint to the parameter.

parameter() [3/4]

template<typename T >

void spore::CheckParameters::parameter ( const T &  , const Name &  name, T  , const pc::Con< T > &  con1, const pc::Con< T > &  con2  )

inline

Define parameter with 2 constraints.

Parameters

val	Reference to the variable that holds the parameter.
name	The name assigned to the parameter.
default_val	default value of the parameter.
con1,con2	constraints to the parameter.

parameter() [4/4]

template<typename T >

void spore::CheckParameters::parameter ( const T &  , const Name &  name, T  , const pc::Con< T > &  con1, const pc::Con< T > &  con2, const pc::Con< T > &  con3  )

inline

Define parameter with 3 constraints.

Parameters

val	Reference to the variable that holds the parameter.
name	The name assigned to the parameter.
default_val	default value of the parameter.
con1,con2,con3	constraints to the parameter.

---

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

• param_utils.h
• param_utils.cpp