state.hpp

Go to the documentation of this file.

 
#ifndef FGF_COM_STATE_HPP_H_
#define FGF_COM_STATE_HPP_H_
 
#include <boost/signals2.hpp>
#include <boost/bimap.hpp>
#include <boost/assign.hpp>
#include <boost/algorithm/string.hpp>
 
namespace ifw::fgf::common {
 
   // State and substate definitions
   constexpr auto KEY_STATUS_SUBSYS_STATE       = "state";
   constexpr auto KEY_STATUS_SUBSYS_SUBSTATE    = "substate";
 
   constexpr auto STATE_UNDEFINED_STR           = "Undefined";
   constexpr auto STATE_NOT_OP_ERROR_STR        = "NotOpError";
   constexpr auto STATE_ERROR_STR               = "Error";
   constexpr auto STATE_OFF_STR                 = "Off";
   constexpr auto STATE_NOT_OPERATIONAL_STR     = "NotOperational";
   constexpr auto STATE_OPERATIONAL_STR         = "Operational";
 
   constexpr auto  SUBSTATE_NOTREADY_STR        = "NotReady";
   constexpr auto  SUBSTATE_INITIALISING_STR    = "Initialising";
   constexpr auto  SUBSTATE_READY_STR           = "Ready";
   constexpr auto  SUBSTATE_ENABLING_STR        = "Enabling";
   constexpr auto  SUBSTATE_RECOVERING_STR      = "Recovering";
   constexpr auto  SUBSTATE_IDLE_STR            = "Idle";
   constexpr auto  SUBSTATE_BUSY_STR            = "Busy";
 
   constexpr auto  SUBSTATE_ACQUIRING_STR       = "Acquiring";
 
   struct State {
   public:
 
      enum class StateEnum : short {
         OFF              = -8,
         UNDEFINED        = -7,
         NOT_OPERATIONAL  = 1,
         OPERATIONAL      = 2
      };
 
      enum class SubstateEnum : short {
         UNDEFINED        = 90,
         ERROR            = 95,
         NOT_OP_NOT_READY = 100,
         INITIALISING     = 101,
         NOT_OP_READY     = 102,
         ENABLING         = 103,
         IDLE             = 110,
         BUSY             = 115,
         ACQUIRING        = 130
 
      };
 
      using StateNumMap_t = boost::bimap<std::string, StateEnum>;
      using SubstateNumMap_t = boost::bimap<std::string, SubstateEnum>;
 
      // C++17 feature: you can define static members when they are inline.
      // Used BOOST bidirectional maps.
      inline static StateNumMap_t StateMap = 
         boost::assign::list_of<State::StateNumMap_t::relation>
               (STATE_OFF_STR,              StateEnum::OFF)
               (STATE_UNDEFINED_STR,        StateEnum::UNDEFINED)
               (STATE_NOT_OPERATIONAL_STR,  StateEnum::NOT_OPERATIONAL)
               (STATE_OPERATIONAL_STR,      StateEnum::OPERATIONAL);
 
      inline static SubstateNumMap_t SubstateMap = 
         boost::assign::list_of<State::SubstateNumMap_t::relation>
               (STATE_UNDEFINED_STR,        SubstateEnum::UNDEFINED)
               (STATE_ERROR_STR,            SubstateEnum::ERROR)
               (SUBSTATE_NOTREADY_STR,      SubstateEnum::NOT_OP_NOT_READY)
               (SUBSTATE_INITIALISING_STR,  SubstateEnum::INITIALISING)
               (SUBSTATE_READY_STR,         SubstateEnum::NOT_OP_READY)
               (SUBSTATE_ENABLING_STR,      SubstateEnum::ENABLING)
               (SUBSTATE_IDLE_STR,          SubstateEnum::IDLE)
               (SUBSTATE_BUSY_STR,          SubstateEnum::BUSY)
               (SUBSTATE_ACQUIRING_STR,     SubstateEnum::ACQUIRING);
 
      inline static std::optional<StateEnum> GetState(const std::string& state);
 
      inline static std::optional<std::string> GetStateStr(const StateEnum state);
 
      inline static std::optional<SubstateEnum> GetSubstate(const std::string& substate);
 
      inline static std::optional<std::string> GetSubstateStr(const SubstateEnum substate);
 
   };
 
}
 
#include "state.ipp"
 
#endif // FGF_COM_STATE_HPP_H_