Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

TimeOutTrans Class Reference

#include <TimeOutTrans.h>

Inheritance diagram for TimeOutTrans:

Inheritance graph
[legend]
List of all members.

Detailed Description

causes a transition after a specified amount of time has passed

Definition at line 9 of file TimeOutTrans.h.

Public Member Functions

 TimeOutTrans (StateNode *source, StateNode *destination, unsigned int delay)
 constructor, specify delay in milliseconds

virtual void DoStart ()
 starts timer

virtual void DoStop ()
 stops timer

void resetTimer ()
 resets timer

virtual void processEvent (const EventBase &e)
 if we receive the timer event, activate()

virtual std::string getName () const
 Identifies the behavior in menus and such.


Protected Attributes

unsigned int d
 amount to delay (in milliseconds) before transition

Constructor & Destructor Documentation

TimeOutTrans::TimeOutTrans (  StateNode *  source,
StateNode *  destination,
unsigned int  delay
)  [inline]
 

constructor, specify delay in milliseconds

Definition at line 12 of file TimeOutTrans.h.

References d.

Member Function Documentation

virtual void TimeOutTrans::DoStart (   )  [inline, virtual]
 

starts timer

Reimplemented from BehaviorBase.

Definition at line 15 of file TimeOutTrans.h.

References BehaviorBase::DoStart(), and resetTimer().

Here is the call graph for this function:

virtual void TimeOutTrans::DoStop (   )  [inline, virtual]
 

stops timer

Reimplemented from BehaviorBase.

Definition at line 21 of file TimeOutTrans.h.

References BehaviorBase::DoStop(), erouter, and EventRouter::forgetListener().

Here is the call graph for this function:

virtual std::string TimeOutTrans::getName (   )  const [inline, virtual]
 

Identifies the behavior in menus and such.

Implements BehaviorBase.

Definition at line 35 of file TimeOutTrans.h.

virtual void TimeOutTrans::processEvent (  const EventBase &  e  )  [inline, virtual]
 

if we receive the timer event, activate()

Reimplemented from BehaviorBase.

Definition at line 30 of file TimeOutTrans.h.

References Transition::activate(), get_time(), and EventBase::getName().

Here is the call graph for this function:

void TimeOutTrans::resetTimer (   )  [inline]
 

resets timer

Definition at line 24 of file TimeOutTrans.h.

References EventRouter::addTimer(), d, erouter, and get_time().

Here is the call graph for this function:

Member Data Documentation

unsigned int TimeOutTrans::d [protected]
 

amount to delay (in milliseconds) before transition

Definition at line 39 of file TimeOutTrans.h.

The documentation for this class was generated from the following file:
Tekkotsu v1.5
 		Generated Fri Oct 10 15:58:00 2003 by Doxygen 1.3.4