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

Event Type used to signal that some entity changed its state. More...

#include <eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::StateChangedEvent:
rtctk::componentFramework::CoordinationEvent rtctk::componentFramework::AbstractEvent rtctk::componentFramework::HrtcStateChangedEvent

Public Member Functions

 StateChangedEvent (std::string const &origin, std::string const &entity, std::string const &state)
 
 StateChangedEvent (std::string const &origin, std::string const &state)
 
 StateChangedEvent (JsonPayload const &payload)
 
JsonPayload ToJson () const
 
- Public Member Functions inherited from rtctk::componentFramework::CoordinationEvent
 CoordinationEvent (std::string const &origin)
 
 CoordinationEvent (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::string entity
 
std::string state
 
- Public Attributes inherited from rtctk::componentFramework::AbstractEvent
std::string origin
 
uint64_t time
 

Additional Inherited Members

- Static Public Attributes inherited from rtctk::componentFramework::CoordinationEvent
static const std::string TOPIC_NAME = "coordination_topic"
 

Detailed Description

Event Type used to signal that some entity changed its state.

Constructor & Destructor Documentation

◆ StateChangedEvent() [1/3]

rtctk::componentFramework::StateChangedEvent::StateChangedEvent ( std::string const &  origin,
std::string const &  entity,
std::string const &  state 
)
inline

◆ StateChangedEvent() [2/3]

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

◆ StateChangedEvent() [3/3]

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

Member Function Documentation

◆ ToJson()

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

Member Data Documentation

◆ entity

std::string rtctk::componentFramework::StateChangedEvent::entity

◆ state

std::string rtctk::componentFramework::StateChangedEvent::state

The documentation for this struct was generated from the following file: