ACADO Toolkit
1.2.0beta
Toolkit for Automatic Control and Dynamic Optimization
|
Simulates real time measurements for simulations. More...
#include <simulation_clock.hpp>
Public Member Functions | |
SimulationClock () | |
Default constructor. | |
SimulationClock (const SimulationClock &rhs) | |
Copy constructor (deep copy). | |
virtual | ~SimulationClock () |
Destructor. | |
SimulationClock & | operator= (const SimulationClock &rhs) |
Assignment Operator (deep copy). | |
virtual Clock * | clone () const |
Clone constructor (deep copy). | |
virtual returnValue | start () |
Starts time measurement. | |
virtual returnValue | step (double _timeShift) |
Shifts measured time by a given offset. | |
virtual returnValue | stop () |
Stops time measurement. | |
virtual returnValue | init (double _initialTime) |
Initializes the clock with given initial time. | |
virtual returnValue | reset () |
Initializes the clock with initial time zero. | |
virtual returnValue | getTime (double &_elapsedTime) |
Returns elapsed time. | |
virtual double | getTime () |
Returns elapsed time. | |
ClockStatus | getStatus () const |
Returns current status of clock, see documentation of ClockStatus for details. | |
Protected Attributes | |
double | elapsedTime |
Elapsed time since last reset. | |
ClockStatus | status |
Status of clock. |
The class SimulationClock simulates real time measurements for simulations within the SimulationEnvironment.
Referenced by clone().
SimulationClock::SimulationClock | ( | const SimulationClock & | rhs | ) |
[in] | rhs | Right-hand side object. |
SimulationClock::~SimulationClock | ( | ) | [virtual] |
Clock * SimulationClock::clone | ( | ) | const [virtual] |
BEGIN_NAMESPACE_ACADO ClockStatus Clock::getStatus | ( | ) | const [inline, inherited] |
References Clock::status.
returnValue Clock::getTime | ( | double & | _elapsedTime | ) | [virtual, inherited] |
[in] | _elapsedTime | Elapsed time. |
References ACADOERROR, CS_NOT_INITIALIZED, CS_RUNNING, CS_STOPPED, Clock::elapsedTime, RET_BLOCK_NOT_READY, RET_UNKNOWN_BUG, Clock::start(), Clock::status, Clock::stop(), and SUCCESSFUL_RETURN.
Referenced by IntegratorBDF::evaluate(), IntegratorRK::evaluate(), IntegratorLYAPUNOV::evaluate(), CondensingBasedCPsolver::finalizeSolve(), Controller::getPreviousRealRuntime(), EllipsoidalIntegrator::integrate(), Controller::obtainEstimates(), SCPmethod::performCurrentStep(), Controller::preparationStep(), SCPmethod::prepareNextStep(), CondensingBasedCPsolver::prepareSolve(), CondensingBasedCPsolver::solveCPsubproblem(), SimulationEnvironment::step(), and SCPmethod::stopClockAndPrintRuntimeProfile().
double Clock::getTime | ( | ) | [virtual, inherited] |
References INFTY, and SUCCESSFUL_RETURN.
returnValue Clock::init | ( | double | _initialTime | ) | [virtual, inherited] |
[in] | _initialTime | Initial time. |
References CS_STOPPED, Clock::elapsedTime, Clock::status, and SUCCESSFUL_RETURN.
Referenced by SimulationEnvironment::init(), Clock::reset(), and SimulationEnvironment::step().
SimulationClock & SimulationClock::operator= | ( | const SimulationClock & | rhs | ) |
[in] | rhs | Right-hand side object. |
returnValue Clock::reset | ( | ) | [virtual, inherited] |
References Clock::init().
Referenced by Clock::Clock(), SCPmethod::feedbackStep(), Controller::feedbackStep(), CondensingBasedCPsolver::finalizeSolve(), Controller::init(), Controller::obtainEstimates(), SCPmethod::performCurrentStep(), SCPmethod::prepareNextStep(), CondensingBasedCPsolver::prepareSolve(), and CondensingBasedCPsolver::solveCPsubproblem().
returnValue SimulationClock::start | ( | ) | [virtual] |
Implements Clock.
References ACADOERROR, CS_RUNNING, CS_STOPPED, RET_CLOCK_NOT_READY, Clock::status, and SUCCESSFUL_RETURN.
Referenced by step().
returnValue SimulationClock::step | ( | double | _timeShift | ) | [virtual] |
[in] | _timeShift | Time offset. |
Implements Clock.
References Clock::elapsedTime, start(), stop(), and SUCCESSFUL_RETURN.
returnValue SimulationClock::stop | ( | ) | [virtual] |
Implements Clock.
References ACADOERROR, CS_NOT_INITIALIZED, CS_STOPPED, RET_CLOCK_NOT_READY, Clock::status, and SUCCESSFUL_RETURN.
Referenced by step().
double Clock::elapsedTime [protected, inherited] |
Referenced by Clock::Clock(), Clock::getTime(), Clock::init(), Clock::operator=(), step(), RealClock::step(), and RealClock::stop().
ClockStatus Clock::status [protected, inherited] |
Referenced by Clock::Clock(), Clock::getStatus(), Clock::getTime(), Clock::init(), Clock::operator=(), start(), RealClock::start(), stop(), and RealClock::stop().