Class representing any (successful or unsuccessful) communication. More...

#include <Communication.hpp>

Inheritance diagram for Communication:

Collaboration diagram for Communication:

Public Member Functions
	Communication (const CommunicationEvent start, const CommunicationEvent end)

const CommunicationEvent *	getStartEvent () const

const CommunicationEvent *	getEndEvent () const

types::TraceTime	getStartTime () const override
	Returns the start time of the current object. More...

types::TraceTime	getEndTime () const override
	Returns the end time of the current object. More...

Public Member Functions inherited from TimedElement
virtual types::TraceTime	getStartTime () const =0
	Returns the start time of the current object. More...

virtual types::TraceTime	getEndTime () const =0
	Returns the end time of the current object. More...

virtual types::TraceTime	getDuration () const
	Returns the duration of the current object. More...

Detailed Description

Class representing any (successful or unsuccessful) communication.

Each communication consists of two events: An event starting the communication and one ending it. A communication does not have to successful. For example the end event might be of kind RequestCancelled indicating a request was not completed.

Definition at line 35 of file Communication.hpp.

Constructor & Destructor Documentation

◆ Communication()

Communication::Communication	(	const CommunicationEvent *	start,
		const CommunicationEvent *	end
	)

Creates a new instance of the Communication class

Parameters

start	The event initiating the communication
end	The event ending the communication

Definition at line 23 of file Communication.cpp.

Member Function Documentation

◆ getEndEvent()

const CommunicationEvent * Communication::getEndEvent ( ) const

Gets the event that ended the communication

Returns: event that ended the communication

Definition at line 30 of file Communication.cpp.

◆ getEndTime()

types::TraceTime Communication::getEndTime ( ) const

overridevirtual

Returns the end time of the current object.

This pure virtual function returns the end time of the current object. The function has to be implemented in the derived classes.

Returns: The end time of the current object.

Implements TimedElement.

Definition at line 38 of file Communication.cpp.

◆ getStartEvent()

const CommunicationEvent * Communication::getStartEvent ( ) const

Gets the event that initiated the communication.

Returns: Event that initiated the communication

Definition at line 26 of file Communication.cpp.

◆ getStartTime()

types::TraceTime Communication::getStartTime ( ) const

overridevirtual

Returns the start time of the current object.

This pure virtual function returns the start time of the current object. The function has to be implemented in the derived classes.

Returns: The start time of the current object.