Event published when alert status is changed. More...

#include <rtctk/componentFramework/eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::AlertStatusEvent:

Classes
struct	Alert
	Represents an active alert originating from a component instance. More...

Public Member Functions
	AlertStatusEvent ()=default

	AlertStatusEvent (bool st, std::vector< Alert > ac, const std::string &origin)
	Construct by providing members.

Public Member Functions inherited from rtctk::componentFramework::AbstractEvent
	AbstractEvent ()=default

virtual	~AbstractEvent ()=default

	AbstractEvent (const std::string &origin)

	AbstractEvent (const std::string &origin, const TimeString &time)

	AbstractEvent (const JsonPayload &j)

JsonPayload	ToJson () const

Public Attributes
bool	status
	Reduced alert status.

std::vector< Alert >	active_alerts
	List of active alerts.

Public Attributes inherited from rtctk::componentFramework::AbstractEvent
std::string	origin

TimeString	time

Static Public Attributes
static const std::string	TOPIC_NAME = "alert_status_topic"

Detailed Description

Event published when alert status is changed.

The type can represent the alert status of an individual component or can be combined and be reduced to represent status from multiple components or system.

Constructor & Destructor Documentation

◆ AlertStatusEvent() [1/2]

rtctk::componentFramework::AlertStatusEvent::AlertStatusEvent ( )

default

◆ AlertStatusEvent() [2/2]

rtctk::componentFramework::AlertStatusEvent::AlertStatusEvent	(	bool	st,
		std::vector< Alert >	ac,
		const std::string &	origin )

Construct by providing members.

Member Data Documentation

◆ active_alerts

std::vector<Alert> rtctk::componentFramework::AlertStatusEvent::active_alerts

List of active alerts.

◆ status

bool rtctk::componentFramework::AlertStatusEvent::status

Reduced alert status.

◆ TOPIC_NAME

const std::string rtctk::componentFramework::AlertStatusEvent::TOPIC_NAME = "alert_status_topic"

inlinestatic

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

componentFramework/services/events/src/include/rtctk/componentFramework/eventDefinitions.hpp
componentFramework/services/events/src/eventDefinitions.cpp

Classes

Public Member Functions

Public Attributes

Static Public Attributes