maquina::PlugDescriptor::InternalDependencies Struct Reference

A plug internal dependency descriptor. More...

#include <PlugDescriptor.h>

Public Member Functions
	InternalDependencies (const char *plug_name, int time_offset=0, bool(*evaluate)(const ConditionalEvalContext &context, int dep)=nullptr)

Public Attributes
const char *	_plug_name
int	_time_offset
bool(*	_evaluate )(const ConditionalEvalContext &context, int dep) = nullptr

Detailed Description

A plug internal dependency descriptor.

Constructor & Destructor Documentation

InternalDependencies()

maquina::PlugDescriptor::InternalDependencies::InternalDependencies ( const char *  plug_name, int  time_offset = 0, bool(*)(const ConditionalEvalContext &context, int dep)  evaluate = nullptr  )

inline

Parameters

plug_name	in The internal plug name. This must be the index of the plug in the PlugDescriptor vector.
time_offset	in The time offset of the dependency.
evaluate	in An optional function to tell if the plug's dependency must be evaluated. If the function returns true (default), the internal dependency is computed and is valid during the plug's evaluation. If the function returns false, the internal dependency is not computed and no value is passed to the plug's evaluation function. That dependence value is invalid and shall not be requested. The context object can be used to get information about the current plug evaluation.

Member Data Documentation

_evaluate

bool(* maquina::PlugDescriptor::InternalDependencies::_evaluate) (const ConditionalEvalContext &context, int dep) = nullptr

_plug_name

const char* maquina::PlugDescriptor::InternalDependencies::_plug_name

_time_offset

int maquina::PlugDescriptor::InternalDependencies::_time_offset

---

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

• maquina/include/Maquina/PlugDescriptor.h