Public Member Functions | Protected Attributes

Allows real time measurements based on the system's clock. More...

#include <real_clock.hpp>

Inheritance diagram for RealClock:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual Clockclone () const
RealClockoperator= (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.

Author:
Hans Joachim Ferreau, Boris Houska

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]rhsRight-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.

RealClock & RealClock::operator= ( const RealClock rhs)

Assignment Operator (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 59 of file real_clock.cpp.

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]_timeShiftTime offset.
Returns:
SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY,
RET_NO_SYSTEM_TIME

Implements Clock.

Definition at line 94 of file real_clock.cpp.

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:


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:25