ML Reference
Classes | Public Member Functions | List of all members
ml::ProcessingTimeLine Class Reference

Stores a processing timeline for multiple threads. More...

#include <mlProcessingTimeLine.h>

Classes

class  TimeLine
 Timeline for a single thread. More...
 

Public Member Functions

 ProcessingTimeLine ()
 
 ~ProcessingTimeLine ()
 
void copyFrom (ProcessingTimeLine &timeline)
 Copies data from given timeline.
 
TimeLine * addTimeLine (const std::string &name)
 Adds a timeline with the given name. The ownership stays with ProcessingTimeLine.
 
void removeTimeLine (TimeLine *timeLine)
 Removes the given timeline and deletes it.
 
int getNumTimeLines () const
 Returns the number of timelines.
 
TimeLine * getTimeLine (int i) const
 Returns the timeline with given index i.
 
void resetRunningTime ()
 Resets the running time, which affects getRunningTime().
 
void resetTimeLines ()
 Resets the timelines without deleting them.
 
double getRunningTime ()
 Returns the current running time in seconds.
 
double getMaximumTime ()
 Searches and returns the latest time point measured over all timelines.
 
double getMinimumTime ()
 Searches and returns the earliest time point measured over all timelines.
 
void save (const std::string &fileName)
 Saves timeline to disk.
 
void load (const std::string &fileName)
 Reads timeline from disk.
 
void clear ()
 Clears/removes the timelines.
 

Detailed Description

Stores a processing timeline for multiple threads.

Definition at line 29 of file mlProcessingTimeLine.h.

Constructor & Destructor Documentation

◆ ProcessingTimeLine()

ml::ProcessingTimeLine::ProcessingTimeLine ( )

◆ ~ProcessingTimeLine()

ml::ProcessingTimeLine::~ProcessingTimeLine ( )

Member Function Documentation

◆ addTimeLine()

TimeLine * ml::ProcessingTimeLine::addTimeLine ( const std::string & name)

Adds a timeline with the given name. The ownership stays with ProcessingTimeLine.

◆ clear()

void ml::ProcessingTimeLine::clear ( )

Clears/removes the timelines.

◆ copyFrom()

void ml::ProcessingTimeLine::copyFrom ( ProcessingTimeLine & timeline)

Copies data from given timeline.

◆ getMaximumTime()

double ml::ProcessingTimeLine::getMaximumTime ( )

Searches and returns the latest time point measured over all timelines.

◆ getMinimumTime()

double ml::ProcessingTimeLine::getMinimumTime ( )

Searches and returns the earliest time point measured over all timelines.

◆ getNumTimeLines()

int ml::ProcessingTimeLine::getNumTimeLines ( ) const
inline

Returns the number of timelines.

Definition at line 91 of file mlProcessingTimeLine.h.

◆ getRunningTime()

double ml::ProcessingTimeLine::getRunningTime ( )

Returns the current running time in seconds.

◆ getTimeLine()

TimeLine * ml::ProcessingTimeLine::getTimeLine ( int i) const
inline

Returns the timeline with given index i.

Definition at line 94 of file mlProcessingTimeLine.h.

◆ load()

void ml::ProcessingTimeLine::load ( const std::string & fileName)

Reads timeline from disk.

◆ removeTimeLine()

void ml::ProcessingTimeLine::removeTimeLine ( TimeLine * timeLine)

Removes the given timeline and deletes it.

◆ resetRunningTime()

void ml::ProcessingTimeLine::resetRunningTime ( )
inline

Resets the running time, which affects getRunningTime().

Definition at line 97 of file mlProcessingTimeLine.h.

◆ resetTimeLines()

void ml::ProcessingTimeLine::resetTimeLines ( )

Resets the timelines without deleting them.

◆ save()

void ml::ProcessingTimeLine::save ( const std::string & fileName)

Saves timeline to disk.

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