Developer Documentation
Loading...
Searching...
No Matches
OpenMesh::Utils::Timer Class Reference

#include <OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Tools/Utils/Timer.hh>

Public Types

enum  Format {
  Automatic , Long , Hours , Minutes ,
  Seconds , HSeconds , MSeconds , MicroSeconds ,
  NanoSeconds
}
 Formatting options for member Timer::as_string() More...
 

Public Member Functions

 Timer (const Timer &_other)=delete
 Make the timer non copyable.
 
Timeroperator= (const Timer &)=delete
 Make the timer non copyable.
 
bool is_valid () const
 Returns true if self is in a valid state!
 
bool is_stopped () const
 
void reset (void)
 Reset the timer.
 
void start (void)
 Start measurement.
 
void stop (void)
 Stop measurement.
 
void cont (void)
 Continue measurement.
 
float resolution () const
 Give resolution of timer. Depends on the underlying measurement method.
 
double seconds (void) const
 Returns measured time in seconds, if the timer is in state 'Stopped'.
 
double hseconds (void) const
 Returns measured time in hundredth seconds, if the timer is in state 'Stopped'.
 
double mseconds (void) const
 Returns measured time in milli seconds, if the timer is in state 'Stopped'.
 
double useconds (void) const
 Returns measured time in micro seconds, if the timer is in state 'Stopped'.
 
std::string as_string (Format format=Automatic)
 
bool operator< (const Timer &t2) const
 Compare timer values.
 
bool operator> (const Timer &t2) const
 
bool operator== (const Timer &t2) const
 
bool operator<= (const Timer &t2) const
 
bool operator>= (const Timer &t2) const
 

Static Public Member Functions

static std::string as_string (double seconds, Format format=Automatic)
 

Protected Types

enum  { Invalid = -1 , Stopped = 0 , Running = 1 }
 

Protected Attributes

TimerImpl * impl_
 
enum OpenMesh::Utils::Timer:: { ... }  state_
 

Related Symbols

(Note that these are not member symbols.)

std::ostream & operator<< (std::ostream &_o, const Timer &_t)
 

Detailed Description

Timer class

Definition at line 82 of file Timer.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Definition at line 192 of file Timer.hh.

◆ Format

Formatting options for member Timer::as_string()

Definition at line 87 of file Timer.hh.

Member Function Documentation

◆ as_string() [1/2]

static std::string OpenMesh::Utils::Timer::as_string ( double  seconds,
Format  format = Automatic 
)
static

Returns a given measured time as a string. Use the format flags to specify a wanted resolution.

◆ as_string() [2/2]

std::string OpenMesh::Utils::Timer::as_string ( Format  format = Automatic)

Returns the measured time as a string. Use the format flags to specify a wanted resolution.

◆ hseconds()

double OpenMesh::Utils::Timer::hseconds ( void  ) const
inline

Returns measured time in hundredth seconds, if the timer is in state 'Stopped'.

Definition at line 133 of file Timer.hh.

◆ is_stopped()

bool OpenMesh::Utils::Timer::is_stopped ( ) const
inline

Definition at line 112 of file Timer.hh.

◆ is_valid()

bool OpenMesh::Utils::Timer::is_valid ( ) const
inline

Returns true if self is in a valid state!

Definition at line 110 of file Timer.hh.

◆ mseconds()

double OpenMesh::Utils::Timer::mseconds ( void  ) const
inline

Returns measured time in milli seconds, if the timer is in state 'Stopped'.

Definition at line 136 of file Timer.hh.

◆ operator<()

bool OpenMesh::Utils::Timer::operator< ( const Timer t2) const
inline

Compare timer values.

Definition at line 157 of file Timer.hh.

◆ operator<=()

bool OpenMesh::Utils::Timer::operator<= ( const Timer t2) const
inline

Definition at line 175 of file Timer.hh.

◆ operator==()

bool OpenMesh::Utils::Timer::operator== ( const Timer t2) const
inline

Definition at line 169 of file Timer.hh.

◆ operator>()

bool OpenMesh::Utils::Timer::operator> ( const Timer t2) const
inline

Definition at line 163 of file Timer.hh.

◆ operator>=()

bool OpenMesh::Utils::Timer::operator>= ( const Timer t2) const
inline

Definition at line 181 of file Timer.hh.

◆ useconds()

double OpenMesh::Utils::Timer::useconds ( void  ) const
inline

Returns measured time in micro seconds, if the timer is in state 'Stopped'.

Definition at line 139 of file Timer.hh.

Friends And Related Symbol Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  _o,
const Timer _t 
)
related

Write seconds to output stream. Timer must be stopped before.

Definition at line 205 of file Timer.hh.

Member Data Documentation

◆ impl_

TimerImpl* OpenMesh::Utils::Timer::impl_
protected

Definition at line 190 of file Timer.hh.


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