MeVisLab Toolbox Reference
MLTimer Class Reference

#include <mlTimer.h>

Public Member Functions

 MLTimer () noexcept=default
 ~MLTimer () noexcept
 MLTimer (const MLTimer &)=delete
MLTimer & operator= (const MLTimer &)=delete
 MLTimer (MLTimer &&) noexcept=default
MLTimer & operator= (MLTimer &&) noexcept=default
void start ()
void stop ()
void start (MLTimer &otherToPause)
 The other timer is paused and this timer started.
void stop (MLTimer &otherToResume)
 The other timer is resumed and this timer stopped.
double elapsed () const
double consumed () const
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

Referenced by MLTimer(), MLTimer(), operator=(), operator=(), start(), stop(), and ~MLTimer().

◆ ~MLTimer()

MLTimer::~MLTimer ( )
noexcept

References MLTimer().

◆ MLTimer() [2/3]

MLTimer::MLTimer ( const MLTimer & )
delete

References MLTimer().

◆ MLTimer() [3/3]

MLTimer::MLTimer ( MLTimer && )
defaultnoexcept

References MLTimer().

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.

References elapsed().

Referenced by elapsed().

◆ operator=() [1/2]

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

References MLTimer().

◆ operator=() [2/2]

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

References MLTimer().

◆ start() [1/2]

void MLTimer::start ( )

References start().

Referenced by start(), and start().

◆ start() [2/2]

void MLTimer::start ( MLTimer & otherToPause)

The other timer is paused and this timer started.

References MLTimer(), and start().

◆ startCount()

unsigned int MLTimer::startCount ( ) const
inline

Definition at line 52 of file mlTimer.h.

◆ stop() [1/2]

void MLTimer::stop ( )

References stop().

Referenced by stop(), and stop().

◆ stop() [2/2]

void MLTimer::stop ( MLTimer & otherToResume)

The other timer is resumed and this timer stopped.

References MLTimer(), and stop().

◆ MLCallGraphNode

friend class MLCallGraphNode
friend

Definition at line 64 of file mlTimer.h.

References MLCallGraphNode.

Referenced by MLCallGraphNode.

◆ MLTimeProfile

friend class MLTimeProfile
friend

Definition at line 63 of file mlTimer.h.

References MLTimeProfile.

Referenced by MLTimeProfile.

The documentation for this class was generated from the following file:
  • MeVis/Foundation/Sources/MLProfilingManager/Include/mlTimer.h