rtctk::componentFramework::ComputationFinishedEvent Struct Reference

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

#include <eventDefinitions.hpp>

Inheritance diagram for rtctk::componentFramework::ComputationFinishedEvent:

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

inline

ComputationFinishedEvent() [2/3]

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

inline

ComputationFinishedEvent() [3/3]

rtctk::componentFramework::ComputationFinishedEvent::ComputationFinishedEvent ( JsonPayload const &  payload )

inline

Member Function Documentation

ToJson()

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

inline

Member Data Documentation

result

JsonPayload rtctk::componentFramework::ComputationFinishedEvent::result

---

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

• componentFramework/services/events/src/include/rtctk/componentFramework/eventDefinitions.hpp