Olympe::ConditionPresetEvaluator Class Reference

Evaluates a ConditionPreset against a RuntimeEnvironment. More...

#include <ConditionPresetEvaluator.h>

Static Public Member Functions
static bool	Evaluate (const ConditionPreset &preset, RuntimeEnvironment &env, std::string &outErrorMsg)
	Evaluates a single ConditionPreset and returns the boolean result.
static bool	EvaluateConditionChain (const std::vector< NodeConditionRef > &conditions, const ConditionPresetRegistry &registry, RuntimeEnvironment &env, std::string &outErrorMsg)
	Evaluates a chain of conditions combined with logical operators (AND/OR).

Static Private Member Functions
static bool	ResolveOperand (const Operand &operand, RuntimeEnvironment &env, std::string &outErrorMsg, float &outValue)
	Resolves an Operand to its runtime float value.
static bool	EvaluateOperator (float left, ComparisonOp op, float right, std::string &outErrorMsg)
	Applies a ComparisonOp to two float values.

Detailed Description

Evaluates a ConditionPreset against a RuntimeEnvironment.

Typical usage:

RuntimeEnvironment env;
env.SetBlackboardVariable("mHealth", 1.0f);
 
ConditionPreset preset("p1",
    Operand::CreateVariable("mHealth"),
    ComparisonOp::LessEqual,
    Operand::CreateConst(2.0));
 
std::string error;
bool result = ConditionPresetEvaluator::Evaluate(preset, env, error);
// result == true, error == ""

For multiple conditions with logical operators:

std::vector<NodeConditionRef> conditions;
// (populated with NodeConditionRef entries referencing presets)
 
bool result = ConditionPresetEvaluator::EvaluateConditionChain(
    conditions, env, outErrorMsg);

Definition at line 69 of file ConditionPresetEvaluator.h.

Member Function Documentation

Evaluate()

bool Olympe::ConditionPresetEvaluator::Evaluate ( const ConditionPreset &  preset, RuntimeEnvironment &  env, std::string &  outErrorMsg  )

static

Evaluates a single ConditionPreset and returns the boolean result.

Parameters

preset	The condition preset to evaluate.
env	Runtime environment providing variable and pin values.
outErrorMsg	Receives a human-readable error description on failure. Empty on success.

Returns

true when the condition holds; false on failure or when the comparison evaluates to false.

Definition at line 22 of file ConditionPresetEvaluator.cpp.

References EvaluateOperator(), GetComponentTypeID_Static(), and ResolveOperand().

Referenced by EvaluateConditionChain(), Olympe::Examples::Example1_SimpleHealthCheck(), Olympe::Examples::Example2_ConstModeOperand(), and Olympe::Examples::Example6_ErrorHandling().

Here is the call graph for this function:

Here is the caller graph for this function:

EvaluateConditionChain()

bool Olympe::ConditionPresetEvaluator::EvaluateConditionChain ( const std::vector< NodeConditionRef > &  conditions, const ConditionPresetRegistry &  registry, RuntimeEnvironment &  env, std::string &  outErrorMsg  )

static

Evaluates a chain of conditions combined with logical operators (AND/OR).

Implements short-circuit evaluation:

• For AND chains: stops and returns false at the first false condition
• For OR chains: stops and returns true at the first true condition

The first condition's LogicalOp is ignored (treated as Start).

Parameters

conditions	Vector of NodeConditionRef objects referencing presets. Each preset ID is resolved via the provided registry.
registry	Registry containing the ConditionPreset objects.
env	Runtime environment providing variable and pin values.
outErrorMsg	Receives a human-readable error description on failure. Empty on success.

Returns

true when the combined condition chain evaluates to true; false on evaluation failure or when conditions are empty.

Precondition

conditions vector must not be empty.

registry must be valid (non-null).

Definition at line 42 of file ConditionPresetEvaluator.cpp.

References Olympe::And, Evaluate(), GetComponentTypeID_Static(), Olympe::Or, and Olympe::Start.

Referenced by Olympe::VSGraphExecutor::HandleBranch().

Here is the call graph for this function:

Here is the caller graph for this function:

EvaluateOperator()

bool Olympe::ConditionPresetEvaluator::EvaluateOperator ( float  left, ComparisonOp  op, float  right, std::string &  outErrorMsg  )

staticprivate

Applies a ComparisonOp to two float values.

Parameters

left	Left-hand side value.
op	Operator to apply.
right	Right-hand side value.
outErrorMsg	Receives an error description for unknown operators.

Returns

Result of the comparison, or false on unknown operator.

Definition at line 202 of file ConditionPresetEvaluator.cpp.

References Olympe::Equal, GetComponentTypeID_Static(), Olympe::Greater, Olympe::GreaterEqual, Olympe::Less, Olympe::LessEqual, and Olympe::NotEqual.

Referenced by Evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

ResolveOperand()

bool Olympe::ConditionPresetEvaluator::ResolveOperand ( const Operand &  operand, RuntimeEnvironment &  env, std::string &  outErrorMsg, float &  outValue  )

staticprivate

Resolves an Operand to its runtime float value.

Parameters

operand	Operand to resolve.
env	RuntimeEnvironment used for Variable / Pin lookup.
outErrorMsg	Receives an error description when resolution fails.
outValue	Receives the resolved float value on success.

Returns

true on success; false when the variable / pin is not found.

Definition at line 157 of file ConditionPresetEvaluator.cpp.

References Olympe::Const, GetComponentTypeID_Static(), Olympe::Pin, and Olympe::Variable.

Referenced by Evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• Source/Runtime/ConditionPresetEvaluator.h
• Source/Runtime/ConditionPresetEvaluator.cpp