rtctk::exampleComponent::ExampleBusinessLogic Class Reference

#include <exampleBusinessLogic.hpp>

Inheritance diagram for rtctk::exampleComponent::ExampleBusinessLogic:

Public Member Functions
	ExampleBusinessLogic (const std::string &name, rtctk::componentFramework::ServiceContainer &services)
virtual	~ExampleBusinessLogic ()=default
void	Starting (rtctk::componentFramework::StopToken st) override
void	Initialising (rtctk::componentFramework::StopToken st) override
void	Enabling (rtctk::componentFramework::StopToken st) override
void	Disabling (rtctk::componentFramework::StopToken st) override
void	GoingRunning (rtctk::componentFramework::StopToken st) override
void	GoingIdle (rtctk::componentFramework::StopToken st) override
void	Running (rtctk::componentFramework::StopToken st) override
void	Recovering (rtctk::componentFramework::StopToken st) override
void	Updating (rtctk::componentFramework::StopToken st, rtctk::componentFramework::Payload args) override
bool	IsUpdatingAllowed (rtctk::componentFramework::Payload args) override
Public Member Functions inherited from rtctk::componentFramework::RunnableStateMachineLogic
	RunnableStateMachineLogic (std::string const &name, ServiceContainer &services)
virtual	~RunnableStateMachineLogic ()=default
void	Starting (StopToken st) override
void	Recovering (StopToken st) override
void	Initialising (StopToken st) override
void	Enabling (StopToken st) override
void	Disabling (StopToken st) override
void	GoingRunning (StopToken st) override
void	GoingIdle (StopToken st) override
void	Running (StopToken st) override
void	Updating (StopToken st, Payload args) override
bool	IsUpdatingAllowed (Payload args) override
Public Member Functions inherited from rtctk::componentFramework::RunnableStateMachineLogicIf
virtual	~RunnableStateMachineLogicIf ()=default

Additional Inherited Members
Protected Attributes inherited from rtctk::componentFramework::RunnableStateMachineLogic
const std::string &	m_name
ServiceContainer &	m_services

Constructor & Destructor Documentation

ExampleBusinessLogic()

rtctk::exampleComponent::ExampleBusinessLogic::ExampleBusinessLogic	(	const std::string &	name,
		rtctk::componentFramework::ServiceContainer &	services
	)

~ExampleBusinessLogic()

virtual rtctk::exampleComponent::ExampleBusinessLogic::~ExampleBusinessLogic ( )

virtualdefault

Member Function Documentation

Disabling()

void rtctk::exampleComponent::ExampleBusinessLogic::Disabling ( rtctk::componentFramework::StopToken  st )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

Enabling()

void rtctk::exampleComponent::ExampleBusinessLogic::Enabling ( rtctk::componentFramework::StopToken  st )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

GoingIdle()

void rtctk::exampleComponent::ExampleBusinessLogic::GoingIdle ( rtctk::componentFramework::StopToken  st )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

GoingRunning()

void rtctk::exampleComponent::ExampleBusinessLogic::GoingRunning ( rtctk::componentFramework::StopToken  st )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

Initialising()

void rtctk::exampleComponent::ExampleBusinessLogic::Initialising ( rtctk::componentFramework::StopToken  st )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

IsUpdatingAllowed()

bool rtctk::exampleComponent::ExampleBusinessLogic::IsUpdatingAllowed ( rtctk::componentFramework::Payload  args )

overridevirtual

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.

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

Recovering()

void rtctk::exampleComponent::ExampleBusinessLogic::Recovering ( rtctk::componentFramework::StopToken  st )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

Running()

void rtctk::exampleComponent::ExampleBusinessLogic::Running ( rtctk::componentFramework::StopToken  st )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

Starting()

void rtctk::exampleComponent::ExampleBusinessLogic::Starting ( rtctk::componentFramework::StopToken  st )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

Updating()

void rtctk::exampleComponent::ExampleBusinessLogic::Updating ( rtctk::componentFramework::StopToken  st, rtctk::componentFramework::Payload  args  )

overridevirtual

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

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

---

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

• _examples/exampleComponent/app/src/exampleBusinessLogic.hpp
• _examples/exampleComponent/app/src/exampleBusinessLogic.cpp