TimeOutTrans Class Reference#include <TimeOutTrans.h>
Inheritance diagram for TimeOutTrans:
[legend]List of all members.
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 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] |
|
|
constructor, specify delay in milliseconds
Definition at line 15 of file TimeOutTrans.h. |
|
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. |
|
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. |
|
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] |
|
Member Function Documentation
virtual void TimeOutTrans::DoStart |
( |
|
) |
[inline, virtual] |
|
virtual void TimeOutTrans::DoStop |
( |
|
) |
[inline, virtual] |
|
virtual void TimeOutTrans::processEvent |
( |
const EventBase & |
e |
) |
[inline, virtual] |
|
void TimeOutTrans::resetTimer |
( |
|
) |
[inline] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
|