Utopia::Models::Environment::FuncBundle::FuncBundle< 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::FuncBundle< Func, Time >:

Public Member Functions
	FuncBundle (std::string name, Func func, bool invoke_at_initialization=true, bool invoke_always=true, std::set< Time > times={})
	When to invoke. More...

Public Attributes
std::string	name
Func	func
	The name of the function. More...
bool	invoke_at_initialization
	The function. More...
bool	invoke_always
	Whether to invoke at initialization. More...
std::set< Time >	times
	Whether to invoke in every timestep. More...

Detailed Description

template<typename Func, typename Time>
struct Utopia::Models::Environment::FuncBundle::FuncBundle< 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

FuncBundle()

template<typename Func , typename Time >

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 = {}  )

inline

When to invoke.

Member Data Documentation

func

template<typename Func , typename Time >

Func Utopia::Models::Environment::FuncBundle::FuncBundle< Func, Time >::func

The name of the function.

invoke_always

template<typename Func , typename Time >

bool Utopia::Models::Environment::FuncBundle::FuncBundle< Func, Time >::invoke_always

Whether to invoke at initialization.

invoke_at_initialization

template<typename Func , typename Time >

bool Utopia::Models::Environment::FuncBundle::FuncBundle< Func, Time >::invoke_at_initialization

The function.

name

template<typename Func , typename Time >

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

times

template<typename Func , typename Time >

std::set<Time> Utopia::Models::Environment::FuncBundle::FuncBundle< Func, Time >::times

Whether to invoke in every timestep.

---

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

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