RTC Supervisor Extension. More...

Inheritance diagram for CustomRtcSupervisor:

Classes
class	CustomStatusEstimator
	Status Estimator Extension. More...

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

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

Public Member Functions inherited from rtctk::rtcSupervisor::RtcSupervisor
	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

Additional Inherited Members
Public Types inherited from rtctk::rtcSupervisor::RtcSupervisor
using	ComponentType = Super

Protected Member Functions inherited from rtctk::rtcSupervisor::RtcSupervisor
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 inherited from rtctk::rtcSupervisor::RtcSupervisor
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

Detailed Description

RTC Supervisor Extension.

This class is intended to show how to customise the RTC Supervisor.

Member Function Documentation

◆ MakeStatusEstimator()

std::unique_ptr< StatusEstimator > CustomRtcSupervisor::MakeStatusEstimator ( )

inlineoverridevirtual

Factory method for creating custom status estimator objects.

Reimplemented from rtctk::rtcSupervisor::RtcSupervisor.

◆ RtcSupervisor()

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

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

_examples/exampleEndToEnd/rtcSup/src/main.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ MakeStatusEstimator()

◆ RtcSupervisor()