Parameters< FP > Class Template Reference

CPP API: mio::omseirs4::Parameters< FP > Class Template Reference
mio::omseirs4::Parameters< FP > Class Template Reference

#include <parameters.h>

Inheritance diagram for mio::omseirs4::Parameters< FP >:
Collaboration diagram for mio::omseirs4::Parameters< FP >:

Public Member Functions

bool apply_constraints ()
 
bool check_constraints () const
 
 Parameters ()
 
- Public Member Functions inherited from mio::ParameterSet< Tags >
template<class Tag >
ParameterTagTraits< Tag >::Type & get ()
 get value of a parameter More...
 
template<class Tag >
const ParameterTagTraits< Tag >::Type & get () const
 get value of a parameter More...
 
bool operator!= (const ParameterSet &b) const
 
bool operator== (const ParameterSet &b) const
 
template<class Dummy = void, class = std::enable_if_t< details::AllOf<has_get_default_member_function, ParameterTagTraits<Tags>...>::value, Dummy>>
 ParameterSet ()
 default initializing constructor Initializes each parameter using either the get_default function defined in the parameter tag or the default constructor. More...
 
template<class Dummy = void, class = std::enable_if_t<details::AllOf<std::is_default_constructible, typename Tags::Type...>::value, Dummy>>
 ParameterSet (NoDefaultInit)
 Non-initializing default constructor. More...
 
template<class T1 , class... TN, class = std::enable_if_t< !std::is_same_v<std::decay_t<T1>, ParameterSet> && details::AllOf<details::BindTail<has_get_default_member_function, T1, TN...>::template type, ParameterTagTraits<Tags>...>::value>>
 ParameterSet (T1 &&arg1, TN &&... argn)
 default initializing constructor. More...
 
template<class IOContext >
void serialize (IOContext &io) const
 serialize this. More...
 
template<class Tag >
void set (const typename ParameterTagTraits< Tag >::Type &value)
 set value of a parameter More...
 
template<class Tag , class T >
void set (T &&arg)
 set value of a parameter More...
 
template<class Tag , class... T>
std::enable_if_t< has_get_default_member_function< ParameterTagTraits< Tag >, T... >::value, void > set_default (T &&... ts)
 (re)set parameter to its default value More...
 

Static Public Member Functions

template<class IOContext >
static IOResult< Parametersdeserialize (IOContext &io)
 deserialize an object of this class. More...
 
- Static Public Member Functions inherited from mio::ParameterSet< Tags >
template<class IOContext >
static IOResult< ParameterSetdeserialize (IOContext &io)
 deserialize an object of this class. More...
 
static constexpr size_t size ()
 returns the number of parameters More...
 

Private Member Functions

 Parameters (ParametersBase< FP > &&base)
 

Constructor & Destructor Documentation

◆ Parameters() [1/2]

template<typename FP = ScalarType>
mio::omseirs4::Parameters< FP >::Parameters ( )
inline

◆ Parameters() [2/2]

template<typename FP = ScalarType>
mio::omseirs4::Parameters< FP >::Parameters ( ParametersBase< FP > &&  base)
inlineprivate

Member Function Documentation

◆ apply_constraints()

template<typename FP = ScalarType>
bool mio::omseirs4::Parameters< FP >::apply_constraints ( )
inline

◆ check_constraints()

template<typename FP = ScalarType>
bool mio::omseirs4::Parameters< FP >::check_constraints ( ) const
inline

◆ deserialize()

template<typename FP = ScalarType>
template<class IOContext >
static IOResult<Parameters> mio::omseirs4::Parameters< FP >::deserialize ( IOContext &  io)
inlinestatic

deserialize an object of this class.

See also
mio::deserialize