hgps::EventMessage Struct Reference

Simulation event messages interface. More...

#include <event_message.h>

Inheritance diagram for hgps::EventMessage:

Public Member Functions
	EventMessage ()=delete
	EventMessage (std::string sender, unsigned int run)
	Initialises a new instance of the EventMessage structure. More...
	EventMessage (const EventMessage &)=delete
	EventMessage (EventMessage &&)=delete
EventMessage &	operator= (const EventMessage &)=delete
EventMessage &	operator= (EventMessage &&)=delete
virtual	~EventMessage ()=default
	Destroys an EventMessage instance. More...
virtual int	id () const noexcept=0
	Gets the unique message type identifier. More...
virtual std::string	to_string () const =0
	Create a string representation of this instance. More...
virtual void	accept (EventMessageVisitor &visitor) const =0
	Double dispatch the message using a visitor implementation. More...

Public Attributes
const std::string	source
	Gets the sender identifier. More...
const unsigned int	run_number {}
	Gets the associated Simulation run number. More...

Detailed Description

Simulation event messages interface.

Constructor & Destructor Documentation

EventMessage() [1/4]

hgps::EventMessage::EventMessage ( )

delete

EventMessage() [2/4]

hgps::EventMessage::EventMessage ( std::string  sender, unsigned int  run  )

inline

Initialises a new instance of the EventMessage structure.

Parameters

sender	The sender identifier
run	Current simulation run number

EventMessage() [3/4]

hgps::EventMessage::EventMessage ( const EventMessage &  )

delete

EventMessage() [4/4]

hgps::EventMessage::EventMessage ( EventMessage &&  )

delete

~EventMessage()

virtual hgps::EventMessage::~EventMessage ( )

virtualdefault

Destroys an EventMessage instance.

Member Function Documentation

accept()

virtual void hgps::EventMessage::accept ( EventMessageVisitor &  visitor ) const

pure virtual

Double dispatch the message using a visitor implementation.

Parameters

visitor

The event message instance to accept

Implemented in hgps::RunnerEventMessage, hgps::ResultEventMessage, hgps::InfoEventMessage, and hgps::ErrorEventMessage.

id()

virtual int hgps::EventMessage::id ( ) const

pure virtualnoexcept

Gets the unique message type identifier.

Returns

The message type identifier

Implemented in hgps::RunnerEventMessage, hgps::ResultEventMessage, hgps::InfoEventMessage, and hgps::ErrorEventMessage.

operator=() [1/2]

EventMessage& hgps::EventMessage::operator= ( const EventMessage &  )

delete

operator=() [2/2]

EventMessage& hgps::EventMessage::operator= ( EventMessage &&  )

delete

to_string()

virtual std::string hgps::EventMessage::to_string ( ) const

pure virtual

Create a string representation of this instance.

Returns

The string representation

Implemented in hgps::RunnerEventMessage, hgps::ResultEventMessage, hgps::InfoEventMessage, and hgps::ErrorEventMessage.

Member Data Documentation

run_number

const unsigned int hgps::EventMessage::run_number {}

Gets the associated Simulation run number.

source

const std::string hgps::EventMessage::source

Gets the sender identifier.

---

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

• HealthGPS/event_message.h