RTC Toolkit 5.1.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
rtctk::componentFramework::ComputationFinishedEvent Struct Reference

Event Type used to signal that a computation has finished. More...

#include <rtctk/componentFramework/eventDefinitions.hpp>

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

Public Member Functions

 ComputationFinishedEvent ()=default
 
 ComputationFinishedEvent (const std::string &origin, const std::string &item, const JsonPayload &result=nullptr)
 
 ComputationFinishedEvent (const JsonPayload &j)
 
JsonPayload ToJson () const
 
- Public Member Functions inherited from rtctk::componentFramework::ComputationEvent
 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

JsonPayload result
 
- Public Attributes inherited from rtctk::componentFramework::ComputationEvent
std::string item
 
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::ComputationEvent
static const std::string TOPIC_NAME = "computation_topic"
 

Detailed Description

Event Type used to signal that a computation has finished.

Constructor & Destructor Documentation

◆ ComputationFinishedEvent() [1/3]

rtctk::componentFramework::ComputationFinishedEvent::ComputationFinishedEvent ( )
default

◆ ComputationFinishedEvent() [2/3]

rtctk::componentFramework::ComputationFinishedEvent::ComputationFinishedEvent ( const std::string & origin,
const std::string & item,
const JsonPayload & result = nullptr )

◆ ComputationFinishedEvent() [3/3]

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

Member Function Documentation

◆ ToJson()

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

Member Data Documentation

◆ result

JsonPayload rtctk::componentFramework::ComputationFinishedEvent::result

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