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

#include <rtctk/componentFramework/eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::HrtcConfigurationScheduledEvent:

Public Member Functions
	HrtcConfigurationScheduledEvent ()=default

	HrtcConfigurationScheduledEvent (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.

	HrtcConfigurationScheduledEvent (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.

	HrtcConfigurationScheduledEvent (const std::string &origin, const std::string &item, const std::string &hrtc_origin, uint64_t hrtc_timestamp, uint64_t hrtc_sample_id)
	Creates event object holding a single configuration item without sequence_id and timestamp.

	HrtcConfigurationScheduledEvent (const JsonPayload &j)

JsonPayload	ToJson () const

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.

	ConfigurationEvent (const JsonPayload &j)

JsonPayload	ToJson () const

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
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 scheduled to be applied in HRTC.

Constructor & Destructor Documentation

◆ HrtcConfigurationScheduledEvent() [1/5]

rtctk::componentFramework::HrtcConfigurationScheduledEvent::HrtcConfigurationScheduledEvent ( )

default

◆ HrtcConfigurationScheduledEvent() [2/5]

rtctk::componentFramework::HrtcConfigurationScheduledEvent::HrtcConfigurationScheduledEvent	(	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.

◆ HrtcConfigurationScheduledEvent() [3/5]

rtctk::componentFramework::HrtcConfigurationScheduledEvent::HrtcConfigurationScheduledEvent	(	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.

◆ HrtcConfigurationScheduledEvent() [4/5]

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

Creates event object holding a single configuration item without sequence_id and timestamp.

Deprecated: Use the constructor with Item and TimeString instead.

◆ HrtcConfigurationScheduledEvent() [5/5]

rtctk::componentFramework::HrtcConfigurationScheduledEvent::HrtcConfigurationScheduledEvent ( const JsonPayload & j )

explicit

Member Function Documentation

◆ ToJson()

JsonPayload rtctk::componentFramework::HrtcConfigurationScheduledEvent::ToJson ( ) const

Member Data Documentation

◆ hrtc_origin

std::string rtctk::componentFramework::HrtcConfigurationScheduledEvent::hrtc_origin

◆ hrtc_sample_id

uint64_t rtctk::componentFramework::HrtcConfigurationScheduledEvent::hrtc_sample_id

◆ hrtc_timestamp

TimeString rtctk::componentFramework::HrtcConfigurationScheduledEvent::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

Public Member Functions

Public Attributes

Additional Inherited Members