ML Reference
ml::TimeCounter Class Reference

Class to measure precise time intervals. More...

#include <mlTimeCounter.h>

List of all members.

Public Member Functions

ML_UTILS_EXPORT TimeCounter ()
 Constructs a time counter object and saves the current time count as a start value.
ML_UTILS_EXPORT TimeCounter (const TimeCounter &originalCount)
 Constructs a new time counter with the time count of originalCount.
ML_UTILS_EXPORT TimeCounteroperator= (const TimeCounter &originalCount)
 Assigns the value from the TimeCounter originalCount to *this.
ML_UTILS_EXPORT void reset ()
 Reinitializes TimeCounter with the current time count as the start time.
ML_UTILS_EXPORT MLdouble getStartValueInCounts () const
 Returns the start (=reset, =construction) time of the counter in counts.
ML_UTILS_EXPORT MLdouble getCurrentValueInCounts () const
 Returns the current state of the time counter in counts.
ML_UTILS_EXPORT MLdouble getRunningTimeInCounts () const
 Returns the difference between current and start time in counts.
ML_UTILS_EXPORT MLdouble getStartValueInSeconds () const
 Returns the start value of the time counter in seconds since an unknown start time base.
ML_UTILS_EXPORT MLdouble getCurrentValueInSeconds () const
 Returns the current state of the time counter in seconds since an unknown start time base.
ML_UTILS_EXPORT MLdouble getRunningTimeInSeconds () const
 Returns time difference between current and start time in seconds.

Static Public Member Functions

static ML_UTILS_EXPORT MLdouble getCountResolutionInSeconds ()
 Returns the time interval between two timer counts in seconds.

Protected Attributes

MLdouble _start
 Counter value in counts on construction/reset time of first TimeCounter object.

Detailed Description

Class to measure precise time intervals.

Definition at line 22 of file mlTimeCounter.h.


Constructor & Destructor Documentation

ML_UTILS_EXPORT ml::TimeCounter::TimeCounter ( )

Constructs a time counter object and saves the current time count as a start value.

ML_UTILS_EXPORT ml::TimeCounter::TimeCounter ( const TimeCounter originalCount)

Constructs a new time counter with the time count of originalCount.


Member Function Documentation

static ML_UTILS_EXPORT MLdouble ml::TimeCounter::getCountResolutionInSeconds ( ) [static]

Returns the time interval between two timer counts in seconds.

ML_UTILS_EXPORT MLdouble ml::TimeCounter::getCurrentValueInCounts ( ) const

Returns the current state of the time counter in counts.

ML_UTILS_EXPORT MLdouble ml::TimeCounter::getCurrentValueInSeconds ( ) const

Returns the current state of the time counter in seconds since an unknown start time base.

ML_UTILS_EXPORT MLdouble ml::TimeCounter::getRunningTimeInCounts ( ) const

Returns the difference between current and start time in counts.

ML_UTILS_EXPORT MLdouble ml::TimeCounter::getRunningTimeInSeconds ( ) const

Returns time difference between current and start time in seconds.

ML_UTILS_EXPORT MLdouble ml::TimeCounter::getStartValueInCounts ( ) const

Returns the start (=reset, =construction) time of the counter in counts.

ML_UTILS_EXPORT MLdouble ml::TimeCounter::getStartValueInSeconds ( ) const

Returns the start value of the time counter in seconds since an unknown start time base.

ML_UTILS_EXPORT TimeCounter& ml::TimeCounter::operator= ( const TimeCounter originalCount)

Assigns the value from the TimeCounter originalCount to *this.

ML_UTILS_EXPORT void ml::TimeCounter::reset ( )

Reinitializes TimeCounter with the current time count as the start time.


Member Data Documentation

Counter value in counts on construction/reset time of first TimeCounter object.

Definition at line 67 of file mlTimeCounter.h.


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