CoachingEngine::Clock Class Reference

#include <Clock.h>

Public Member Functions
double	getTime ()
double	getPreviousTime ()
void	scheduleTimer (Timer timer)
void	clearTimers ()
void	advanceToTime (double time)
AIMValue	getRequirement () const
bool	isRequirementUpdated (bool reset=true) const
void	setPreviousTime (double time)

Detailed Description

Clock class that is responsible for handling timer. This class needs the latest time as input. It handles the requiremenrt needed to set timers in AIM.

Member Function Documentation

void CoachingEngine::Clock::clearTimers

(

)

Clear all timers. This might affect the requirement of the clock.

double CoachingEngine::Clock::getPreviousTime ( )

inline

Return previous time of the clock.

Returns

previous time the clock was set to

AIMValue CoachingEngine::Clock::getRequirement

(

)

const

Returnthe requirement.

Returns

A single requirement for the first scheduled timer. Returns an empty AIMValue if there is no scheduled timer.

double CoachingEngine::Clock::getTime ( )

inline

Return time of the clock.

Returns

time the clock is set to

bool CoachingEngine::Clock::isRequirementUpdated

(

bool

reset = true

)

const

Return wether the requirement has been updated since the last call to this function.

Parameters

reset

If false, don't reset whether the requirement has been updated.

Returns

true if the requirements are updated since the last call to this function, otherwise false.

void CoachingEngine::Clock::scheduleTimer

(

Timer

timer

)

Schedule a new timer. This might affect the requirement of the clock.

Parameters

timer

the timer to be scheduled

void CoachingEngine::Clock::setPreviousTime ( double  time )

inline

set the previous time

---

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

• modules/modules/Coaches/inc/Clock.h
• modules/modules/Coaches/src/Clock.cpp