rtctk::componentFramework::HrtcConfigurationAppliedEvent Struct Reference

Event Type used to signal that configuration data items were applied in HRTC. More...

#include <rtctk/componentFramework/eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::HrtcConfigurationAppliedEvent:

Public Member Functions
	HrtcConfigurationAppliedEvent ()=default
	HrtcConfigurationAppliedEvent (const std::string &origin, const Item &item, const std::string &hrtc_origin, const TimeString &hrtc_timestamp, uint64_t hrtc_sample_id)
	Creates event object holding a single configuration item.
	HrtcConfigurationAppliedEvent (const std::string &origin, const ItemList &items, const std::string &hrtc_origin, const TimeString &hrtc_timestamp, uint64_t hrtc_sample_id)
	Creates event object holding multiple configuration items.
Public Member Functions inherited from rtctk::componentFramework::ConfigurationEvent
	ConfigurationEvent ()=default
	ConfigurationEvent (const std::string &origin, const Item &item, const std::string &state)
	Creates event object holding a single configuration item.
	ConfigurationEvent (const std::string &origin, const ItemList &item, const std::string &state)
	Creates event object holding multiple configuration items.
	ConfigurationEvent (const std::string &origin, const std::string &item, const std::string &state)
	Creates event object holding a single configuration item without sequence_id and timestamp.
	ConfigurationEvent (const std::string &origin, const std::vector< std::string > &items, const std::string &state)
	Creates event object holding multiple configuration items without sequence_id and timestamp.
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)

Public Attributes
std::string	hrtc_origin
TimeString	hrtc_timestamp
uint64_t	hrtc_sample_id
Public Attributes inherited from rtctk::componentFramework::ConfigurationEvent
ItemList	items
std::string	state
Public Attributes inherited from rtctk::componentFramework::AbstractEvent
std::string	origin
TimeString	time

Additional Inherited Members
Public Types inherited from rtctk::componentFramework::ConfigurationEvent
using	ItemList = std::vector<Item>
Static Public Attributes inherited from rtctk::componentFramework::ConfigurationEvent
static const std::string	TOPIC_NAME = "configuration_topic"

Detailed Description

Event Type used to signal that configuration data items were applied in HRTC.

Constructor & Destructor Documentation

HrtcConfigurationAppliedEvent() [1/3]

rtctk::componentFramework::HrtcConfigurationAppliedEvent::HrtcConfigurationAppliedEvent ( )

default

HrtcConfigurationAppliedEvent() [2/3]

rtctk::componentFramework::HrtcConfigurationAppliedEvent::HrtcConfigurationAppliedEvent	(	const std::string &	origin,
		const Item &	item,
		const std::string &	hrtc_origin,
		const TimeString &	hrtc_timestamp,
		uint64_t	hrtc_sample_id )

Creates event object holding a single configuration item.

HrtcConfigurationAppliedEvent() [3/3]

rtctk::componentFramework::HrtcConfigurationAppliedEvent::HrtcConfigurationAppliedEvent	(	const std::string &	origin,
		const ItemList &	items,
		const std::string &	hrtc_origin,
		const TimeString &	hrtc_timestamp,
		uint64_t	hrtc_sample_id )

Creates event object holding multiple configuration items.

Member Data Documentation

hrtc_origin

std::string rtctk::componentFramework::HrtcConfigurationAppliedEvent::hrtc_origin

hrtc_sample_id

uint64_t rtctk::componentFramework::HrtcConfigurationAppliedEvent::hrtc_sample_id

hrtc_timestamp

TimeString rtctk::componentFramework::HrtcConfigurationAppliedEvent::hrtc_timestamp

---

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