NavTimer Class Reference

Navigator node timer class. More...

#include <ntimer.h>

List of all members.

Public Member Functions
virtual void	Cancel (void)
	Cancel timer.
virtual bool	Check (void)
	Return true if timer has expired.
	NavTimer ()
	Constructor.
virtual void	Restart (double duration)
	Restart timer.
virtual void	Start (double duration)
	Start timer.
virtual	~NavTimer ()
Protected Attributes
double	time_remaining
bool	timer_running

---

Detailed Description

Navigator node timer class.

This class is specific to the navigator node.

Definition at line 22 of file ntimer.h.

---

Constructor & Destructor Documentation

NavTimer::NavTimer

(

)

[inline]

Constructor.

Definition at line 27 of file ntimer.h.

virtual NavTimer::~NavTimer

(

)

[inline, virtual]

Definition at line 32 of file ntimer.h.

---

Member Function Documentation

virtual void NavTimer::Cancel

(

void

)

[inline, virtual]

Cancel timer.

Definition at line 35 of file ntimer.h.

virtual bool NavTimer::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 47 of file ntimer.h.

virtual void NavTimer::Restart

(

double

duration

)

[inline, virtual]

Restart timer.

Conditionally start timer unless running and not expired.

Definition at line 61 of file ntimer.h.

virtual void NavTimer::Start

(

double

duration

)

[inline, virtual]

Start timer.

Definition at line 70 of file ntimer.h.

---

Member Data Documentation

double NavTimer::time_remaining [protected]

Definition at line 78 of file ntimer.h.

bool NavTimer::timer_running [protected]

Definition at line 79 of file ntimer.h.

---

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

• ntimer.h