Homepage Demos Overview Downloads Tutorials Reference
Credits

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 *destination, unsigned int delay)
 constructor, specify delay in milliseconds
 TimeOutTrans (const std::string &name, 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 &)
 if we receive the timer event, fire()

Protected Member Functions

 TimeOutTrans (const std::string &classname, const std::string &instancename, StateNode *destination, unsigned int delay)
 constructor, specify delay in milliseconds

Protected Attributes

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


Constructor & Destructor Documentation

TimeOutTrans::TimeOutTrans StateNode destination,
unsigned int  delay
[inline]
 

constructor, specify delay in milliseconds

Definition at line 12 of file TimeOutTrans.h.

TimeOutTrans::TimeOutTrans const std::string &  name,
StateNode destination,
unsigned int  delay
[inline]
 

constructor, specify delay in milliseconds

Definition at line 15 of file TimeOutTrans.h.

TimeOutTrans::TimeOutTrans const std::string &  classname,
const std::string &  instancename,
StateNode destination,
unsigned int  delay
[inline, protected]
 

constructor, specify delay in milliseconds

Definition at line 40 of file TimeOutTrans.h.


Member Function Documentation

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

starts timer

Reimplemented from BehaviorBase.

Reimplemented in LostTargetTrans.

Definition at line 18 of file TimeOutTrans.h.

Referenced by LostTargetTrans::DoStart().

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

stops timer

Reimplemented from BehaviorBase.

Definition at line 24 of file TimeOutTrans.h.

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

if we receive the timer event, fire()

Reimplemented from BehaviorBase.

Reimplemented in LostTargetTrans.

Definition at line 33 of file TimeOutTrans.h.

Referenced by LostTargetTrans::processEvent().

void TimeOutTrans::resetTimer  )  [inline]
 

resets timer

Reimplemented in LostTargetTrans.

Definition at line 27 of file TimeOutTrans.h.

Referenced by DoStart(), WalkToTargetMachine::processEvent(), and LostTargetTrans::resetTimer().


Member Data Documentation

unsigned int TimeOutTrans::d [protected]
 

amount to delay (in milliseconds) before transition

Definition at line 43 of file TimeOutTrans.h.

Referenced by resetTimer(), and TimeOutTrans().


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

Tekkotsu v2.2.1
Generated Tue Nov 23 16:37:53 2004 by Doxygen 1.3.9.1