TimeOutTrans Class Reference
causes a transition after a specified amount of time has passed More...
#include <TimeOutTrans.h>
Detailed Description
causes a transition after a specified amount of time has passed
If any event parameters are specified, this transition will listen for matching events, and if any are received, it will reset the timer
Definition at line 13 of file TimeOutTrans.h.
Public Member Functions | |
| TimeOutTrans (StateNode *destination, unsigned int delay) | |
| constructor, specify delay in milliseconds | |
| TimeOutTrans (std::string const &name, StateNode *destination, unsigned int delay) | |
| constructor, specify delay in milliseconds | |
| TimeOutTrans (StateNode *destination, unsigned int delay, EventBase::EventGeneratorID_t gid) | |
| constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset | |
| TimeOutTrans (StateNode *destination, unsigned int delay, EventBase::EventGeneratorID_t gid, unsigned int sid) | |
| constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset | |
| TimeOutTrans (StateNode *destination, unsigned int delay, EventBase::EventGeneratorID_t gid, unsigned int sid, EventBase::EventTypeID_t tid) | |
| constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset | |
| virtual void | postStart () |
| starts timer | |
| void | resetTimer () |
| resets timer | |
| virtual void | doEvent () |
| if we receive the timer event, fire() | |
Protected Attributes | |
| unsigned int | d |
| amount to delay (in milliseconds) before transition | |
| unsigned int | eventargcount |
| level of specificity of events to listen for | |
| EventBase::EventGeneratorID_t | egid |
| the event generator to listen for | |
| unsigned int | esid |
| the source to listen for | |
| EventBase::EventTypeID_t | etid |
| the type to listen for | |
Constructor & Destructor Documentation
| TimeOutTrans::TimeOutTrans | ( | StateNode * | destination, | |
| unsigned int | delay | |||
| ) |
constructor, specify delay in milliseconds
Definition at line 16 of file TimeOutTrans.h.
| TimeOutTrans::TimeOutTrans | ( | std::string const & | name, | |
| StateNode * | destination, | |||
| unsigned int | delay | |||
| ) |
constructor, specify delay in milliseconds
Definition at line 21 of file TimeOutTrans.h.
| TimeOutTrans::TimeOutTrans | ( | StateNode * | destination, | |
| unsigned int | delay, | |||
| EventBase::EventGeneratorID_t | gid | |||
| ) |
constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset
Definition at line 26 of file TimeOutTrans.h.
| TimeOutTrans::TimeOutTrans | ( | StateNode * | destination, | |
| unsigned int | delay, | |||
| EventBase::EventGeneratorID_t | gid, | |||
| unsigned int | sid | |||
| ) |
constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset
Definition at line 31 of file TimeOutTrans.h.
| TimeOutTrans::TimeOutTrans | ( | StateNode * | destination, | |
| unsigned int | delay, | |||
| EventBase::EventGeneratorID_t | gid, | |||
| unsigned int | sid, | |||
| EventBase::EventTypeID_t | tid | |||
| ) |
constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset
Definition at line 36 of file TimeOutTrans.h.
Member Function Documentation
| virtual void TimeOutTrans::doEvent | ( | ) | [virtual] |
if we receive the timer event, fire()
Reimplemented from BehaviorBase.
Reimplemented in LostTargetTrans.
Definition at line 58 of file TimeOutTrans.h.
| virtual void TimeOutTrans::postStart | ( | ) | [virtual] |
| void TimeOutTrans::resetTimer | ( | ) |
resets timer
Reimplemented in LostTargetTrans.
Definition at line 52 of file TimeOutTrans.h.
Referenced by doEvent(), and postStart().
Member Data Documentation
unsigned int TimeOutTrans::d [protected] |
amount to delay (in milliseconds) before transition
Definition at line 68 of file TimeOutTrans.h.
Referenced by resetTimer().
EventBase::EventGeneratorID_t TimeOutTrans::egid [protected] |
the event generator to listen for
Definition at line 73 of file TimeOutTrans.h.
Referenced by postStart().
unsigned int TimeOutTrans::esid [protected] |
EventBase::EventTypeID_t TimeOutTrans::etid [protected] |
unsigned int TimeOutTrans::eventargcount [protected] |
level of specificity of events to listen for
Definition at line 71 of file TimeOutTrans.h.
Referenced by postStart().
The documentation for this class was generated from the following file:
