runnableStateMachineLogicIf.hpp

Go to the documentation of this file.

 
#ifndef RTCTK_COMPONENTFRAMEWORK_RUNNABLESTATEMACHINELOGICIF_HPP
#define RTCTK_COMPONENTFRAMEWORK_RUNNABLESTATEMACHINELOGICIF_HPP
 
#include "rtctk/componentFramework/stopToken.hpp"
 
namespace rtctk::componentFramework {
 
// TODO: the exact type of Payload still needs to be worked out.
using Payload = std::string;
 
 
class RunnableStateMachineLogicIf {
    public:
        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) /*noexcept*/  = 0 ;
};
 
} // closing namespace
 
#endif