RTC Toolkit  0.1.0-alpha
runnableStateMachineLogic.hpp
Go to the documentation of this file.
1 
9 #ifndef RTCTK_COMPONENTFRAMEWORK_RUNNABLESTATEMACHINELOGIC_HPP
10 #define RTCTK_COMPONENTFRAMEWORK_RUNNABLESTATEMACHINELOGIC_HPP
11 
13 
14 namespace rtctk::componentFramework {
15 
16 class ServiceContainer;
17 
29  public:
30  RunnableStateMachineLogic(std::string const& name, ServiceContainer& services)
31  : m_name(name), m_services(services) {}
32 
33  virtual ~RunnableStateMachineLogic() = default;
34 
35  // activities
36  void Starting(StopToken st) override {}
37  void Recovering(StopToken st) override {}
38  void Initialising(StopToken st) override {}
39  void Enabling(StopToken st) override {}
40  void Disabling(StopToken st) override {}
41  void GoingRunning(StopToken st) override {}
42  void GoingIdle(StopToken st) override {}
43  void Running(StopToken st) override {}
44  void Updating(StopToken st, Payload args) override {}
45 
46  // guards
47  bool IsUpdatingAllowed(Payload args) /*noexcept*/ override {return true;}
48 
49  protected:
50  const std::string& m_name;
52 
53 };
54 
55 } // closing namespace
56 
57 #endif
rtctk::componentFramework::RunnableStateMachineLogic::m_services
ServiceContainer & m_services
Definition: runnableStateMachineLogic.hpp:51
rtctk::componentFramework::RunnableStateMachineLogic::Initialising
void Initialising(StopToken st) override
Definition: runnableStateMachineLogic.hpp:38
rtctk::componentFramework::RunnableStateMachineLogic::~RunnableStateMachineLogic
virtual ~RunnableStateMachineLogic()=default
rtctk::componentFramework::RunnableStateMachineLogic::m_name
const std::string & m_name
Definition: runnableStateMachineLogic.hpp:50
rtctk::componentFramework::RunnableStateMachineLogic::GoingRunning
void GoingRunning(StopToken st) override
Definition: runnableStateMachineLogic.hpp:41
rtctk::componentFramework
Definition: rtcComponent.hpp:17
rtctk::componentFramework::RunnableStateMachineLogic::Starting
void Starting(StopToken st) override
Definition: runnableStateMachineLogic.hpp:36
rtctk::componentFramework::RunnableStateMachineLogicIf
Definition: runnableStateMachineLogicIf.hpp:26
rtctk::componentFramework::StopToken
rad::StopToken StopToken
Definition: stopToken.hpp:16
rtctk::componentFramework::RunnableStateMachineLogic::Disabling
void Disabling(StopToken st) override
Definition: runnableStateMachineLogic.hpp:40
rtctk::componentFramework::RunnableStateMachineLogic::Updating
void Updating(StopToken st, Payload args) override
Definition: runnableStateMachineLogic.hpp:44
rtctk::componentFramework::Payload
std::string Payload
Definition: runnableStateMachineLogicIf.hpp:17
rtctk::componentFramework::ServiceContainer
Definition: serviceContainer.hpp:31
rtctk::componentFramework::RunnableStateMachineLogic::RunnableStateMachineLogic
RunnableStateMachineLogic(std::string const &name, ServiceContainer &services)
Definition: runnableStateMachineLogic.hpp:30
rtctk::componentFramework::RunnableStateMachineLogic::Recovering
void Recovering(StopToken st) override
Definition: runnableStateMachineLogic.hpp:37
rtctk::componentFramework::RunnableStateMachineLogic::IsUpdatingAllowed
bool IsUpdatingAllowed(Payload args) override
Definition: runnableStateMachineLogic.hpp:47
rtctk::componentFramework::RunnableStateMachineLogic
Definition: runnableStateMachineLogic.hpp:28
rtctk::componentFramework::RunnableStateMachineLogic::Running
void Running(StopToken st) override
Definition: runnableStateMachineLogic.hpp:43
runnableStateMachineLogicIf.hpp
Life-Cycle Interface of the Runnable State Machine.
rtctk::componentFramework::RunnableStateMachineLogic::GoingIdle
void GoingIdle(StopToken st) override
Definition: runnableStateMachineLogic.hpp:42
rtctk::componentFramework::RunnableStateMachineLogic::Enabling
void Enabling(StopToken st) override
Definition: runnableStateMachineLogic.hpp:39