ML Reference
ml::TimeCounter Class Reference

Class to measure precise time intervals. More...

#include <mlTimeCounter.h>

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 MLint64 getStartValueInCounts () const
 Returns the start (=reset, =construction) time of the counter in counts.
 
ML_UTILS_EXPORT MLint64 getCurrentValueInCounts () const
 Returns the current state of the time counter in counts.
 
ML_UTILS_EXPORT MLint64 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.
 
ML_UTILS_EXPORT MLdouble getRunningTimeInNanoSeconds () 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.
 
static ML_UTILS_EXPORT MLdouble getCountResolutionInNanoSeconds ()
 Returns the time interval between two timer counts in nano-seconds.
 

Protected Attributes

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

Detailed Description

Class to measure precise time intervals.

Definition at line 25 of file mlTimeCounter.h.

Constructor & Destructor Documentation

◆ TimeCounter() [1/2]

ML_UTILS_EXPORT ml::TimeCounter::TimeCounter ( )

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

◆ TimeCounter() [2/2]

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

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

Member Function Documentation

◆ getCountResolutionInNanoSeconds()

static ML_UTILS_EXPORT MLdouble ml::TimeCounter::getCountResolutionInNanoSeconds ( )
static

Returns the time interval between two timer counts in nano-seconds.

◆ getCountResolutionInSeconds()

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

Returns the time interval between two timer counts in seconds.

◆ getCurrentValueInCounts()

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

Returns the current state of the time counter in counts.

◆ getCurrentValueInSeconds()

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

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

◆ getRunningTimeInCounts()

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

Returns the difference between current and start time in counts.

◆ getRunningTimeInNanoSeconds()

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

Returns time difference between current and start time in seconds.

◆ getRunningTimeInSeconds()

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

Returns time difference between current and start time in seconds.

◆ getStartValueInCounts()

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

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

◆ getStartValueInSeconds()

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

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

◆ operator=()

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

Assigns the value from the TimeCounter originalCount to *this.

◆ reset()

ML_UTILS_EXPORT void ml::TimeCounter::reset ( )

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

Member Data Documentation

◆ _start

MLint64 ml::TimeCounter::_start
protected

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

Definition at line 76 of file mlTimeCounter.h.


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