hgps::RunnerEventMessage Struct Reference

Implements the simulation executive event message data type. More...

#include <runner_message.h>

Inheritance diagram for hgps::RunnerEventMessage:

Collaboration diagram for hgps::RunnerEventMessage:

Public Member Functions
	RunnerEventMessage ()=delete
	RunnerEventMessage (std::string sender, RunnerAction run_action) noexcept
	Initialise a new instance of the RunnerEventMessage class. More...
	RunnerEventMessage (std::string sender, RunnerAction run_action, double elapsed) noexcept
	Initialise a new instance of the RunnerEventMessage class. More...
	RunnerEventMessage (std::string sender, RunnerAction run_action, unsigned int run) noexcept
	Initialise a new instance of the RunnerEventMessage class. More...
	RunnerEventMessage (std::string sender, RunnerAction run_action, unsigned int run, double elapsed) noexcept
	Initialise a new instance of the RunnerEventMessage class. More...
int	id () const noexcept override
	Gets the unique message type identifier. More...
std::string	to_string () const override
	Create a string representation of this instance. More...
void	accept (EventMessageVisitor &visitor) const override
	Double dispatch the message using a visitor implementation. More...
Public Member Functions inherited from hgps::EventMessage
	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...

Public Attributes
RunnerAction	action {}
	The simulation executive action. More...
double	elapsed_ms {}
	The action elapsed time in milliseconds. More...
Public Attributes inherited from hgps::EventMessage
const std::string	source
	Gets the sender identifier. More...
const unsigned int	run_number {}
	Gets the associated Simulation run number. More...

Detailed Description

Implements the simulation executive event message data type.

Constructor & Destructor Documentation

RunnerEventMessage() [1/5]

hgps::RunnerEventMessage::RunnerEventMessage ( )

delete

RunnerEventMessage() [2/5]

hgps::RunnerEventMessage::RunnerEventMessage ( std::string  sender, RunnerAction  run_action  )

noexcept

Initialise a new instance of the RunnerEventMessage class.

Parameters

sender	The sender identifier
run_action	The event action

RunnerEventMessage() [3/5]

hgps::RunnerEventMessage::RunnerEventMessage ( std::string  sender, RunnerAction  run_action, double  elapsed  )

noexcept

Initialise a new instance of the RunnerEventMessage class.

Parameters

sender	The sender identifier
run_action	The event action
elapsed	Action elapsed time in milliseconds

RunnerEventMessage() [4/5]

hgps::RunnerEventMessage::RunnerEventMessage ( std::string  sender, RunnerAction  run_action, unsigned int  run  )

noexcept

Initialise a new instance of the RunnerEventMessage class.

Parameters

sender	The sender identifier
run_action	The event action
run	The simulation run number

RunnerEventMessage() [5/5]

hgps::RunnerEventMessage::RunnerEventMessage ( std::string  sender, RunnerAction  run_action, unsigned int  run, double  elapsed  )

noexcept

Initialise a new instance of the RunnerEventMessage class.

Parameters

sender	The sender identifier
run_action	The event action
run	The simulation run number
elapsed	Action elapsed time in milliseconds

Member Function Documentation

accept()

void hgps::RunnerEventMessage::accept ( EventMessageVisitor &  visitor ) const

overridevirtual

Double dispatch the message using a visitor implementation.

Parameters

visitor

The event message instance to accept

Implements hgps::EventMessage.

Here is the call graph for this function:

id()

int hgps::RunnerEventMessage::id ( ) const

overridevirtualnoexcept

Gets the unique message type identifier.

Returns

The message type identifier

Implements hgps::EventMessage.

to_string()

std::string hgps::RunnerEventMessage::to_string ( ) const

overridevirtual

Create a string representation of this instance.

Returns

The string representation

Implements hgps::EventMessage.

Here is the caller graph for this function:

Member Data Documentation

action

RunnerAction hgps::RunnerEventMessage::action {}

The simulation executive action.

elapsed_ms

double hgps::RunnerEventMessage::elapsed_ms {}

The action elapsed time in milliseconds.

---

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

• HealthGPS/runner_message.h
• HealthGPS/runner_message.cpp