MeVisLab Toolbox Reference
MLTimer Class Reference

#include <mlTimer.h>

Public Member Functions

 MLTimer () noexcept=default
 
 ~MLTimer () noexcept
 
 MLTimer (const MLTimer &)=delete
 
MLTimeroperator= (const MLTimer &)=delete
 
 MLTimer (MLTimer &&) noexcept=default
 
MLTimeroperator= (MLTimer &&) noexcept=default
 
void start ()
 
void stop ()
 
void start (MLTimer &otherToPause)
 The other timer is paused and this timer started. More...
 
void stop (MLTimer &otherToResume)
 The other timer is resumed and this timer stopped. More...
 
double elapsed () const
 Returns the elapsed time in seconds between start() and stop() calls. More...
 
double consumed () const
 Returns the elapsed time minus the time between pause() and resume() calls in seconds. More...
 
unsigned int startCount () const
 

Friends

class MLTimeProfile
 
class MLCallGraphNode
 

Detailed Description

Definition at line 23 of file mlTimer.h.

Constructor & Destructor Documentation

◆ MLTimer() [1/3]

MLTimer::MLTimer ( )
defaultnoexcept

◆ ~MLTimer()

MLTimer::~MLTimer ( )
noexcept

◆ MLTimer() [2/3]

MLTimer::MLTimer ( const MLTimer )
delete

◆ MLTimer() [3/3]

MLTimer::MLTimer ( MLTimer &&  )
defaultnoexcept

Member Function Documentation

◆ consumed()

double MLTimer::consumed ( ) const
inline

Returns the elapsed time minus the time between pause() and resume() calls in seconds.

This represents the 'self time'.

Definition at line 51 of file mlTimer.h.

◆ elapsed()

double MLTimer::elapsed ( ) const
inline

Returns the elapsed time in seconds between start() and stop() calls.

The time between pause() and resume() calls is included. elapsed() minus consumed() represents the 'time in children'.

Definition at line 47 of file mlTimer.h.

◆ operator=() [1/2]

MLTimer& MLTimer::operator= ( const MLTimer )
delete

◆ operator=() [2/2]

MLTimer& MLTimer::operator= ( MLTimer &&  )
defaultnoexcept

◆ start() [1/2]

void MLTimer::start ( )

◆ start() [2/2]

void MLTimer::start ( MLTimer otherToPause)

The other timer is paused and this timer started.

◆ startCount()

unsigned int MLTimer::startCount ( ) const
inline

Definition at line 52 of file mlTimer.h.

◆ stop() [1/2]

void MLTimer::stop ( )

◆ stop() [2/2]

void MLTimer::stop ( MLTimer otherToResume)

The other timer is resumed and this timer stopped.

Friends And Related Function Documentation

◆ MLCallGraphNode

friend class MLCallGraphNode
friend

Definition at line 64 of file mlTimer.h.

◆ MLTimeProfile

friend class MLTimeProfile
friend

Definition at line 63 of file mlTimer.h.


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