Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Transition.h
Go to the documentation of this file.
1 /*
2 
3 License
4 
5 Menge
6 Copyright and trademark 2012-14 University of North Carolina at Chapel Hill.
7 All rights reserved.
8 
9 Permission to use, copy, modify, and distribute this software and its documentation
10 for educational, research, and non-profit purposes, without fee, and without a
11 written agreement is hereby granted, provided that the above copyright notice,
12 this paragraph, and the following four paragraphs appear in all copies.
13 
14 This software program and documentation are copyrighted by the University of North
15 Carolina at Chapel Hill. The software program and documentation are supplied "as is,"
16 without any accompanying services from the University of North Carolina at Chapel
17 Hill or the authors. The University of North Carolina at Chapel Hill and the
18 authors do not warrant that the operation of the program will be uninterrupted
19 or error-free. The end-user understands that the program was developed for research
20 purposes and is advised not to rely exclusively on the program for any reason.
21 
22 IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS
23 BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
24 DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
25 DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE
26 AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
28 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY
29 DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY
31 OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
32 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS
33 TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
34 
35 Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu
36 
37 */
38 
44 #ifndef __TRANSITION_H__
45 #define __TRANSITION_H__
46 
47 #include "fsmCommon.h"
48 #include <map>
49 
50 namespace Menge {
51 
52  namespace BFSM {
53 
54  class State;
55  class Condition;
56  class TransitionTarget;
57  class FSM;
58  class Goal;
59 
67  class Transition {
68  public:
74  Transition( const Transition & trans );
75 
86  Transition( Condition * condition, TransitionTarget * target );
87 
91  ~Transition();
92 
102  bool connectStates( std::map< std::string, State * > & stateMap );
103 
110  virtual void onEnter( Agents::BaseAgent * agent );
111 
117  void onLeave( Agents::BaseAgent * agent );
118 
127  State * test( Agents::BaseAgent * agent, const Goal * goal );
128 
134  void getTasks( FSM * fsm );
135 
141  Transition * copy();
142 
143  protected:
144 
149 
154  };
155 
167  Transition * parseTransition( TiXmlElement * node, const std::string & behaveFldr, std::string & fromName );
168 
169  } // namespace BFSM
170 } // namespace Menge
171 #endif // __TRANSITION_H__
The transition between BFSM states.
Definition: Transition.h:67
The base class for transition targets.
Definition: Target.h:77
The basic state of the behavior finite state machine.
Definition: State.h:123
Transition(const Transition &trans)
Copy constructor.
Definition: Transition.cpp:56
virtual void onEnter(Agents::BaseAgent *agent)
Called when an agent enters a state with this exiting transition.
Definition: Transition.cpp:80
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
State * test(Agents::BaseAgent *agent, const Goal *goal)
Tests to see if this transition's conditions are met.
Definition: Transition.cpp:98
bool connectStates(std::map< std::string, State * > &stateMap)
Performs any necessary connections to the "to" state.
Definition: Transition.cpp:73
Transition * copy()
Creats a deep copy of this transition.
Definition: Transition.cpp:114
The base, abstract class defining goals.
Definition: Goal.h:110
Condition * _condition
The Condition instance for this transition.
Definition: Transition.h:148
void getTasks(FSM *fsm)
Gets the tasks for all of the transitions target and condition.
Definition: Transition.cpp:107
void onLeave(Agents::BaseAgent *agent)
Called when an agent exits the state with this transition.
Definition: Transition.cpp:89
TransitionTarget * _target
The target for this transition.
Definition: Transition.h:153
Templated class for the behavior finite state machine.
Definition: FSM.h:126
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
The base class for transition conditions.
Definition: Condition.h:68
~Transition()
Destructor.
Definition: Transition.cpp:66
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123