rtctk::componentFramework::ConfigurationRetrievedEvent Struct Reference

Event Type used to signal that configuration data items were retrieved from RTR. More...

#include <rtctk/componentFramework/eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::ConfigurationRetrievedEvent:

Public Member Functions
	ConfigurationRetrievedEvent ()=default
	ConfigurationRetrievedEvent (const std::string &origin, const Item &item)
	Creates event object holding a single configuration item.
	ConfigurationRetrievedEvent (const std::string &origin, const ItemList &items)
	Creates event object holding multiple configuration items.
	ConfigurationRetrievedEvent (const std::string &origin, const std::string &item)
	Creates event object holding a single configuration item without sequence_id and timestamp.
	ConfigurationRetrievedEvent (const std::string &origin, const std::vector< std::string > &items)
	Creates event object holding multiple configuration items without sequence_id and timestamp.
	ConfigurationRetrievedEvent (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

Additional Inherited Members
Public Types inherited from rtctk::componentFramework::ConfigurationEvent
using	ItemList = std::vector<Item>
Public Attributes inherited from rtctk::componentFramework::ConfigurationEvent
ItemList	items
std::string	state
Public Attributes inherited from rtctk::componentFramework::AbstractEvent
std::string	origin
TimeString	time
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 retrieved from RTR.

Constructor & Destructor Documentation

ConfigurationRetrievedEvent() [1/6]

rtctk::componentFramework::ConfigurationRetrievedEvent::ConfigurationRetrievedEvent ( )

default

ConfigurationRetrievedEvent() [2/6]

rtctk::componentFramework::ConfigurationRetrievedEvent::ConfigurationRetrievedEvent	(	const std::string &	origin,
		const Item &	item )

Creates event object holding a single configuration item.

ConfigurationRetrievedEvent() [3/6]

rtctk::componentFramework::ConfigurationRetrievedEvent::ConfigurationRetrievedEvent	(	const std::string &	origin,
		const ItemList &	items )

Creates event object holding multiple configuration items.

ConfigurationRetrievedEvent() [4/6]

rtctk::componentFramework::ConfigurationRetrievedEvent::ConfigurationRetrievedEvent	(	const std::string &	origin,
		const std::string &	item )

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

ConfigurationRetrievedEvent() [5/6]

rtctk::componentFramework::ConfigurationRetrievedEvent::ConfigurationRetrievedEvent	(	const std::string &	origin,
		const std::vector< std::string > &	items )

Creates event object holding multiple configuration items without sequence_id and timestamp.

ConfigurationRetrievedEvent() [6/6]

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

explicit

Member Function Documentation

ToJson()

JsonPayload rtctk::componentFramework::ConfigurationRetrievedEvent::ToJson

(

)

const

---

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