eq::base::Clock Class Reference

#include <clock.h>

List of all members.

---

Detailed Description

A class for time measurements.

Definition at line 29 of file clock.h.

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

---

Member Function Documentation

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 72 of file clock.h.

float eq::base::Clock::getTimef

(

)

const [inline]

Returns the time elapsed since the last clock reset.

Returns:

the elapsed time in milliseconds

Definition at line 94 of file clock.h.

Referenced by eq::FrameData::transmit().

Here is the caller graph for this function:

int64_t eq::base::Clock::getTime64

(

)

const [inline]

Returns the time elapsed since the last clock reset.

Returns:

the elapsed time in milliseconds

Definition at line 118 of file clock.h.

double eq::base::Clock::getTimed

(

)

const [inline]

Returns the time elapsed since the last clock reset.

Returns:

the elapsed time in milliseconds

Definition at line 143 of file clock.h.

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 169 of file clock.h.

---

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

• clock.h