RTC Supervisor Library

Library of functions used in the RTC Supervisor and integration tests. More...

Files
file	alertAggregator.cpp
	System alert aggregation.
file	alertAggregator.hpp
	System alert aggregation.
file	rtcMonitor.hpp
	Holds monitor thread for async ping of supervised objects.
file	rtcObject.hpp
	Handles communication with one supervised RtcComponent.
file	rtcObjectController.hpp
	Handles communication with many supervised RtcComponents.
file	rtcSupervisor.hpp
	Business Logic class of the RtcSupervisor (interface).
file	statusEstimator.hpp
	System status estimation.
file	statusPublisher.hpp
	Publishes the stdif status topic via MAL.
file	supervisory.hpp
	Lifecycle Extension that makes an RTC Component 'Supervisory'.
file	supervisoryCmdsImpl.hpp
	Implementation of MAL commands for layer 'Supervisory'.
file	rtcMonitor.cpp
	Monitor thread, calls provided monitoring function on a periodic basis.
file	rtcObject.cpp
	Handles communication with one supervised RtcComponent.
file	rtcObjectController.cpp
	Handles communication with many supervised RtcComponents.
file	rtcSupervisor.cpp
	Business Logic class of the RtcSupervisor (implementation).
file	statusEstimator.cpp
	System status estimation.
file	statusPublisher.cpp
	Implementation of the StatusPublisher class.

Classes
struct	rtctk::rtcSupervisor::RtcObjectInfo
	Basic information necessary to construct an RtcObject. More...
class	rtctk::rtcSupervisor::RtcObjectIf
	Interface class for RtcObject. More...
class	rtctk::rtcSupervisor::RtcObject
	Concrete RtcObject implementation. More...
struct	fmt::formatter< rtctk::rtcSupervisor::RtcCommand >
	Formatter for RtcObject. More...
class	rtctk::rtcSupervisor::RtcObjectController
	Class used to control multiple RtcObjects. More...
struct	rtctk::rtcSupervisor::Supervisory< Super >
	Life cycle extension to make RtcComponent Supervisory. More...

Enumerations
enum class	rtctk::rtcSupervisor::RtcCommand : uint8_t {   rtctk::rtcSupervisor::RtcCommand::STOP , rtctk::rtcSupervisor::RtcCommand::INIT , rtctk::rtcSupervisor::RtcCommand::RESET , rtctk::rtcSupervisor::RtcCommand::ENABLE ,   rtctk::rtcSupervisor::RtcCommand::DISABLE , rtctk::rtcSupervisor::RtcCommand::EXIT , rtctk::rtcSupervisor::RtcCommand::GET_STATE , rtctk::rtcSupervisor::RtcCommand::GET_VERSION ,   rtctk::rtcSupervisor::RtcCommand::UPDATE , rtctk::rtcSupervisor::RtcCommand::CLEAR_ALERTS , rtctk::rtcSupervisor::RtcCommand::RECOVER }
	List of commands that can be issued by the RtcSupervisor. More...

Detailed Description

Library of functions used in the RTC Supervisor and integration tests.

This library implements most of the RTC Supervisor functionality, which can then be used not only by the RTC Supervisor application itself, but also invoked by various test programs for integration tests.

Copyright

SPDX 2021-2026 European Southern Observatory (ESO)
SPDX LGPL-3.0-only

Enumeration Type Documentation

RtcCommand

enum class rtctk::rtcSupervisor::RtcCommand : uint8_t

strong

List of commands that can be issued by the RtcSupervisor.

Enumerator
STOP
INIT
RESET
ENABLE
DISABLE
EXIT
GET_STATE
GET_VERSION
UPDATE
CLEAR_ALERTS
RECOVER