rtctk::componentFramework::ConfigurationEvent Struct Reference

Abstract Event Type that is used as a base for configuration events. More...

#include <rtctk/componentFramework/eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::ConfigurationEvent:

Classes
struct	Item
	Represents a single configuration item. More...

Public Types
using	ItemList = std::vector<Item>

Public Member Functions
	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
ItemList	items
std::string	state
Public Attributes inherited from rtctk::componentFramework::AbstractEvent
std::string	origin
TimeString	time

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

Detailed Description

Abstract Event Type that is used as a base for configuration events.

Member Typedef Documentation

ItemList

using rtctk::componentFramework::ConfigurationEvent::ItemList = std::vector<Item>

Constructor & Destructor Documentation

ConfigurationEvent() [1/6]

rtctk::componentFramework::ConfigurationEvent::ConfigurationEvent ( )

default

ConfigurationEvent() [2/6]

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

Creates event object holding a single configuration item.

ConfigurationEvent() [3/6]

rtctk::componentFramework::ConfigurationEvent::ConfigurationEvent	(	const std::string &	origin,
		const ItemList &	item,
		const std::string &	state )

Creates event object holding multiple configuration items.

ConfigurationEvent() [4/6]

rtctk::componentFramework::ConfigurationEvent::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() [5/6]

rtctk::componentFramework::ConfigurationEvent::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() [6/6]

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

explicit

Member Function Documentation

ToJson()

JsonPayload rtctk::componentFramework::ConfigurationEvent::ToJson

(

)

const

Member Data Documentation

items

ItemList rtctk::componentFramework::ConfigurationEvent::items

state

std::string rtctk::componentFramework::ConfigurationEvent::state

TOPIC_NAME

const std::string rtctk::componentFramework::ConfigurationEvent::TOPIC_NAME = "configuration_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