Manages single-threaded step-by-step execution of a TaskGraphTemplate. More...

#include <GraphRuntimeInstance.h>

Collaboration diagram for Olympe::GraphRuntimeInstance:

Public Member Functions
	GraphRuntimeInstance (const TaskGraphTemplate &graph)
	Constructs an instance bound to the given graph template.

void	StartExecution ()
	Initialises the execution stack and marks the instance as running.

bool	StepExecution ()
	Advances execution by one node.

bool	IsExecuting () const
	Returns true while there are nodes left to execute.

void	SetBlackboardVariable (const std::string &key, float value)
	Sets a Blackboard variable in the runtime environment.

void	SetDynamicPinValue (const std::string &pinID, float value)
	Sets the runtime value of a dynamic data pin.

void	AddBreakpoint (int32_t nodeID)
	Registers a breakpoint on a node.

void	RemoveBreakpoint (int32_t nodeID)
	Removes a previously registered breakpoint.

bool	IsBreakpointHit () const
	Returns true when execution is paused at a breakpoint.

void	ResumeFromBreakpoint ()
	Resumes execution after a breakpoint.

const std::vector< int32_t > &	GetActiveNodeIDs () const
	Returns the IDs of all nodes currently on the execution stack.

const std::string &	GetLastError () const
	Returns the last error message produced during execution.

Private Member Functions
bool	EvaluateBranchConditions (const TaskNodeDefinition &node)
	Evaluates all NodeConditionRefs on `node` and returns the result.

Private Attributes
const TaskGraphTemplate &	m_graph
	Bound graph template (not owned)

RuntimeEnvironment	m_environment
	Blackboard + pin values.

std::vector< int32_t >	m_executionStack
	Active node IDs (front = next)

bool	m_isExecuting
	True while stack is non-empty.

bool	m_breakpointHit
	True when paused at a breakpoint.

bool	m_skipBreakpointOnce
	Skip breakpoint check for one step after Resume.

std::set< int32_t >	m_breakpoints
	Registered breakpoint node IDs.

std::string	m_lastError
	Last error from condition evaluation.

Detailed Description

Manages single-threaded step-by-step execution of a TaskGraphTemplate.

Definition at line 41 of file GraphRuntimeInstance.h.

Constructor & Destructor Documentation

◆ GraphRuntimeInstance()

Olympe::GraphRuntimeInstance::GraphRuntimeInstance ( const TaskGraphTemplate & graph )

explicit

Constructs an instance bound to the given graph template.

Call StartExecution() to begin.

Parameters

graph Immutable graph template to execute.

Definition at line 19 of file GraphRuntimeInstance.cpp.

Member Function Documentation

◆ AddBreakpoint()

void Olympe::GraphRuntimeInstance::AddBreakpoint ( int32_t nodeID )

Registers a breakpoint on a node.

When StepExecution() is about to process a node that has a breakpoint the execution pauses (StepExecution returns false without consuming the node) and IsBreakpointHit() returns true.

Parameters

nodeID Node to break on.

Definition at line 131 of file GraphRuntimeInstance.cpp.

References m_breakpoints.

◆ EvaluateBranchConditions()

bool Olympe::GraphRuntimeInstance::EvaluateBranchConditions ( const TaskNodeDefinition & node )

private

Evaluates all NodeConditionRefs on node and returns the result.

Conditions are combined with their LogicalOp (And / Or) in the order they appear in node.conditionRefs. The LogicalOp of the first entry (LogicalOp::Start) is ignored.