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

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

Public Member Functions

 ComputationEvent ()=default
 
 ComputationEvent (const std::string &origin, const std::string &item, const std::string &state)
 
 ComputationEvent (const std::string &origin, const std::string &item)
 
 ComputationEvent (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 item
 
std::string state
 
- Public Attributes inherited from rtctk::componentFramework::AbstractEvent
std::string origin
 
TimeString 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/4]

rtctk::componentFramework::ComputationEvent::ComputationEvent ( )
default

◆ ComputationEvent() [2/4]

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

◆ ComputationEvent() [3/4]

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

◆ ComputationEvent() [4/4]

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

Member Function Documentation

◆ ToJson()

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

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