xronos::sdk::BaseReaction::MetricEffect Class Reference

A reaction's effect on a Metric. More...

#include <xronos/sdk/reaction.hh>

Public Member Functions
	MetricEffect (Metric &metric, const ReactionContext &context)
	Constructor.
void	record (double value)
	Record a value at the current timestamp.
void	record (std::int64_t value)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Detailed Description

A reaction's effect on a Metric.

Through it the handler records values.

Constructor & Destructor Documentation

MetricEffect()

xronos::sdk::BaseReaction::MetricEffect::MetricEffect	(	Metric &	metric,
		const ReactionContext &	context )

Constructor.

Parameters

metric	The Metric for which the reaction should be able to record data.
context	The context of the reaction the effect is declared for. Can be obtained using context().

Member Function Documentation

record()

void xronos::sdk::BaseReaction::MetricEffect::record

(

double

value

)

Record a value at the current timestamp.

Parameters

value

The value to record.

Exceptions

ValidationError

If called before execution has started.

---

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

• sdk/reaction.hh