Allows real time measurements based on the system's clock. More...
#include <real_clock.hpp>
Public Member Functions | |
| virtual Clock * | clone () const |
| RealClock & | operator= (const RealClock &rhs) |
| RealClock () | |
| RealClock (const RealClock &rhs) | |
| virtual returnValue | start () |
| virtual returnValue | step (double _timeShift) |
| virtual returnValue | stop () |
| virtual | ~RealClock () |
Protected Attributes | |
| double | lastTimeInstant |
Detailed Description
Allows real time measurements based on the system's clock.
The class RealClock allows real time measurements based on the system's clock.
Definition at line 53 of file real_clock.hpp.
Constructor & Destructor Documentation
Default constructor.
Definition at line 42 of file real_clock.cpp.
| RealClock::RealClock | ( | const RealClock & | rhs | ) |
Copy constructor (deep copy).
- Parameters:
-
[in] rhs Right-hand side object.
Definition at line 48 of file real_clock.cpp.
| RealClock::~RealClock | ( | ) | [virtual] |
Destructor.
Definition at line 54 of file real_clock.cpp.
Member Function Documentation
| Clock * RealClock::clone | ( | ) | const [virtual] |
Clone constructor (deep copy).
- Returns:
- Pointer to deep copy of base class type
Implements Clock.
Definition at line 72 of file real_clock.cpp.
Assignment Operator (deep copy).
- Parameters:
-
[in] rhs Right-hand side object.
Definition at line 59 of file real_clock.cpp.
| returnValue RealClock::start | ( | ) | [virtual] |
Starts time measurement.
- Returns:
- SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY,
RET_NO_SYSTEM_TIME
Implements Clock.
Definition at line 78 of file real_clock.cpp.
| returnValue RealClock::step | ( | double | _timeShift | ) | [virtual] |
Shifts measured time by a given offset.
- Parameters:
-
[in] _timeShift Time offset.
- Returns:
- SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY,
RET_NO_SYSTEM_TIME
Implements Clock.
Definition at line 94 of file real_clock.cpp.
| returnValue RealClock::stop | ( | ) | [virtual] |
Stops time measurement.
- Returns:
- SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY,
RET_NO_SYSTEM_TIME
Implements Clock.
Definition at line 107 of file real_clock.cpp.
Member Data Documentation
double RealClock::lastTimeInstant [protected] |
Last time instant at which start() has been called.
Definition at line 123 of file real_clock.hpp.
The documentation for this class was generated from the following files: