#include <rtcSupervisor.hpp>

Inheritance diagram for rtctk::rtcSupervisor::RtcSupervisor:

Public Types
using	ComponentType = Super

Public Member Functions
	RtcSupervisor (const std::string &comp_name, ServiceContainer &services)

virtual	~RtcSupervisor ()

void	ActivityStarting (StopToken st) override

void	ActivityInitialising (StopToken st) override

void	ActivityEnabling (StopToken st) override

void	ActivityDisabling (StopToken st) override

void	ActivityUpdating (StopToken st, const JsonPayload &args) override

bool	GuardUpdatingAllowed (const JsonPayload &args) override

void	ActionClearAlerts () override

void	ActivityRecovering (StopToken st) override

std::string	ActionGetStatus () override

JsonPayload	ActionGetAvailableModes () override

JsonPayload	ActionGetActiveModes () override

JsonPayload	ActionGetDeferredModes () override

void	ActionSetDeferredModes (const JsonPayload &args) override

void	ActivitySettingModes (StopToken st, const JsonPayload &args) override

bool	GuardSettingModesAllowed (const JsonPayload &args) override

void	ActivityWritingBack (StopToken st, const JsonPayload &args) override

bool	GuardWritingBackAllowed (const JsonPayload &args) override

Protected Member Functions
virtual std::unique_ptr< StatusEstimator >	MakeStatusEstimator ()
	Factory method for creating custom status estimator objects.

std::vector< std::unique_ptr< RtcObjectIf > >	MakeRtcObjects ()
	Constructs RtcObjects, called during Initialisation.

std::vector< elt::mal::Uri >	GetPubSubUris ()
	Gets Pub/Sub URIs of superivsord compoonents.

void	MonitorCycle () noexcept
	Performs one cycle of async monitoring of the components.

void	OnStateEventReceived (const taiclock::TaiClock::time_point, const std::string &name, const std::string &state) noexcept
	Called on State Event subscription.

void	SetStatus (const std::string &status)
	Sets and publishes overall system status.

std::string	GetStatus ()
	Returns the overall system status.

void	LoadStaticConfig ()
	Retrievs static configuration from the Runtime Configuration Repository.

void	LoadDynamicConfig ()
	Retrievs static configuration from the Runtime Configuration Repository.

Protected Attributes
log4cplus::Logger &	m_logger

const std::string	m_name

PersistentRepoIf &	m_psr

RuntimeRepoIf &	m_rtr

OldbIf &	m_oldb

ComponentMetricsIf &	m_metrics

AlertServiceIf &	m_alerts

ServiceDiscovery &	m_service_discovery

StatusPublisher	m_status_publisher

PopulateConfig	m_popcfg

AlertSource	m_heartbeat_alert

AlertSource	m_command_alert

AlertSource	m_oldb_alert

std::vector< std::unique_ptr< RtcObjectIf > >	m_objects

std::unique_ptr< RtcObjectController >	m_object_controller

DataPointPath	m_dp_path_init_alone

DataPointPath	m_dp_path_enable_alone

DataPointPath	m_dp_path_disable_alone

DataPointPath	m_dp_path_update_alone

DataPointPath	m_dp_path_status

bool	m_init_alone

bool	m_enable_alone

bool	m_disable_alone

bool	m_update_alone

std::mutex	m_status_mutex

std::string	m_status

std::map< std::string, std::string >	m_deferred_modes

std::unique_ptr< StatusEstimator >	m_status_estimator

std::unique_ptr< RtcMonitor >	m_monitor_thread

std::unique_ptr< StateSubscriber >	m_state_subscriber

std::unique_ptr< AlertAggregator >	m_alert_aggregator

Member Typedef Documentation

◆ ComponentType

using rtctk::rtcSupervisor::RtcSupervisor::ComponentType = Super

Constructor & Destructor Documentation

◆ RtcSupervisor()

rtctk::rtcSupervisor::RtcSupervisor::RtcSupervisor	(	const std::string &	comp_name,
		ServiceContainer &	services )

◆ ~RtcSupervisor()

rtctk::rtcSupervisor::RtcSupervisor::~RtcSupervisor ( )

virtual

Member Function Documentation

◆ ActionClearAlerts()

void rtctk::rtcSupervisor::RtcSupervisor::ActionClearAlerts ( )

override

◆ ActionGetActiveModes()

JsonPayload rtctk::rtcSupervisor::RtcSupervisor::ActionGetActiveModes ( )

override

◆ ActionGetAvailableModes()

JsonPayload rtctk::rtcSupervisor::RtcSupervisor::ActionGetAvailableModes ( )

override

◆ ActionGetDeferredModes()

JsonPayload rtctk::rtcSupervisor::RtcSupervisor::ActionGetDeferredModes ( )

override

◆ ActionGetStatus()

std::string rtctk::rtcSupervisor::RtcSupervisor::ActionGetStatus ( )

override

◆ ActionSetDeferredModes()

void rtctk::rtcSupervisor::RtcSupervisor::ActionSetDeferredModes ( const JsonPayload & args )

override

◆ ActivityDisabling()

void rtctk::rtcSupervisor::RtcSupervisor::ActivityDisabling ( StopToken st )

override

◆ ActivityEnabling()

void rtctk::rtcSupervisor::RtcSupervisor::ActivityEnabling ( StopToken st )

override

◆ ActivityInitialising()

void rtctk::rtcSupervisor::RtcSupervisor::ActivityInitialising ( StopToken st )

override

◆ ActivityRecovering()

void rtctk::rtcSupervisor::RtcSupervisor::ActivityRecovering ( StopToken st )

override

◆ ActivitySettingModes()

void rtctk::rtcSupervisor::RtcSupervisor::ActivitySettingModes	(	StopToken	st,
		const JsonPayload &	args )

override

◆ ActivityStarting()

void rtctk::rtcSupervisor::RtcSupervisor::ActivityStarting ( StopToken st )

override

◆ ActivityUpdating()

void rtctk::rtcSupervisor::RtcSupervisor::ActivityUpdating	(	StopToken	st,
		const JsonPayload &	args )

override

◆ ActivityWritingBack()

void rtctk::rtcSupervisor::RtcSupervisor::ActivityWritingBack	(	StopToken	st,
		const JsonPayload &	args )

override

◆ GetPubSubUris()

std::vector< elt::mal::Uri > rtctk::rtcSupervisor::RtcSupervisor::GetPubSubUris ( )

protected

Gets Pub/Sub URIs of superivsord compoonents.

◆ GetStatus()

std::string rtctk::rtcSupervisor::RtcSupervisor::GetStatus ( )

protected

Returns the overall system status.

◆ GuardSettingModesAllowed()

bool rtctk::rtcSupervisor::RtcSupervisor::GuardSettingModesAllowed ( const JsonPayload & args )

override

◆ GuardUpdatingAllowed()

bool rtctk::rtcSupervisor::RtcSupervisor::GuardUpdatingAllowed ( const JsonPayload & args )

override

◆ GuardWritingBackAllowed()

bool rtctk::rtcSupervisor::RtcSupervisor::GuardWritingBackAllowed ( const JsonPayload & args )

override

◆ LoadDynamicConfig()

void rtctk::rtcSupervisor::RtcSupervisor::LoadDynamicConfig ( )

protected

Retrievs static configuration from the Runtime Configuration Repository.

◆ LoadStaticConfig()

void rtctk::rtcSupervisor::RtcSupervisor::LoadStaticConfig ( )

protected

Retrievs static configuration from the Runtime Configuration Repository.

◆ MakeRtcObjects()

std::vector< std::unique_ptr< RtcObjectIf > > rtctk::rtcSupervisor::RtcSupervisor::MakeRtcObjects ( )

protected

Constructs RtcObjects, called during Initialisation.

◆ MakeStatusEstimator()

std::unique_ptr< StatusEstimator > rtctk::rtcSupervisor::RtcSupervisor::MakeStatusEstimator ( )

protectedvirtual

Factory method for creating custom status estimator objects.

Reimplemented in CustomRtcSupervisor.

◆ MonitorCycle()

void rtctk::rtcSupervisor::RtcSupervisor::MonitorCycle ( )

protectednoexcept

Performs one cycle of async monitoring of the components.

Perform one cycle of object monitoring.

This method is periodically called from the RtcMonitor class.

Traverse the list of objects sending a request and setting an error flag if there is an error communicating

◆ OnStateEventReceived()

void rtctk::rtcSupervisor::RtcSupervisor::OnStateEventReceived	(	const taiclock::TaiClock::time_point	timestamp,
		const std::string &	name,
		const std::string &	state )

protectednoexcept

Called on State Event subscription.

This method is offloaded to the io_context in the RtcMonitor class.

◆ SetStatus()

void rtctk::rtcSupervisor::RtcSupervisor::SetStatus ( const std::string & status )

protected

Sets and publishes overall system status.

Member Data Documentation

◆ m_alert_aggregator

std::unique_ptr<AlertAggregator> rtctk::rtcSupervisor::RtcSupervisor::m_alert_aggregator

protected

◆ m_alerts

AlertServiceIf& rtctk::rtcSupervisor::RtcSupervisor::m_alerts

protected

◆ m_command_alert

AlertSource rtctk::rtcSupervisor::RtcSupervisor::m_command_alert

protected

◆ m_deferred_modes

std::map<std::string, std::string> rtctk::rtcSupervisor::RtcSupervisor::m_deferred_modes

protected

◆ m_disable_alone

bool rtctk::rtcSupervisor::RtcSupervisor::m_disable_alone

protected

◆ m_dp_path_disable_alone

DataPointPath rtctk::rtcSupervisor::RtcSupervisor::m_dp_path_disable_alone

protected

◆ m_dp_path_enable_alone

DataPointPath rtctk::rtcSupervisor::RtcSupervisor::m_dp_path_enable_alone

protected

◆ m_dp_path_init_alone

DataPointPath rtctk::rtcSupervisor::RtcSupervisor::m_dp_path_init_alone

protected

◆ m_dp_path_status

DataPointPath rtctk::rtcSupervisor::RtcSupervisor::m_dp_path_status

protected

◆ m_dp_path_update_alone

DataPointPath rtctk::rtcSupervisor::RtcSupervisor::m_dp_path_update_alone

protected

◆ m_enable_alone

bool rtctk::rtcSupervisor::RtcSupervisor::m_enable_alone

protected

◆ m_heartbeat_alert

AlertSource rtctk::rtcSupervisor::RtcSupervisor::m_heartbeat_alert

protected

◆ m_init_alone

bool rtctk::rtcSupervisor::RtcSupervisor::m_init_alone

protected

◆ m_logger

log4cplus::Logger& rtctk::rtcSupervisor::RtcSupervisor::m_logger

protected

◆ m_metrics

ComponentMetricsIf& rtctk::rtcSupervisor::RtcSupervisor::m_metrics

protected

◆ m_monitor_thread

std::unique_ptr<RtcMonitor> rtctk::rtcSupervisor::RtcSupervisor::m_monitor_thread

protected

◆ m_name

const std::string rtctk::rtcSupervisor::RtcSupervisor::m_name

protected

◆ m_object_controller

std::unique_ptr<RtcObjectController> rtctk::rtcSupervisor::RtcSupervisor::m_object_controller

protected

◆ m_objects

std::vector<std::unique_ptr<RtcObjectIf> > rtctk::rtcSupervisor::RtcSupervisor::m_objects

protected

◆ m_oldb

OldbIf& rtctk::rtcSupervisor::RtcSupervisor::m_oldb

protected

◆ m_oldb_alert

AlertSource rtctk::rtcSupervisor::RtcSupervisor::m_oldb_alert

protected

◆ m_popcfg

PopulateConfig rtctk::rtcSupervisor::RtcSupervisor::m_popcfg

protected

◆ m_psr

PersistentRepoIf& rtctk::rtcSupervisor::RtcSupervisor::m_psr

protected

◆ m_rtr

RuntimeRepoIf& rtctk::rtcSupervisor::RtcSupervisor::m_rtr

protected

◆ m_service_discovery

ServiceDiscovery& rtctk::rtcSupervisor::RtcSupervisor::m_service_discovery

protected

◆ m_state_subscriber

std::unique_ptr<StateSubscriber> rtctk::rtcSupervisor::RtcSupervisor::m_state_subscriber

protected

◆ m_status

std::string rtctk::rtcSupervisor::RtcSupervisor::m_status

protected

◆ m_status_estimator

std::unique_ptr<StatusEstimator> rtctk::rtcSupervisor::RtcSupervisor::m_status_estimator

protected

◆ m_status_mutex

std::mutex rtctk::rtcSupervisor::RtcSupervisor::m_status_mutex

protected

◆ m_status_publisher

StatusPublisher rtctk::rtcSupervisor::RtcSupervisor::m_status_publisher

protected

◆ m_update_alone

bool rtctk::rtcSupervisor::RtcSupervisor::m_update_alone

protected

The documentation for this class was generated from the following files:

reusableComponents/rtcSupervisor/lib/src/include/rtctk/rtcSupervisor/rtcSupervisor.hpp
reusableComponents/rtcSupervisor/lib/src/rtcSupervisor.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ ComponentType

Constructor & Destructor Documentation

◆ RtcSupervisor()

◆ ~RtcSupervisor()

Member Function Documentation

◆ ActionClearAlerts()

◆ ActionGetActiveModes()

◆ ActionGetAvailableModes()

◆ ActionGetDeferredModes()

◆ ActionGetStatus()

◆ ActionSetDeferredModes()

◆ ActivityDisabling()

◆ ActivityEnabling()

◆ ActivityInitialising()

◆ ActivityRecovering()

◆ ActivitySettingModes()

◆ ActivityStarting()

◆ ActivityUpdating()

◆ ActivityWritingBack()

◆ GetPubSubUris()

◆ GetStatus()

◆ GuardSettingModesAllowed()

◆ GuardUpdatingAllowed()

◆ GuardWritingBackAllowed()

◆ LoadDynamicConfig()

◆ LoadStaticConfig()

◆ MakeRtcObjects()

◆ MakeStatusEstimator()

◆ MonitorCycle()

◆ OnStateEventReceived()

◆ SetStatus()

Member Data Documentation

◆ m_alert_aggregator

◆ m_alerts

◆ m_command_alert

◆ m_deferred_modes

◆ m_disable_alone

◆ m_dp_path_disable_alone

◆ m_dp_path_enable_alone

◆ m_dp_path_init_alone

◆ m_dp_path_status

◆ m_dp_path_update_alone

◆ m_enable_alone

◆ m_heartbeat_alert

◆ m_init_alone

◆ m_logger

◆ m_metrics

◆ m_monitor_thread

◆ m_name

◆ m_object_controller

◆ m_objects

◆ m_oldb

◆ m_oldb_alert

◆ m_popcfg

◆ m_psr

◆ m_rtr

◆ m_service_discovery

◆ m_state_subscriber

◆ m_status

◆ m_status_estimator

◆ m_status_mutex

◆ m_status_publisher

◆ m_update_alone