rtctk::componentFramework::Measurable< Super > Struct Template Reference

Life cycle extension to make RtcComponent Measurable. More...

#include <rtctk/componentFramework/measurable.hpp>

Inheritance diagram for rtctk::componentFramework::Measurable< Super >:

Classes
class	BizLogicIf
	Business logic interface for Measurable mixin. More...
class	InputStage
class	ModelBuilder
class	OutputStage

Detailed Description

template<typename Super>
struct rtctk::componentFramework::Measurable< Super >

Life cycle extension to make RtcComponent Measurable.

Notable states

• On::Operational:Measure:Idle – No measurement is active.
• On::Operational:Measure:Busy – A measurement is active.

Notable events

• events.Measure – Event created from the MeasCmds.Measure MAL command, containing a JSON encoded string with arguments to the measurement activity. If this event is received in On::Operational:Measure:Idle the BizLogicIf::GuardMeasuringAllowed will be invoked to determine if measurement activity can be started with the provided argument.
• events.MeasureDone – Event created if the Activity.Measure succeeds.
• events.MeasureError – Event created if the Activity.Measure fails and contains a rtctk::componentFramework::RtctkException that will be used as command reply.

Notable activities

• Activity.Measuring – Activity started when events.Measure triggers transition to On::Operational:Measure:Busy (guarded by BizLogicIf::GuardMeasuringAllowed). The activity method is BizLogicIf::ActivityMeasuring.

Assumptions

Note

Measurable assumes that no external party modifies the state machine so it affects states, transitions, actions or guards added by this mixin. Doing so may lead to undefined behaviour and crashes.

---

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

• componentFramework/rtcComponent/lib/src/include/rtctk/componentFramework/measurable.hpp