hgps::SyncMessage Class Reference

Scenario data synchronisation message data type. More...

#include <sync_message.h>

Inheritance diagram for hgps::SyncMessage:

Public Member Functions
	SyncMessage (const int run, const int time)
	Initialises a new instance of the SyncMessage class. More...
	SyncMessage (const SyncMessage &)=delete
SyncMessage &	operator= (const SyncMessage &)=delete
virtual	~SyncMessage ()=default
	Destroys a SyncMessage instance. More...
int	run () const noexcept
	Gets the Simulation run number. More...
int	time () const noexcept
	Gets the Simulation time. More...

Protected Member Functions
	SyncMessage (SyncMessage &&other)=default
	Moves the target of other to the target of *this. More...
SyncMessage &	operator= (SyncMessage &&other)=default
	Moves the target of other to *this. More...

Detailed Description

Scenario data synchronisation message data type.

Constructor & Destructor Documentation

SyncMessage() [1/3]

hgps::SyncMessage::SyncMessage ( const int  run, const int  time  )

inlineexplicit

Initialises a new instance of the SyncMessage class.

Parameters

run	Simulation run number
time	Simulation time

SyncMessage() [2/3]

hgps::SyncMessage::SyncMessage ( const SyncMessage &  )

delete

~SyncMessage()

virtual hgps::SyncMessage::~SyncMessage ( )

virtualdefault

Destroys a SyncMessage instance.

SyncMessage() [3/3]

hgps::SyncMessage::SyncMessage ( SyncMessage &&  other )

protecteddefault

Moves the target of other to the target of *this.

Parameters

other

The other instance to move

Member Function Documentation

operator=() [1/2]

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

delete

operator=() [2/2]

SyncMessage& hgps::SyncMessage::operator= ( SyncMessage &&  other )

protecteddefault

Moves the target of other to *this.

Parameters

other

The other instance to move

Returns

This instance

run()

int hgps::SyncMessage::run ( ) const

inlinenoexcept

Gets the Simulation run number.

Returns

Run number

time()

int hgps::SyncMessage::time ( ) const

inlinenoexcept

Gets the Simulation time.

Returns

Simulation time

---

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

• HealthGPS/sync_message.h