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

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

#include <eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::ComputationEvent:
rtctk::componentFramework::AbstractEvent rtctk::componentFramework::ComputationFinishedEvent rtctk::componentFramework::ComputationStartedEvent

Public Member Functions

 ComputationEvent (std::string const &origin, std::string const &item, std::string const &state)
 
 ComputationEvent (std::string const &origin, std::string const &item)
 
 ComputationEvent (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 item
 
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 = "computation_topic"
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ComputationEvent() [1/3]

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

◆ ComputationEvent() [2/3]

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

◆ ComputationEvent() [3/3]

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

Member Function Documentation

◆ ToJson()

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

Member Data Documentation

◆ item

std::string rtctk::componentFramework::ComputationEvent::item

◆ state

std::string rtctk::componentFramework::ComputationEvent::state

◆ TOPIC_NAME

const std::string rtctk::componentFramework::ComputationEvent::TOPIC_NAME = "computation_topic"
inlinestatic

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