Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Related Functions | List of all members
OpenMesh::Utils::Timer Class Reference

`#include <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()

## Public Member Functions
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
| Compare timer values.
bool | operator== (const Timer &t2) const
| Compare timer values.
bool | operator<= (const Timer &t2) const
| Compare timer values.
bool | operator>= (const Timer &t2) const
| Compare timer values.

## 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 Functions
(Note that these are not member functions.)
std::ostream & | operator<< (std::ostream &_o, const Timer &_t)

## Detailed Description

Timer class

Definition at line 87 of file Timer.hh.

## Member Function Documentation

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.

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.

## Friends And Related Function Documentation

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

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

Definition at line 201 of file Timer.hh.

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

- libs_required/OpenMesh/src/OpenMesh/Tools/Utils/Timer.hh