CommunicationEvent Class Reference

Abstract class for generic Communication events. More...

#include <CommunicationEvent.hpp>

Inheritance diagram for CommunicationEvent:

Collaboration diagram for CommunicationEvent:

Public Member Functions
virtual otf2::definition::location *	getLocation () const =0
otf2::chrono::duration	getStartTime () const override=0
otf2::chrono::duration	getEndTime () const override=0
virtual types::communicator *	getCommunicator () const =0
virtual CommunicationKind	getKind () const =0
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

Abstract class for generic Communication events.

All communications handled by this application have a start and an end event. See Communication for more details.

Definition at line 33 of file CommunicationEvent.hpp.

Member Function Documentation

getCommunicator()

virtual types::communicator * CommunicationEvent::getCommunicator ( ) const

pure virtual

Gets the communicator the recorded event took place in.

Returns

Communicator of the event

Implemented in BlockingP2PCommunicationEvent, CollectiveCommunicationEvent, and NonBlockingP2PCommunicationEvent.

getEndTime()

otf2::chrono::duration CommunicationEvent::getEndTime ( ) const

overridepure virtual

Gets the end time of the recorded even. The time is relative to the star time of the program.

Returns

End time of the recorded event

Implements TimedElement.

Implemented in BlockingP2PCommunicationEvent, CollectiveCommunicationEvent, and NonBlockingP2PCommunicationEvent.

getKind()

virtual CommunicationKind CommunicationEvent::getKind ( ) const

pure virtual

Gets the kind of communication event. Implemented by each derived class.

Returns

Kind of event.

Implemented in BlockingReceiveEvent, BlockingSendEvent, CollectiveCommunicationEvent, NonBlockingReceiveEvent, NonBlockingSendEvent, and RequestCancelledEvent.

getLocation()

virtual otf2::definition::location * CommunicationEvent::getLocation ( ) const

pure virtual

Gets the location of the recorded event.

Returns

Location of the recorded event

Implemented in BlockingP2PCommunicationEvent, CollectiveCommunicationEvent, and NonBlockingP2PCommunicationEvent.

getStartTime()

otf2::chrono::duration CommunicationEvent::getStartTime ( ) const

overridepure virtual

Gets the start time of the recorded event. The time is relative to the star time of the program.

Returns

Start time of the recorded event

Implements TimedElement.

Implemented in BlockingP2PCommunicationEvent, CollectiveCommunicationEvent, and NonBlockingP2PCommunicationEvent.

---

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

• src/models/communication/CommunicationEvent.hpp