CompletionTrans Class Reference
causes a transition when at least n sources have signalled completion; n = 0 means "all" (default) More...
#include <CompletionTrans.h>
Detailed Description
causes a transition when at least n sources have signalled completion; n = 0 means "all" (default)
Definition at line 10 of file CompletionTrans.h.
Public Member Functions | |
| CompletionTrans (StateNode *destination, int n=0) | |
| constructor, pass destination and the minimum number of sources which must signal completion before this transition will fire | |
| CompletionTrans (const std::string &name, StateNode *destination, int n=0) | |
| constructor, pass name, destination and the minimum number of times the source must signal completion beyond the first (n) | |
| virtual void | postStart () |
| starts listening | |
| virtual void | stop () |
| stops listening | |
| virtual void | doEvent () |
| record completions, and fire the transition if all sources have completed | |
Protected Member Functions | |
Dummy functions to satisfy the compiler | |
| CompletionTrans (const CompletionTrans &) | |
| don't call this | |
| CompletionTrans & | operator= (const CompletionTrans &) |
| don't call this | |
Protected Attributes | |
| int | minsrcs |
| the minimum number of sources which must signal completion before this transition will fire | |
| bool * | completions |
| pointer to array for recording completion events for all sources | |
| EventBase | savedEvent |
| Copy of current event to be used after timer expires. | |
Constructor & Destructor Documentation
| CompletionTrans::CompletionTrans | ( | StateNode * | destination, | |
| int | n = 0 | |||
| ) |
constructor, pass destination and the minimum number of sources which must signal completion before this transition will fire
Definition at line 18 of file CompletionTrans.h.
| CompletionTrans::CompletionTrans | ( | const std::string & | name, | |
| StateNode * | destination, | |||
| int | n = 0 | |||
| ) |
constructor, pass name, destination and the minimum number of times the source must signal completion beyond the first (n)
Definition at line 22 of file CompletionTrans.h.
| CompletionTrans::CompletionTrans | ( | const CompletionTrans & | ) | [protected] |
don't call this
Member Function Documentation
| virtual void CompletionTrans::doEvent | ( | ) | [virtual] |
record completions, and fire the transition if all sources have completed
Reimplemented from BehaviorBase.
Definition at line 45 of file CompletionTrans.h.
| CompletionTrans& CompletionTrans::operator= | ( | const CompletionTrans & | ) | [protected] |
don't call this
| virtual void CompletionTrans::postStart | ( | ) | [virtual] |
| virtual void CompletionTrans::stop | ( | ) | [virtual] |
Member Data Documentation
bool* CompletionTrans::completions [protected] |
pointer to array for recording completion events for all sources
Definition at line 13 of file CompletionTrans.h.
Referenced by doEvent(), postStart(), and stop().
int CompletionTrans::minsrcs [protected] |
the minimum number of sources which must signal completion before this transition will fire
Definition at line 12 of file CompletionTrans.h.
Referenced by doEvent().
EventBase CompletionTrans::savedEvent [protected] |
Copy of current event to be used after timer expires.
Definition at line 14 of file CompletionTrans.h.
Referenced by doEvent().
The documentation for this class was generated from the following file:
