RTC Toolkit  2.0.0
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
rtctk::componentFramework::ConfigurationEvent Struct Reference

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

#include <eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::ConfigurationEvent:
rtctk::componentFramework::AbstractEvent rtctk::componentFramework::ConfigurationRetrievedEvent rtctk::componentFramework::ConfigurationUpdatedEvent rtctk::componentFramework::HrtcConfigurationAppliedEvent rtctk::componentFramework::HrtcConfigurationScheduledEvent

Public Member Functions

 ConfigurationEvent (std::string const &origin, std::string const &item, std::string const &state)
 
 ConfigurationEvent (std::string const &origin, std::vector< std::string > const &items, std::string const &state)
 
 ConfigurationEvent (JsonPayload const &payload)
 
JsonPayload ToJson () const
 
- Public Member Functions inherited from rtctk::componentFramework::AbstractEvent
 AbstractEvent ()=delete
 
 AbstractEvent (JsonPayload const &payload)
 
 AbstractEvent (std::string const &origin)
 
JsonPayload ToJson () const
 

Public Attributes

std::vector< std::string > items
 
std::string state
 
- Public Attributes inherited from rtctk::componentFramework::AbstractEvent
std::string origin
 
uint64_t 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.

Constructor & Destructor Documentation

◆ ConfigurationEvent() [1/3]

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

◆ ConfigurationEvent() [2/3]

rtctk::componentFramework::ConfigurationEvent::ConfigurationEvent ( std::string const &  origin,
std::vector< std::string > const &  items,
std::string const &  state 
)
inline

◆ ConfigurationEvent() [3/3]

rtctk::componentFramework::ConfigurationEvent::ConfigurationEvent ( JsonPayload const &  payload)
inline

Member Function Documentation

◆ ToJson()

JsonPayload rtctk::componentFramework::ConfigurationEvent::ToJson ( ) const
inline

Member Data Documentation

◆ items

std::vector<std::string> 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 file: