Base class for all kind of time measurements. More...
#include <clock.hpp>
Inheritance diagram for Clock:
Public Member Functions | |
| Clock () | |
| Clock (const Clock &rhs) | |
| virtual Clock * | clone () const =0 |
| ClockStatus | getStatus () const |
| virtual returnValue | getTime (double &_elapsedTime) |
| virtual double | getTime () |
| virtual returnValue | init (double _initialTime) |
| Clock & | operator= (const Clock &rhs) |
| virtual returnValue | reset () |
| virtual returnValue | start ()=0 |
| virtual returnValue | step (double _timeShift)=0 |
| virtual returnValue | stop ()=0 |
| virtual | ~Clock () |
Protected Attributes | |
| double | elapsedTime |
| ClockStatus | status |
Detailed Description
Base class for all kind of time measurements.
The class Clock serves as base class for all kind of time measurements, both real and simulated ones.
Constructor & Destructor Documentation
| Clock::Clock | ( | const Clock & | rhs | ) |
| Clock::~Clock | ( | ) | [virtual] |
Member Function Documentation
| virtual Clock* Clock::clone | ( | ) | const [pure virtual] |
Clone constructor (deep copy).
- Returns:
- Pointer to deep copy of base class type
Implemented in RealClock, and SimulationClock.
| ClockStatus Clock::getStatus | ( | ) | const [inline] |
Returns current status of clock, see documentation of ClockStatus for details.
- Returns:
- Current status of clock
| returnValue Clock::getTime | ( | double & | _elapsedTime | ) | [virtual] |
| double Clock::getTime | ( | ) | [virtual] |
| returnValue Clock::init | ( | double | _initialTime | ) | [virtual] |
| returnValue Clock::reset | ( | ) | [virtual] |
| virtual returnValue Clock::start | ( | ) | [pure virtual] |
Starts time measurement.
- Returns:
- SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY,
RET_NO_SYSTEM_TIME
Implemented in RealClock, and SimulationClock.
| virtual returnValue Clock::step | ( | double | _timeShift | ) | [pure virtual] |
Shifts measured time by a given offset.
- Parameters:
-
[in] _timeShift Time offset.
- Returns:
- SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY,
RET_NO_SYSTEM_TIME
Implemented in RealClock, and SimulationClock.
| virtual returnValue Clock::stop | ( | ) | [pure virtual] |
Stops time measurement.
- Returns:
- SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY,
RET_NO_SYSTEM_TIME
Implemented in RealClock, and SimulationClock.
Member Data Documentation
double Clock::elapsedTime [protected] |
ClockStatus Clock::status [protected] |
The documentation for this class was generated from the following files: