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

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

#include <rtctk/componentFramework/optimisable.hpp>

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

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

Detailed Description

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

Life cycle extension to make RtcComponent Optimisable.

Notable states

• On::Operational:Optimise:Idle – No optimisation is in progress.
• On::Operational:Optimise:Busy – An optimisation is in progress.

Notable events

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

Notable activities

• Activity.Optimise – Activity started when events.Optimise triggers transition to On::Operational:Optimise:Busy (guarded by BizLogicIf::GuardOptimisingAllowed). The activity method is BizLogicIf::ActivityOptimising.

---

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

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