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

A Slot represents a visual slot to be rendered in the UI. It contains the information of a location. More...

#include <Slot.hpp>

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

Public Member Functions

 Slot (const otf2::chrono::duration &start, const otf2::chrono::duration &end, otf2::definition::location *location, otf2::definition::region *region)
 Creates a new instance of the Slot class. More...
 
SlotKind getKind () const
 Returns the kind of the current Slot object. More...
 
types::TraceTime getStartTime () const override
 Returns the start time of the current object. More...
 
types::TraceTime getEndTime () const override
 Returns the start 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...
 

Public Attributes

otf2::chrono::duration startTime
 Start time of the slot relative to the trace start time. More...
 
types::TraceTime endTime
 End time of the slot relative to the trace start time. More...
 
otf2::definition::location * location
 Location of the slot (thread) containing the location group (MPI rank) More...
 
otf2::definition::region * region
 Region the slot occurred in. For example, the source file and line. More...
 

Detailed Description

A Slot represents a visual slot to be rendered in the UI. It contains the information of a location.

Definition at line 37 of file Slot.hpp.

Constructor & Destructor Documentation

◆ Slot()

Slot::Slot ( const otf2::chrono::duration &  start,
const otf2::chrono::duration &  end,
otf2::definition::location *  location,
otf2::definition::region *  region 
)

Creates a new instance of the Slot class.

For step by step initialization use the nested Builder class.

Parameters
startStart time of the slot relative to the trace start time.
endEnd time of the slot relative to the trace start time.
locationLocation of the slot (thread) containing the location group (MPI rank)
regionRegion the slot occurred in. For example, the source file and line.

Definition at line 22 of file Slot.cpp.

Member Function Documentation

◆ getEndTime()

types::TraceTime Slot::getEndTime ( ) 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.

Implements TimedElement.

Definition at line 45 of file Slot.cpp.

◆ getKind()

SlotKind Slot::getKind ( ) const

Returns the kind of the current Slot object.

This function returns the kind of the current Slot object based on the name of the region that the Slot belongs to.

Returns
The kind of the current Slot object.

Definition at line 30 of file Slot.cpp.

◆ getStartTime()

types::TraceTime Slot::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.

Implements TimedElement.

Definition at line 41 of file Slot.cpp.

Member Data Documentation

◆ endTime

types::TraceTime Slot::endTime

End time of the slot relative to the trace start time.

Definition at line 60 of file Slot.hpp.

◆ location

otf2::definition::location* Slot::location

Location of the slot (thread) containing the location group (MPI rank)

Definition at line 65 of file Slot.hpp.

◆ region

otf2::definition::region* Slot::region

Region the slot occurred in. For example, the source file and line.

Definition at line 70 of file Slot.hpp.

◆ startTime

otf2::chrono::duration Slot::startTime

Start time of the slot relative to the trace start time.

Definition at line 55 of file Slot.hpp.


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