TimeOutTrans Class Reference
#include <TimeOutTrans.h>
Inheritance diagram for TimeOutTrans:
Detailed Description
causes a transition after a specified amount of time has passedIf 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 12 of file TimeOutTrans.h.
Public Member Functions | |
| TimeOutTrans (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 | DoStart () |
| starts timer | |
| virtual void | DoStop () |
| stops timer | |
| void | resetTimer () |
| resets timer | |
| virtual void | processEvent (const EventBase &e) |
| 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 - use assignment in your subclass's constructor if you want set egid,esid,etid (don't forget eventargcount!) | |
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 | |||
| ) | [inline] |
| TimeOutTrans::TimeOutTrans | ( | StateNode * | destination, | |
| unsigned int | delay, | |||
| EventBase::EventGeneratorID_t | gid | |||
| ) | [inline] |
constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset
Definition at line 20 of file TimeOutTrans.h.
| TimeOutTrans::TimeOutTrans | ( | StateNode * | destination, | |
| unsigned int | delay, | |||
| EventBase::EventGeneratorID_t | gid, | |||
| unsigned int | sid | |||
| ) | [inline] |
constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset
Definition at line 25 of file TimeOutTrans.h.
| TimeOutTrans::TimeOutTrans | ( | StateNode * | destination, | |
| unsigned int | delay, | |||
| EventBase::EventGeneratorID_t | gid, | |||
| unsigned int | sid, | |||
| EventBase::EventTypeID_t | tid | |||
| ) | [inline] |
constructor, specify delay in milliseconds, if any events matching given parameters are received, the timer will be reset
Definition at line 30 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 - use assignment in your subclass's constructor if you want set egid,esid,etid (don't forget eventargcount!)
Definition at line 68 of file TimeOutTrans.h.
Member Function Documentation
| virtual void TimeOutTrans::DoStart | ( | ) | [inline, virtual] |
starts timer
Reimplemented from BehaviorBase.
Reimplemented in LostTargetTrans.
Definition at line 35 of file TimeOutTrans.h.
Referenced by LostTargetTrans::DoStart().
| virtual void TimeOutTrans::DoStop | ( | ) | [inline, virtual] |
| virtual void TimeOutTrans::processEvent | ( | const EventBase & | e | ) | [inline, virtual] |
if we receive the timer event, fire()
Reimplemented from BehaviorBase.
Reimplemented in LostTargetTrans.
Definition at line 58 of file TimeOutTrans.h.
Referenced by LostTargetTrans::processEvent().
| void TimeOutTrans::resetTimer | ( | ) | [inline] |
resets timer
Reimplemented in LostTargetTrans.
Definition at line 52 of file TimeOutTrans.h.
Referenced by DoStart(), processEvent(), and LostTargetTrans::resetTimer().
Member Data Documentation
unsigned int TimeOutTrans::d [protected] |
amount to delay (in milliseconds) before transition
Definition at line 73 of file TimeOutTrans.h.
Referenced by resetTimer().
EventBase::EventGeneratorID_t TimeOutTrans::egid [protected] |
the event generator to listen for
Definition at line 78 of file TimeOutTrans.h.
Referenced by DoStart().
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 76 of file TimeOutTrans.h.
Referenced by DoStart().
The documentation for this class was generated from the following file:
