RTC Toolkit  0.1.0-alpha
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType > Class Template Reference

#include <businessLogicGpu.hpp>

Inheritance diagram for rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >:
rtctk::componentFramework::RunnableStateMachineLogic rtctk::componentFramework::RunnableStateMachineLogicIf

Public Member Functions

 BusinessLogicGpu (const std::string &name, rtctk::componentFramework::ServiceContainer &services)
 
virtual ~BusinessLogicGpu ()
 
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::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
 

Protected Member Functions

template<typename T >
GetParam (std::string const &path)
 

Protected Attributes

RuntimeRepoApiIfm_rtr
 
OldbApiIfm_oldb
 
std::unique_ptr< ComputationType > m_computation
 
std::unique_ptr< ReaderThread< TopicType, ReaderType > > m_reader
 
- Protected Attributes inherited from rtctk::componentFramework::RunnableStateMachineLogic
const std::string & m_name
 
ServiceContainerm_services
 

Constructor & Destructor Documentation

◆ BusinessLogicGpu()

template<class ComputationType , class TopicType >
rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::BusinessLogicGpu ( const std::string &  name,
rtctk::componentFramework::ServiceContainer services 
)
inline

◆ ~BusinessLogicGpu()

template<class ComputationType , class TopicType >
virtual rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::~BusinessLogicGpu ( )
inlinevirtual

Member Function Documentation

◆ Disabling()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::Disabling ( StopToken  st)
inlineoverridevirtual

Activity On::Operational::Disabling

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

Parameters
stStopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Enabling()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::Enabling ( StopToken  st)
inlineoverridevirtual

Activity On::NotOperational::Enabling

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

Parameters
stStopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ GetParam()

template<class ComputationType , class TopicType >
template<typename T >
T rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::GetParam ( std::string const &  path)
inlineprotected

◆ GoingIdle()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::GoingIdle ( StopToken  st)
inlineoverridevirtual

Activity On::Operational::GoingIdle

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

Parameters
stStopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ GoingRunning()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::GoingRunning ( StopToken  st)
inlineoverridevirtual

Activity On::Operational::GoingRunning

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

Parameters
stStopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Initialising()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::Initialising ( StopToken  st)
inlineoverridevirtual

Activity On::NotOperational::Initialising

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

Parameters
stStopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ IsUpdatingAllowed()

template<class ComputationType , class TopicType >
bool rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::IsUpdatingAllowed ( Payload  args)
inlineoverridevirtual

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
argsPayload, 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()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::Recovering ( StopToken  st)
inlineoverridevirtual

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
stStopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Running()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::Running ( StopToken  st)
inlineoverridevirtual

Activity On::Operational::Running

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

Parameters
stStopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Starting()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::Starting ( StopToken  st)
inlineoverridevirtual

Activity On::NotOperational::Starting

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

Parameters
stStopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Updating()

template<class ComputationType , class TopicType >
void rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::Updating ( StopToken  st,
Payload  args 
)
inlineoverridevirtual

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
stStopToken, to get notified when the activity is supposed to terminate
argsPayload, to be able to receive information on what to update

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

Member Data Documentation

◆ m_computation

template<class ComputationType , class TopicType >
std::unique_ptr<ComputationType> rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::m_computation
protected

◆ m_oldb

template<class ComputationType , class TopicType >
OldbApiIf& rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::m_oldb
protected

◆ m_reader

template<class ComputationType , class TopicType >
std::unique_ptr<ReaderThread<TopicType,ReaderType> > rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::m_reader
protected

◆ m_rtr

template<class ComputationType , class TopicType >
RuntimeRepoApiIf& rtctk::exampleDataTask::BusinessLogicGpu< ComputationType, TopicType >::m_rtr
protected

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