Motiv
Marvelous OTF2 Traces Interactive Visualizer
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
BlockingP2PCommunicationEvent Class Reference

#include <BlockingP2PCommunicationEvent.hpp>

Inheritance diagram for BlockingP2PCommunicationEvent:
Inheritance graph
[legend]
Collaboration diagram for BlockingP2PCommunicationEvent:
Collaboration graph
[legend]

Public Member Functions

otf2::definition::location * getLocation () const override
 
otf2::chrono::duration getStartTime () const override
 
otf2::chrono::duration getEndTime () const override
 
types::communicator * getCommunicator () const override
 
- Public Member Functions inherited from CommunicationEvent
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...
 

Protected Member Functions

 BlockingP2PCommunicationEvent (const otf2::chrono::duration &timepoint, otf2::definition::location *location, types::communicator *communicator)
 

Protected Attributes

otf2::chrono::duration timepoint
 
otf2::definition::location * location
 
types::communicator * communicator
 

Detailed Description

Class representing blocking events in point to point communications like MPI_SSEND, MPI_SRECEIVE.

This class bundles common functionality for these types of events and should be used as a base class and not instantiated directly.

Definition at line 43 of file BlockingP2PCommunicationEvent.hpp.

Constructor & Destructor Documentation

◆ BlockingP2PCommunicationEvent()

BlockingP2PCommunicationEvent::BlockingP2PCommunicationEvent ( const otf2::chrono::duration &  timepoint,
otf2::definition::location *  location,
types::communicator *  communicator 
)
protected

Creates a new instance of the abstract BlockingP2PCommunicationEvent class.

Parameters
timepointTimepoint of the event
locationLocation of the event
communicatorCommunicator the event took place in

Definition at line 22 of file BlockingP2PCommunicationEvent.cpp.

Member Function Documentation

◆ getCommunicator()

types::communicator * BlockingP2PCommunicationEvent::getCommunicator ( ) const
overridevirtual

Gets the communicator the recorded event took place in.

Returns
Communicator of the event

Implements CommunicationEvent.

Definition at line 39 of file BlockingP2PCommunicationEvent.cpp.

◆ getEndTime()

otf2::chrono::duration BlockingP2PCommunicationEvent::getEndTime ( ) const
overridevirtual

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 CommunicationEvent.

Definition at line 35 of file BlockingP2PCommunicationEvent.cpp.

◆ getLocation()

otf2::definition::location * BlockingP2PCommunicationEvent::getLocation ( ) const
overridevirtual

Gets the location of the recorded event.

Returns
Location of the recorded event

Implements CommunicationEvent.

Definition at line 31 of file BlockingP2PCommunicationEvent.cpp.

◆ getStartTime()

otf2::chrono::duration BlockingP2PCommunicationEvent::getStartTime ( ) const
overridevirtual

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 CommunicationEvent.

Definition at line 27 of file BlockingP2PCommunicationEvent.cpp.

Member Data Documentation

◆ communicator

types::communicator* BlockingP2PCommunicationEvent::communicator
protected

The communicator of the operation

Definition at line 58 of file BlockingP2PCommunicationEvent.hpp.

◆ location

otf2::definition::location* BlockingP2PCommunicationEvent::location
protected

The location of the event

Definition at line 57 of file BlockingP2PCommunicationEvent.hpp.

◆ timepoint

otf2::chrono::duration BlockingP2PCommunicationEvent::timepoint
protected

The time when the event occured

Definition at line 56 of file BlockingP2PCommunicationEvent.hpp.


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