hgps::InfoEventMessage Struct Reference

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

#include <info_message.h>

Inheritance diagram for hgps::InfoEventMessage:

Collaboration diagram for hgps::InfoEventMessage:

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

Public Attributes
const ModelAction	model_action {}
	Gets the source action value.
const int	model_time {}
	Gets the associated Simulation time.
const std::string	message
	Gets the notification message.
Public Attributes inherited from hgps::EventMessage
const std::string	source
	Gets the sender identifier.
const unsigned int	run_number {}
	Gets the associated Simulation run number.

Detailed Description

Implements the simulation information event message data type.

Constructor & Destructor Documentation

InfoEventMessage() [1/3]

hgps::InfoEventMessage::InfoEventMessage ( )

delete

InfoEventMessage() [2/3]

hgps::InfoEventMessage::InfoEventMessage ( std::string  sender, ModelAction  action, unsigned int  run, int  time  )

noexcept

Initialises a new instance of the ErrorEventMessage structure.

Parameters

sender	The sender identifier
action	Source action identification
run	Current simulation run number
time	Current simulation time

InfoEventMessage() [3/3]

hgps::InfoEventMessage::InfoEventMessage ( std::string  sender, ModelAction  action, unsigned int  run, int  time, std::string  msg  )

noexcept

Initialises a new instance of the ErrorEventMessage structure.

Parameters

sender	The sender identifier
action	Source action identification
run	Current simulation run number
time	Current simulation time
msg	The notification message

Member Function Documentation

accept()

void hgps::InfoEventMessage::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::InfoEventMessage::id ( ) const

overridevirtualnoexcept

Gets the unique message type identifier.

Returns

The message type identifier

Implements hgps::EventMessage.

to_string()

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

overridevirtual

Create a string representation of this instance.

Returns

The string representation

Implements hgps::EventMessage.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

message

const std::string hgps::InfoEventMessage::message

Gets the notification message.

model_action

const ModelAction hgps::InfoEventMessage::model_action {}

Gets the source action value.

model_time

const int hgps::InfoEventMessage::model_time {}

Gets the associated Simulation time.

---

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

• HealthGPS/info_message.h
• HealthGPS/info_message.cpp