A bundle wrapping a (rule-)function with metadata. More...

#include <func_bundle.hh>

Inheritance diagram for Utopia::Models::Environment::FuncBundle::RuleFuncBundle< RuleFunc, Time, CellContainer >:

Collaboration diagram for Utopia::Models::Environment::FuncBundle::RuleFuncBundle< RuleFunc, Time, CellContainer >:

Public Member Functions
	RuleFuncBundle (std::string name, RuleFunc func, Update update=Update::sync, bool invoke_at_initialization=true, bool invoke_always=true, std::set< Time > times={}, bool fix_selection=false, const CellContainer &cell_selection={}, const DataIO::Config &select_cfg={})

	RuleFuncBundle (std::string name, RuleFunc func, Update update, bool invoke_at_initialization, std::pair< bool, std::set< Time >> times_pair, std::tuple< bool, CellContainer, DataIO::Config > select_tuple)

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

Public Attributes
Update	update
	The update mode of the RuleFunc. More...

bool	fix_selection
	Whether the selection of cells is fixed. More...

CellContainer	cell_selection
	Cell container over which to apply the func, optional. More...

DataIO::Config	select_cfg
	Config node that is passed to the select_cells of the cell manager. More...

Public Attributes inherited from Utopia::Models::Environment::FuncBundle::FuncBundle< RuleFunc, Time >
std::string	name

RuleFunc	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 RuleFunc, typename Time, typename CellContainer>
struct Utopia::Models::Environment::FuncBundle::RuleFuncBundle< RuleFunc, Time, CellContainer >

A bundle wrapping a (rule-)function with metadata.

This gathers a rule function alongside some metadata into a custom construct. It can (optional) carry its own cellcontainer or a Config how to select cells from the cell manager.