Transition Class Reference
#include <Transition.h>
Inheritance diagram for Transition:
Detailed Description
Represents a transition between StateNodes.This is an abstract class - you'll want to subclass it to put conditions on the transitions. Transitions are "smart" - they are behaviors in and of themselves and can listen for events and use the standard DoStart/DoStop interface. Based on the events they receive, they can fire() themselves and cause a state transition.
DoStart() will be called when this transition is 'active' - it should listen/monitor for the transition it represents until DoStop() is called.
If the conditions are satisified for a transition, you should call fire() to do the appropriate notifications.
Also note that a transition can have multiple sources and destinations. See fire().
When setting up, the flow of additions follows the flow of control. In other words, you add a transition to a source, and you add a destination to a transition. This makes the code simpler because it doesn't have to worry about recursive looping depending whether the source was added to the transition or the transition was added to the source. Confusing? Exactly.
A template file is available at project/templates/transition.h, which will help you get moving faster.
Definition at line 38 of file Transition.h.
Public Member Functions | |
| virtual | ~Transition () |
| destructor | |
| virtual void | fire () |
| call this when the transition should be made, base class version simply calls StateNode::DoStop() on each active of srcs and StateNode::DoStart() on each inactive of dsts, but you can override. | |
| virtual std::vector< StateNode * > & | getSources () |
| returns a user-modifiable reference to the current source list | |
| virtual const std::vector< StateNode * > & | getSources () const |
| returns a const reference to the current source list | |
| virtual void | addDestination (StateNode *destination) |
| if destination is non-null, add it to the destination list | |
| virtual std::vector< StateNode * > & | getDestinations () |
| returns a user-modifiable reference to the current destination list | |
| virtual const std::vector< StateNode * > & | getDestinations () const |
| returns a const reference to the current destination list | |
| virtual void | setSound (const std::string &snd) |
| set a sound file to be played upon activation; you might want to preload this in the parent node; empty string to turn off | |
| virtual std::string | getSound () |
| returns the current sound file | |
| virtual std::string | getName () const |
| If instanceName == className, will autogenerate a name incorporating source and destination names. | |
Protected Member Functions | |
| Transition (const std::string &classname) | |
| constructor, pass your subclass type name as a string for the default name | |
| Transition (const std::string &classname, StateNode *destination) | |
| constructor, specify destination StateNode (ignores NULL) | |
| Transition (const std::string &classname, const std::string &instancename) | |
| constructor, pass your subclass type name as a string for the default name, and a separate instance name | |
| Transition (const std::string &classname, const std::string &instancename, StateNode *destination) | |
| constructor, specify names and destination StateNode (ignores NULL) | |
| Transition (const Transition &t) | |
| copy constructor, just in case you need it | |
| Transition & | operator= (const Transition &t) |
| assignment operator (only does shallow copy) | |
| virtual void | addSource (StateNode *source) |
| if source is non-null, add it to the source list | |
Protected Attributes | |
| std::vector< StateNode * > | srcs |
| the node being transitioned from | |
| std::vector< StateNode * > | dsts |
| the node being transitioned to | |
| std::string | sound |
| sound to play on transitioning | |
Friends | |
| class | StateNode |
Constructor & Destructor Documentation
| virtual Transition::~Transition | ( | ) | [inline, virtual] |
| Transition::Transition | ( | const std::string & | classname | ) | [inline, explicit, protected] |
constructor, pass your subclass type name as a string for the default name
Definition at line 62 of file Transition.h.
| Transition::Transition | ( | const std::string & | classname, | |
| StateNode * | destination | |||
| ) | [inline, protected] |
constructor, specify destination StateNode (ignores NULL)
Definition at line 64 of file Transition.h.
| Transition::Transition | ( | const std::string & | classname, | |
| const std::string & | instancename | |||
| ) | [inline, protected] |
constructor, pass your subclass type name as a string for the default name, and a separate instance name
Definition at line 68 of file Transition.h.
| Transition::Transition | ( | const std::string & | classname, | |
| const std::string & | instancename, | |||
| StateNode * | destination | |||
| ) | [inline, protected] |
constructor, specify names and destination StateNode (ignores NULL)
Definition at line 70 of file Transition.h.
| Transition::Transition | ( | const Transition & | t | ) | [inline, protected] |
Member Function Documentation
| virtual void Transition::addDestination | ( | StateNode * | destination | ) | [inline, virtual] |
if destination is non-null, add it to the destination list
Reimplemented in RandomTrans.
Definition at line 50 of file Transition.h.
Referenced by RandomTrans::addDestination(), and Transition().
| virtual void Transition::addSource | ( | StateNode * | source | ) | [inline, protected, virtual] |
if source is non-null, add it to the source list
Only StateNodes should be calling this - you add a transition to a source, not a source to a transition.
- See also:
- StateNode::addTransition()
Definition at line 82 of file Transition.h.
| void Transition::fire | ( | ) | [virtual] |
call this when the transition should be made, base class version simply calls StateNode::DoStop() on each active of srcs and StateNode::DoStart() on each inactive of dsts, but you can override.
Reimplemented in RandomTrans.
Definition at line 7 of file Transition.cc.
Referenced by VisualTargetTrans::processEvent(), VisualTargetCloseTrans::processEvent(), TimeOutTrans::processEvent(), TextMsgTrans::processEvent(), SignalTrans< T >::processEvent(), NullTrans::processEvent(), EventTrans::processEvent(), ConnectionMadeTrans::processEvent(), CompletionTrans::processEvent(), and CompareTrans< T >::processEvent().
| virtual const std::vector<StateNode*>& Transition::getDestinations | ( | ) | const [inline, virtual] |
returns a const reference to the current destination list
Definition at line 52 of file Transition.h.
| virtual std::vector<StateNode*>& Transition::getDestinations | ( | ) | [inline, virtual] |
returns a user-modifiable reference to the current destination list
Definition at line 51 of file Transition.h.
| std::string Transition::getName | ( | ) | const [virtual] |
If instanceName == className, will autogenerate a name incorporating source and destination names.
Reimplemented from BehaviorBase.
Definition at line 28 of file Transition.cc.
Referenced by fire(), and RandomTrans::fire().
| virtual std::string Transition::getSound | ( | ) | [inline, virtual] |
| virtual const std::vector<StateNode*>& Transition::getSources | ( | ) | const [inline, virtual] |
| virtual std::vector<StateNode*>& Transition::getSources | ( | ) | [inline, virtual] |
returns a user-modifiable reference to the current source list
Definition at line 47 of file Transition.h.
Referenced by CompletionTrans::DoStart(), and CompletionTrans::processEvent().
| Transition& Transition::operator= | ( | const Transition & | t | ) | [inline, protected] |
| virtual void Transition::setSound | ( | const std::string & | snd | ) | [inline, virtual] |
set a sound file to be played upon activation; you might want to preload this in the parent node; empty string to turn off
Definition at line 54 of file Transition.h.
Friends And Related Function Documentation
friend class StateNode [friend] |
Definition at line 39 of file Transition.h.
Member Data Documentation
std::vector<StateNode*> Transition::dsts [protected] |
the node being transitioned to
Definition at line 85 of file Transition.h.
Referenced by addDestination(), fire(), RandomTrans::fire(), getDestinations(), getName(), and operator=().
std::string Transition::sound [protected] |
sound to play on transitioning
Definition at line 86 of file Transition.h.
Referenced by fire(), RandomTrans::fire(), getSound(), operator=(), and setSound().
std::vector<StateNode*> Transition::srcs [protected] |
the node being transitioned from
Definition at line 84 of file Transition.h.
Referenced by addSource(), SignalTrans< T >::DoStart(), fire(), RandomTrans::fire(), getName(), getSources(), and operator=().
The documentation for this class was generated from the following files:
