RTC Toolkit 5.1.0
Loading...
Searching...
No Matches
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 <rtctk/componentFramework/eventDefinitions.hpp>

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

Public Member Functions

 StateChangedEvent ()=default
 
 StateChangedEvent (const std::string &origin, const std::string &entity, const std::string &state)
 
 StateChangedEvent (const std::string &origin, const std::string &state)
 
 StateChangedEvent (const JsonPayload &j)
 
JsonPayload ToJson () const
 
- Public Member Functions inherited from rtctk::componentFramework::CoordinationEvent
 CoordinationEvent ()=default
 
 CoordinationEvent (const std::string &origin)
 
 CoordinationEvent (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 entity
 
std::string state
 
- Public Attributes inherited from rtctk::componentFramework::AbstractEvent
std::string origin
 
TimeString 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/4]

rtctk::componentFramework::StateChangedEvent::StateChangedEvent ( )
default

◆ StateChangedEvent() [2/4]

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

◆ StateChangedEvent() [3/4]

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

◆ StateChangedEvent() [4/4]

rtctk::componentFramework::StateChangedEvent::StateChangedEvent ( const JsonPayload & j)
explicit

Member Function Documentation

◆ ToJson()

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

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 files: