Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

Phx::Clock::Timer Class Reference

The Timer is a sub-interface to a clock that keeps track of elapsed time relative to the clock. More...

#include <PhxClock.h>

Inheritance diagram for Phx::Clock::Timer:

Phx::LockedPtrInterface< Clock::Timer > List of all members.

Public Member Functions

virtual double time (void)=0
 Read the current timer time.
virtual void time (double time)=0
 Sets the current reported time to time.
virtual double rate (void) const =0
 Gets the current rate of this Timer.
virtual void rate (double rate)=0
 Sets the "rate" at which the Timer changes.

Detailed Description

The Timer is a sub-interface to a clock that keeps track of elapsed time relative to the clock.


Member Function Documentation

virtual void Phx::Clock::Timer::rate double  rate  )  [pure virtual]
 

Sets the "rate" at which the Timer changes.

Parameters:
rate The new rate at which this Timer's time will change relative to its reference time.

virtual double Phx::Clock::Timer::rate void   )  const [pure virtual]
 

Gets the current rate of this Timer.

Returns:
The current rate at which this Timer's reported time will change relative to its reference Clock.

virtual void Phx::Clock::Timer::time double  time  )  [pure virtual]
 

Sets the current reported time to time.

Parameters:
time The new time value for this Timer.

virtual double Phx::Clock::Timer::time void   )  [pure virtual]
 

Read the current timer time.

Returns:
The time accumulated by this Timer.


The documentation for this class was generated from the following file:
Generated on Mon Jul 10 19:45:29 2006 for Phoenix OSFS by  doxygen 1.4.2