Plaquette
 
Loading...
Searching...
No Matches
pq::AbstractChronometer Class Referenceabstract
Inheritance diagram for pq::AbstractChronometer:
Collaboration diagram for pq::AbstractChronometer:

Public Member Functions

 AbstractChronometer ()
 Constructor.
 
virtual void pause ()
 Interrupts the chronometer.
 
virtual void resume ()
 Resumes process.
 
virtual float elapsed () const
 The time currently elapsed by the chronometer (in seconds).
 
virtual bool hasPassed (float timeout) const
 Returns true iff elapsed time has passed given timeout.
 
virtual void setTime (float time)
 Forces current time (in seconds).
 
virtual void addTime (float time)
 Adds/subtracts time to the chronometer.
 
virtual bool hasPassed (float timeout, bool restartIfPassed)
 
virtual bool isRunning () const
 Returns true iff the chronometer is currently running.
 
bool isStarted () const
 
virtual void start ()
 Starts/restarts the chronometer.
 
virtual void stop ()
 Interrupts the chronometer and resets to zero.
 
virtual void togglePause ()
 Toggles pause/unpause.
 

Protected Member Functions

virtual void update ()
 
virtual float _time () const =0
 
virtual void _setRunning (bool isRunning)
 

Protected Attributes

float _startTime
 
float _offsetTime
 
float _elapsedTime
 
bool _isRunning
 

Member Function Documentation

◆ _setRunning()

virtual void pq::AbstractChronometer::_setRunning ( bool  isRunning)
inlineprotectedvirtual

Implements pq::Timeable.

◆ addTime()

void pq::AbstractChronometer::addTime ( float  time)
virtual

Adds/subtracts time to the chronometer.

Implements pq::Timeable.

◆ hasPassed()

bool pq::AbstractChronometer::hasPassed ( float  timeout,
bool  restartIfPassed 
)
virtual
Deprecated:
Returns true iff elapsed time has passed given timeout (optional argument to automatically restart if true).

◆ isRunning()

virtual bool pq::AbstractChronometer::isRunning ( ) const
inlinevirtual

Returns true iff the chronometer is currently running.

Implements pq::Timeable.

◆ isStarted()

bool pq::AbstractChronometer::isStarted ( ) const
inline

◆ pause()

void pq::AbstractChronometer::pause ( )
virtual

Interrupts the chronometer.

Reimplemented from pq::Timeable.

◆ resume()

void pq::AbstractChronometer::resume ( )
virtual

Resumes process.

Reimplemented from pq::Timeable.

◆ setTime()

void pq::AbstractChronometer::setTime ( float  time)
virtual

Forces current time (in seconds).

Implements pq::Timeable.

Reimplemented in pq::Alarm, and pq::Ramp.

◆ start()

void pq::Timeable::start ( )
virtualinherited

Starts/restarts the chronometer.

Reimplemented in pq::AbstractTimer, and pq::Ramp.


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