SimulationClock Class Reference

Simulates real time measurements for simulations. More...

#include <simulation_clock.hpp>

Inheritance diagram for SimulationClock:

List of all members.

Public Member Functions
virtual Clock *	clone () const
SimulationClock &	operator= (const SimulationClock &rhs)
	SimulationClock ()
	SimulationClock (const SimulationClock &rhs)
virtual returnValue	start ()
virtual returnValue	step (double _timeShift)
virtual returnValue	stop ()
virtual	~SimulationClock ()

---

Detailed Description

Simulates real time measurements for simulations.

The class SimulationClock simulates real time measurements for simulations within the SimulationEnvironment.

Author:

Hans Joachim Ferreau, Boris Houska

Definition at line 53 of file simulation_clock.hpp.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO SimulationClock::SimulationClock

(

)

Default constructor.

Definition at line 43 of file simulation_clock.cpp.

SimulationClock::SimulationClock

(

const SimulationClock &

rhs

)

Copy constructor (deep copy).

Parameters:

[in]

rhs

Right-hand side object.

Definition at line 48 of file simulation_clock.cpp.

SimulationClock::~SimulationClock

(

)

[virtual]

Destructor.

Definition at line 53 of file simulation_clock.cpp.

---

Member Function Documentation

Clock * SimulationClock::clone

(

)

const [virtual]

Clone constructor (deep copy).

Returns:

Pointer to deep copy of base class type

Implements Clock.

Definition at line 69 of file simulation_clock.cpp.

SimulationClock & SimulationClock::operator=

(

const SimulationClock &

rhs

)

Assignment Operator (deep copy).

Parameters:

[in]

rhs

Right-hand side object.

Definition at line 58 of file simulation_clock.cpp.

returnValue SimulationClock::start

(

)

[virtual]

Starts time measurement.

Returns:

SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY

Implements Clock.

Definition at line 75 of file simulation_clock.cpp.

returnValue SimulationClock::step

(

double

_timeShift

)

[virtual]

Shifts measured time by a given offset.

Parameters:

[in]

_timeShift

Time offset.

Returns:

SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY

Implements Clock.

Definition at line 86 of file simulation_clock.cpp.

returnValue SimulationClock::stop

(

)

[virtual]

Stops time measurement.

Returns:

SUCCESSFUL_RETURN,
RET_CLOCK_NOT_READY

Implements Clock.

Definition at line 99 of file simulation_clock.cpp.

---

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

• simulation_clock.hpp
• simulation_clock.cpp