RTC Toolkit  0.1.0-alpha
rtcSupervisorLib.hpp
Go to the documentation of this file.
1 
9 #ifndef RTCTK_RTCSUPERVISORLIB_HPP_
10 #define RTCTK_RTCSUPERVISORLIB_HPP_
11 
15 
16 
17 // System headers
18 #include <unordered_map>
19 
20 namespace rtctk::rtcSupervisor {
21 
22  // Constants for state values
23  // TODO, need to work out what we do in terms of ordering states/substates
24  typedef enum {
30  } RtcState;
31 
32  // Constants for substate values
33  // TODO, need to work out what we do in terms of ordering states/substates
34  // There is a method in the rtcObject class EvaluatePrimarySubstate which does
35  // the conversion
36  typedef enum {
48  } RtcSubState;
49 
50  const std::string SRV_STATE_NOT_OPERATIONAL_STR = "NotOperational";
51  const std::string SRV_STATE_OPERATIONAL_STR = "Operational";
52  const std::string SRV_STATE_UNAVAILABLE_STR = "Unavailable";
53 
54  const std::string SRV_SUBSTATE_NOTREADY_STR = "NotReady";
55  const std::string SRV_SUBSTATE_READY_STR = "Ready";
56  const std::string SRV_SUBSTATE_IDLE_STR = "Idle";
57  const std::string SRV_SUBSTATE_INITIALISING_STR = "Initialising";
58  const std::string SRV_SUBSTATE_ENABLING_STR = "Enabling";
59  const std::string SRV_SUBSTATE_DISABLING_STR = "Disabling";
60  const std::string SRV_SUBSTATE_GOING_RUNNING_STR = "GoingRunning";
61  const std::string SRV_SUBSTATE_GOING_IDLE_STR = "GoingIdle";
62  const std::string SRV_SUBSTATE_ERROR_STR = "Error";
63 
64 
65  typedef enum {
74  } RtcCommand;
75 
76 }
77 
78 
79 #endif
rtctk::rtcSupervisor::rtcSTOP
@ rtcSTOP
Definition: rtcSupervisorLib.hpp:66
rtctk::rtcSupervisor
Definition: rtcCommandRequest.hpp:17
rtctk::rtcSupervisor::SRV_STATE_MAX_STATE
@ SRV_STATE_MAX_STATE
Definition: rtcSupervisorLib.hpp:29
rtctk::rtcSupervisor::SRV_SUBSTATE_INITIALISING
@ SRV_SUBSTATE_INITIALISING
Definition: rtcSupervisorLib.hpp:41
exceptions.hpp
Provides macros and utilities for exception handling.
rtctk::rtcSupervisor::SRV_SUBSTATE_DISABLING
@ SRV_SUBSTATE_DISABLING
Definition: rtcSupervisorLib.hpp:43
rtctk::rtcSupervisor::SRV_SUBSTATE_ERROR_STR
const std::string SRV_SUBSTATE_ERROR_STR
Definition: rtcSupervisorLib.hpp:62
rtctk::rtcSupervisor::SRV_SUBSTATE_RUNNING
@ SRV_SUBSTATE_RUNNING
Definition: rtcSupervisorLib.hpp:46
rtctk::rtcSupervisor::SRV_STATE_OPERATIONAL
@ SRV_STATE_OPERATIONAL
Definition: rtcSupervisorLib.hpp:28
rtctk::rtcSupervisor::rtcENABLE
@ rtcENABLE
Definition: rtcSupervisorLib.hpp:69
rtctk::rtcSupervisor::rtcGETVERSION
@ rtcGETVERSION
Definition: rtcSupervisorLib.hpp:73
rtctk::rtcSupervisor::RtcCommand
RtcCommand
Definition: rtcSupervisorLib.hpp:65
rtctk::rtcSupervisor::rtcGETSTATE
@ rtcGETSTATE
Definition: rtcSupervisorLib.hpp:72
rtctk::rtcSupervisor::SRV_SUBSTATE_NOTREADY
@ SRV_SUBSTATE_NOTREADY
Definition: rtcSupervisorLib.hpp:38
rtctk::rtcSupervisor::SRV_SUBSTATE_NOTREADY_STR
const std::string SRV_SUBSTATE_NOTREADY_STR
Definition: rtcSupervisorLib.hpp:54
rtctk::rtcSupervisor::rtcEXIT
@ rtcEXIT
Definition: rtcSupervisorLib.hpp:71
rtctk::rtcSupervisor::SRV_SUBSTATE_ENABLING
@ SRV_SUBSTATE_ENABLING
Definition: rtcSupervisorLib.hpp:42
rtctk::rtcSupervisor::rtcDISABLE
@ rtcDISABLE
Definition: rtcSupervisorLib.hpp:70
rtctk::rtcSupervisor::SRV_STATE_UNKNOWN
@ SRV_STATE_UNKNOWN
Definition: rtcSupervisorLib.hpp:25
rtctk::rtcSupervisor::SRV_SUBSTATE_GOINGRUNNING
@ SRV_SUBSTATE_GOINGRUNNING
Definition: rtcSupervisorLib.hpp:44
rtctk::rtcSupervisor::SRV_SUBSTATE_READY
@ SRV_SUBSTATE_READY
Definition: rtcSupervisorLib.hpp:39
rtctk::rtcSupervisor::SRV_SUBSTATE_IDLE_STR
const std::string SRV_SUBSTATE_IDLE_STR
Definition: rtcSupervisorLib.hpp:56
rtctk::rtcSupervisor::SRV_STATE_NOT_OPERATIONAL
@ SRV_STATE_NOT_OPERATIONAL
Definition: rtcSupervisorLib.hpp:27
rtctk::rtcSupervisor::SRV_SUBSTATE_DISABLING_STR
const std::string SRV_SUBSTATE_DISABLING_STR
Definition: rtcSupervisorLib.hpp:59
rtctk::rtcSupervisor::SRV_SUBSTATE_GOING_IDLE_STR
const std::string SRV_SUBSTATE_GOING_IDLE_STR
Definition: rtcSupervisorLib.hpp:61
rtctk::rtcSupervisor::SRV_SUBSTATE_UNKNOWN
@ SRV_SUBSTATE_UNKNOWN
Definition: rtcSupervisorLib.hpp:37
rtctk::rtcSupervisor::rtcINIT
@ rtcINIT
Definition: rtcSupervisorLib.hpp:67
rtctk::rtcSupervisor::SRV_STATE_UNAVAILABLE_STR
const std::string SRV_STATE_UNAVAILABLE_STR
Definition: rtcSupervisorLib.hpp:52
rtctk::rtcSupervisor::SRV_SUBSTATE_IDLE
@ SRV_SUBSTATE_IDLE
Definition: rtcSupervisorLib.hpp:40
logger.hpp
Logging Support Library based on log4cplus.
rtctk::rtcSupervisor::rtcRESET
@ rtcRESET
Definition: rtcSupervisorLib.hpp:68
rtcMalContext.hpp
Convenience functions for accessing MAL stubs for the Stdif.
rtctk::rtcSupervisor::SRV_SUBSTATE_GOINGIDLE
@ SRV_SUBSTATE_GOINGIDLE
Definition: rtcSupervisorLib.hpp:45
rtctk::rtcSupervisor::RtcSubState
RtcSubState
Definition: rtcSupervisorLib.hpp:36
rtctk::rtcSupervisor::SRV_STATE_OFF
@ SRV_STATE_OFF
Definition: rtcSupervisorLib.hpp:26
rtctk::rtcSupervisor::SRV_STATE_NOT_OPERATIONAL_STR
const std::string SRV_STATE_NOT_OPERATIONAL_STR
Definition: rtcSupervisorLib.hpp:50
rtctk::rtcSupervisor::SRV_SUBSTATE_INITIALISING_STR
const std::string SRV_SUBSTATE_INITIALISING_STR
Definition: rtcSupervisorLib.hpp:57
rtctk::rtcSupervisor::SRV_SUBSTATE_READY_STR
const std::string SRV_SUBSTATE_READY_STR
Definition: rtcSupervisorLib.hpp:55
rtctk::rtcSupervisor::SRV_STATE_OPERATIONAL_STR
const std::string SRV_STATE_OPERATIONAL_STR
Definition: rtcSupervisorLib.hpp:51
rtctk::rtcSupervisor::RtcState
RtcState
Definition: rtcSupervisorLib.hpp:24
rtctk::rtcSupervisor::SRV_SUBSTATE_ENABLING_STR
const std::string SRV_SUBSTATE_ENABLING_STR
Definition: rtcSupervisorLib.hpp:58
rtctk::rtcSupervisor::SRV_SUBSTATE_GOING_RUNNING_STR
const std::string SRV_SUBSTATE_GOING_RUNNING_STR
Definition: rtcSupervisorLib.hpp:60
rtctk::rtcSupervisor::SRV_SUBSTATE_ERROR
@ SRV_SUBSTATE_ERROR
Definition: rtcSupervisorLib.hpp:47