Utopia::Models::Environment::FuncBundle::ParamFuncBundle< Func, Time > Struct Template Reference

A bundle wrapping a (iterative) function with metadata. More...

#include <func_bundle.hh>

Inheritance diagram for Utopia::Models::Environment::FuncBundle::ParamFuncBundle< Func, Time >:

Collaboration diagram for Utopia::Models::Environment::FuncBundle::ParamFuncBundle< Func, Time >:

Public Member Functions
	ParamFuncBundle (std::string name, Func func, std::string param_name, bool invoke_at_initialization=true, bool invoke_always=true, std::set< Time > times={})
	ParamFuncBundle (std::string name, Func func, std::string param_name, std::tuple< bool, bool, std::set< Time > > invoke_times_tuple)
Public Member Functions inherited from Utopia::Models::Environment::FuncBundle::FuncBundle< Func, Time >
	FuncBundle (std::string name, Func func, bool invoke_at_initialization=true, bool invoke_always=true, std::set< Time > times={})
	When to invoke.

Public Attributes
std::string	param_name
	The name of the parameter to which to apply the function.
Public Attributes inherited from Utopia::Models::Environment::FuncBundle::FuncBundle< Func, Time >
std::string	name
Func	func
	The name of the function.
bool	invoke_at_initialization
	The function.
bool	invoke_always
	Whether to invoke at initialization.
std::set< Time >	times
	Whether to invoke in every timestep.

Detailed Description

template<typename Func, typename Time>
struct Utopia::Models::Environment::FuncBundle::ParamFuncBundle< Func, Time >

A bundle wrapping a (iterative) function with metadata.

This gathers a function alongside some metadata into a custom construct. The function is ment to be applied within an iterative model.

Constructor & Destructor Documentation

ParamFuncBundle() [1/2]

template<typename Func , typename Time >

Utopia::Models::Environment::FuncBundle::ParamFuncBundle< Func, Time >::ParamFuncBundle ( std::string  name, Func  func, std::string  param_name, bool  invoke_at_initialization = true, bool  invoke_always = true, std::set< Time >  times = {}  )

inline

                                 {})
    :
        FuncBundle<Func, Time>(name, func, invoke_at_initialization,
                invoke_always, times),
        param_name(param_name)
    {}

ParamFuncBundle() [2/2]

template<typename Func , typename Time >

Utopia::Models::Environment::FuncBundle::ParamFuncBundle< Func, Time >::ParamFuncBundle ( std::string  name, Func  func, std::string  param_name, std::tuple< bool, bool, std::set< Time > >  invoke_times_tuple  )

inline

    :
        ParamFuncBundle<Func, Time>(name, func, param_name,
                std::get<0>(invoke_times_tuple),
                std::get<1>(invoke_times_tuple),
                std::get<2>(invoke_times_tuple))
    {}

Member Data Documentation

param_name

template<typename Func , typename Time >

std::string Utopia::Models::Environment::FuncBundle::ParamFuncBundle< Func, Time >::param_name

The name of the parameter to which to apply the function.

---

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

• src/utopia/models/Environment/func_bundle.hh