Homepage Demos Overview Downloads Tutorials Reference
Credits

CompletionTrans Class Reference

#include <CompletionTrans.h>

Inheritance diagram for CompletionTrans:

Inheritance graph
[legend]
List of all members.

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 DoStart ()
 starts listening
virtual void DoStop ()
 stops listening
virtual void processEvent (const EventBase &event)
 record completions, and fire the transition if all sources have completed

Protected Member Functions

 CompletionTrans (const std::string &classname, const std::string &instancename, StateNode *destination, int n=0)
 constructor, this version is only need by subclasses so they can pass their type name
Dummy functions to satisfy the compiler
 CompletionTrans (const CompletionTrans &)
 don't call this
CompletionTransoperator= (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


Constructor & Destructor Documentation

CompletionTrans::CompletionTrans StateNode destination,
int  n = 0
[inline]
 

constructor, pass destination and the minimum number of sources which must signal completion before this transition will fire

Definition at line 17 of file CompletionTrans.h.

CompletionTrans::CompletionTrans const std::string &  name,
StateNode destination,
int  n = 0
[inline]
 

constructor, pass name, destination and the minimum number of times the source must signal completion beyond the first (n)

Definition at line 21 of file CompletionTrans.h.

CompletionTrans::CompletionTrans const std::string &  classname,
const std::string &  instancename,
StateNode destination,
int  n = 0
[inline, protected]
 

constructor, this version is only need by subclasses so they can pass their type name

Definition at line 60 of file CompletionTrans.h.

CompletionTrans::CompletionTrans const CompletionTrans  )  [protected]
 

don't call this


Member Function Documentation

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

starts listening

Reimplemented from BehaviorBase.

Definition at line 25 of file CompletionTrans.h.

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

stops listening

Reimplemented from BehaviorBase.

Definition at line 39 of file CompletionTrans.h.

CompletionTrans& CompletionTrans::operator= const CompletionTrans  )  [protected]
 

don't call this

virtual void CompletionTrans::processEvent const EventBase event  )  [inline, virtual]
 

record completions, and fire the transition if all sources have completed

Reimplemented from BehaviorBase.

Definition at line 47 of file CompletionTrans.h.


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 CompletionTrans(), DoStart(), DoStop(), and processEvent().

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 CompletionTrans(), and processEvent().


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

Tekkotsu v2.2.2
Generated Tue Jan 4 15:45:22 2005 by Doxygen 1.4.0