ML Reference
ml::ProcessingTimeLine Class Reference

Stores a processing time line for multiple threads. More...

#include <mlProcessingTimeLine.h>

List of all members.

Classes

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

Public Member Functions

 ProcessingTimeLine ()
 ~ProcessingTimeLine ()
void copyFrom (ProcessingTimeLine &timeline)
 copy data from given timeline
TimeLineaddTimeLine (const std::string &name)
 adds a time line with given name, ownership stays with ProcessingTimeLine
void removeTimeLine (TimeLine *timeLine)
 removes the given time line (and deletes it)
int getNumTimeLines () const
 get the number of time lines
TimeLinegetTimeLine (int i) const
 get time line with given index
void resetRunningTime ()
 reset the running time (which affects getRunningTime())
void resetTimeLines ()
 reset the time lines (without deleting them)
double getRunningTime ()
 get the current running time in seconds
double getMaximumTime ()
 searches and returns the highest time point that was measured over all time lines
double getMinimumTime ()
 searches and returns the smallest time point that was measured over all time lines
void save (const std::string &fileName)
 save timeline to disk
void load (const std::string &fileName)
 read timeline from disk
void clear ()
 clears/removes the timelines

Detailed Description

Stores a processing time line for multiple threads.

Definition at line 23 of file mlProcessingTimeLine.h.


Constructor & Destructor Documentation

ml::ProcessingTimeLine::ProcessingTimeLine ( )
ml::ProcessingTimeLine::~ProcessingTimeLine ( )

Member Function Documentation

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

adds a time line with given name, ownership stays with ProcessingTimeLine

void ml::ProcessingTimeLine::clear ( )

clears/removes the timelines

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

copy data from given timeline

double ml::ProcessingTimeLine::getMaximumTime ( )

searches and returns the highest time point that was measured over all time lines

double ml::ProcessingTimeLine::getMinimumTime ( )

searches and returns the smallest time point that was measured over all time lines

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

get the number of time lines

Definition at line 85 of file mlProcessingTimeLine.h.

double ml::ProcessingTimeLine::getRunningTime ( )

get the current running time in seconds

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

get time line with given index

Definition at line 88 of file mlProcessingTimeLine.h.

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

read timeline from disk

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

removes the given time line (and deletes it)

void ml::ProcessingTimeLine::resetRunningTime ( ) [inline]

reset the running time (which affects getRunningTime())

Definition at line 91 of file mlProcessingTimeLine.h.

void ml::ProcessingTimeLine::resetTimeLines ( )

reset the time lines (without deleting them)

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

save timeline to disk


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