Trace Class Reference

Abstract base class for a trace. More...

#include <Trace.hpp>

Inheritance diagram for Trace:

Collaboration diagram for Trace:

Public Member Functions
virtual std::map< otf2::definition::location_group *, Range< Slot * >, LocationGroupCmp >	getSlots () const =0
	Returns a map of slots of the current trace. More...
virtual Range< Communication * >	getCommunications ()=0
	Returns communication objects of the current trace. More...
virtual Range< CollectiveCommunicationEvent * >	getCollectiveCommunications ()=0
	Returns collective communication events of the current trace. More...
virtual otf2::chrono::duration	getRuntime () const =0
	Returns the runtime of the current trace. More...
virtual Trace *	subtrace (otf2::chrono::duration from, otf2::chrono::duration to)=0
	Creates a subtrace of the current trace. 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

Abstract base class for a trace.

This class defines an abstract base class for a trace. It inherits from the TimedElement class and contains pure virtual functions that have to be implemented by derived classes.

Definition at line 52 of file Trace.hpp.

Member Function Documentation

getCollectiveCommunications()

virtual Range< CollectiveCommunicationEvent * > Trace::getCollectiveCommunications ( )

pure virtual

Returns collective communication events of the current trace.

This pure virtual function returns collective communication events of the current trace. The function has to be implemented in the derived classes.

Returns

collective communication events of the current trace.

Implemented in FileTrace, and SubTrace.

getCommunications()

virtual Range< Communication * > Trace::getCommunications ( )

pure virtual

Returns communication objects of the current trace.

This pure virtual function returns communication objects of the current trace. The function has to be implemented in the derived classes.

Returns

communication objects of the current trace.

Implemented in FileTrace, and SubTrace.

getRuntime()

virtual otf2::chrono::duration Trace::getRuntime ( ) const

pure virtual

Returns the runtime of the current trace.

This pure virtual function returns the runtime of the current trace. The function has to be implemented in the derived classes.

Returns

The runtime of the current trace.

Implemented in SubTrace.

getSlots()

virtual std::map< otf2::definition::location_group *, Range< Slot * >, LocationGroupCmp > Trace::getSlots ( ) const

pure virtual

Returns a map of slots of the current trace.

This pure virtual function returns a map of slots of the current trace. The function has to be implemented in the derived classes.

Returns

A map of slots of the current trace.

Implemented in FileTrace, and SubTrace.

subtrace()

virtual Trace * Trace::subtrace ( otf2::chrono::duration  from, otf2::chrono::duration  to  )

pure virtual

Creates a subtrace of the current trace.

This pure virtual function creates a subtrace of the current trace by returning a new Trace object that only contains elements within the given time range. The function has to be implemented in the derived classes.

Parameters

from	Time the the subtrace should start.
to	Time the subtrace should end.

Returns

A new Trace object that only contains elements within the given time range.

Implemented in SubTrace, and UITrace.

---

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

• src/models/Trace.hpp