rtctk::componentFramework::RunnableStateMachineLogicIf Class Reference

#include <runnableStateMachineLogicIf.hpp>

Inheritance diagram for rtctk::componentFramework::RunnableStateMachineLogicIf:

Public Member Functions
virtual	~RunnableStateMachineLogicIf ()=default
virtual void	Starting (StopToken st)=0
virtual void	Initialising (StopToken st)=0
virtual void	Enabling (StopToken st)=0
virtual void	GoingRunning (StopToken st)=0
virtual void	Running (StopToken st)=0
virtual void	GoingIdle (StopToken st)=0
virtual void	Disabling (StopToken st)=0
virtual void	Recovering (StopToken st)=0
virtual void	Updating (StopToken st, Payload args)=0
virtual bool	IsUpdatingAllowed (Payload args)=0

Detailed Description

Interface representing the life-cycle of the Runnable State Machine.

Implement the virtual methods in this class to create an RTC Component with custom behavior.

Constructor & Destructor Documentation

~RunnableStateMachineLogicIf()

virtual rtctk::componentFramework::RunnableStateMachineLogicIf::~RunnableStateMachineLogicIf ( )

virtualdefault

Member Function Documentation

Disabling()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::Disabling ( StopToken  st )

pure virtual

Activity On::Operational::Disabling

Activity method to to back to NotOperational, e.g. stop threads, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, and rtctk::telSub::BusinessLogic.

Enabling()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::Enabling ( StopToken  st )

pure virtual

Activity On::NotOperational::Enabling

Activity method to prepare the component for operation, e.g. start threads, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, and rtctk::telSub::BusinessLogic.

GoingIdle()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::GoingIdle ( StopToken  st )

pure virtual

Activity On::Operational::GoingIdle

Activity method to leave state running, e.g. turn off receivers, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, and rtctk::telSub::BusinessLogic.

GoingRunning()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::GoingRunning ( StopToken  st )

pure virtual

Activity On::Operational::GoingRunning

Activity method to prepare to run, e.g. start receiving data, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, and rtctk::telSub::BusinessLogic.

Initialising()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::Initialising ( StopToken  st )

pure virtual

Activity On::NotOperational::Initialising

Activity method to initialise the component, e.g. construct members, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, and rtctk::telSub::BusinessLogic.

IsUpdatingAllowed()

virtual bool rtctk::componentFramework::RunnableStateMachineLogicIf::IsUpdatingAllowed ( Payload  args )

pure virtual

Guard IsUpdatingAllowed

Guard method to further constrain whether an Update command is allowed to cause an Updating activity or not. Simply set the return value to configure as needed.

Parameters

args	Payload, to be able to receive information on what to update

Returns

false if update is dissalowed.

true, if update is allowed.

Implemented in rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, and rtctk::telSub::BusinessLogic.

Recovering()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::Recovering ( StopToken  st )

pure virtual

Activity Operational::Recovering

Activity method to recover from error in On::Operational::Error, after successful recovery the state machine will transition to state On::Operational::Idle

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, and rtctk::exampleComponent::ExampleBusinessLogic.

Running()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::Running ( StopToken  st )

pure virtual

Activity On::Operational::Running

Activity method for state running, e.g. receive, compute, send

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, and rtctk::telSub::BusinessLogic.

Starting()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::Starting ( StopToken  st )

pure virtual

Activity On::NotOperational::Starting

Activity method to perfrom setup work after start and reset of component.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, and rtctk::telSub::BusinessLogic.

Updating()

virtual void rtctk::componentFramework::RunnableStateMachineLogicIf::Updating ( StopToken  st, Payload  args  )

pure virtual

Activity Operational::Updating

Activity method to update dynamic component configuration. On default updates are only allowed ins states. On::Operational::Idle and On::Operational::Running.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate
args	Payload, to be able to receive information on what to update

Implemented in rtctk::telRepub::TelRepubBusinessLogic, rtctk::componentFramework::RunnableStateMachineLogic, rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >, rtctk::exampleDataTask::BusinessLogic< ComputationType, TopicType >, rtctk::rtcSupervisor::RtcSupervisor, rtctk::exampleComponent::ExampleBusinessLogic, and rtctk::telSub::BusinessLogic.

---

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

• componentFramework/stateMachine/runnableStateMachine/src/include/rtctk/componentFramework/runnableStateMachineLogicIf.hpp