eq::base::Clock Class Reference

A class for time measurements. More...

#include <clock.h>

List of all members.

Public Member Functions
	Clock ()
	Construct a new clock.
	~Clock ()
	Destroy the clock.
void	reset ()
	Reset the base time of the clock to the current time.
void	setAlarm (const float time)
	Set an alarm.
void	set (const int64_t time)
	Set the current time of the clock.
float	getTimef () const
int64_t	getTime64 () const
double	getTimed () const
float	getMSf () const
	Returns the millisecond part of the time elapsed since the last reset.

---

Detailed Description

A class for time measurements.

Definition at line 40 of file clock.h.

---

Constructor & Destructor Documentation

eq::base::Clock::Clock

(

)

[inline]

Construct a new clock.

Definition at line 44 of file clock.h.

References reset().

Here is the call graph for this function:

eq::base::Clock::~Clock

(

)

[inline]

Destroy the clock.

Definition at line 55 of file clock.h.

---

Member Function Documentation

void eq::base::Clock::reset

(

)

[inline]

Reset the base time of the clock to the current time.

Definition at line 58 of file clock.h.

Referenced by Clock(), eq::ROIFinder::findRegions(), eqPly::EqPly::run(), set(), and setAlarm().

Here is the caller graph for this function:

void eq::base::Clock::setAlarm

(

const float

time

)

[inline]

Set an alarm.

The clock will return negative, decreasing times when the alarm has not been reached.

Parameters:

time

The time in milliseconds when the alarm happens.

Definition at line 77 of file clock.h.

References reset().

Here is the call graph for this function:

void eq::base::Clock::set

(

const int64_t

time

)

[inline]

Set the current time of the clock.

Definition at line 101 of file clock.h.

References reset().

Here is the call graph for this function:

float eq::base::Clock::getTimef

(

)

const [inline]

Returns:

the elapsed time in milliseconds since the last clock reset.

Definition at line 127 of file clock.h.

Referenced by eq::ROIFinder::findRegions(), and eqPly::EqPly::run().

Here is the caller graph for this function:

int64_t eq::base::Clock::getTime64

(

)

const [inline]

Returns:

the elapsed time in milliseconds since the last clock reset.

Definition at line 149 of file clock.h.

Referenced by eq::Config::getTime().

Here is the caller graph for this function:

double eq::base::Clock::getTimed

(

)

const [inline]

Returns:

the elapsed time in milliseconds since the last clock reset.

Definition at line 172 of file clock.h.

Referenced by getMSf().

Here is the caller graph for this function:

float eq::base::Clock::getMSf

(

)

const [inline]

Returns the millisecond part of the time elapsed since the last reset.

Obviously the returned time overflows once per second.

Returns:

the millisecond part of the time elapsed.

Definition at line 198 of file clock.h.

References getTimed().

Here is the call graph for this function:

---

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

• clock.h