Public Member Functions | Protected Attributes
DriverTimer Class Reference

driver timer class. More...

#include <dtimer.h>

List of all members.

Public Member Functions

virtual void Cancel (void)
 Cancel timer.
virtual bool Check (void)
 Return true if timer has expired.
 DriverTimer ()
virtual void Restart (double duration)
 Restart timer.
virtual void Start (double duration)
 Start timer.
virtual ~DriverTimer ()

Protected Attributes

double time_remaining
bool timer_running

Detailed Description

driver timer class.

Definition at line 20 of file dtimer.h.

Constructor & Destructor Documentation


Definition at line 25 of file dtimer.h.

virtual DriverTimer::~DriverTimer ( ) [inline, virtual]

Definition at line 30 of file dtimer.h.

Member Function Documentation

virtual void DriverTimer::Cancel ( void  ) [inline, virtual]

Cancel timer.

Definition at line 33 of file dtimer.h.

virtual bool DriverTimer::Check ( void  ) [inline, virtual]

Return true if timer has expired.

Called once per cycle while timer is running. Skipped cycles do not contribute to timer expiration. That allows timers to pause while the vehicle is pausing. It should not immediately begin passing after pausing behind a stopped vehicle, for example.

Definition at line 45 of file dtimer.h.

virtual void DriverTimer::Restart ( double  duration) [inline, virtual]

Restart timer.

Conditionally start timer unless running and not expired.

Definition at line 59 of file dtimer.h.

virtual void DriverTimer::Start ( double  duration) [inline, virtual]

Start timer.

Definition at line 68 of file dtimer.h.

Member Data Documentation

double DriverTimer::time_remaining [protected]

Definition at line 76 of file dtimer.h.

Definition at line 77 of file dtimer.h.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Author(s): Austin Robot Technology, Jack O'Quin
autogenerated on Tue Sep 24 2013 10:43:23