Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Target.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 __TARGET_H__
45 #define __TARGET_H__
46 
47 #include "CoreConfig.h"
48 #include "Element.h"
49 #include <map>
50 #include <string>
51 
52 namespace Menge {
53 
54  // forward declarations
55  namespace Agents {
56  class BaseAgent;
57  }
58 
59  namespace BFSM {
60  // forward declarations
61  class State;
62  class Goal;
63 
77  class MENGE_API TransitionTarget : public Element {
78  public:
83 
89  TransitionTarget( const TransitionTarget & tgt );
90 
91  protected:
95  virtual ~TransitionTarget();
96 
97  public:
107  virtual void onEnter( Agents::BaseAgent * agent ){}
108 
114  virtual void onLeave( Agents::BaseAgent * agent ){}
115 
127  virtual State * nextState( Agents::BaseAgent * agent ) = 0;
128 
138  virtual bool connectStates( std::map< std::string, State * > & stateMap ) = 0;
139 
148  virtual TransitionTarget * copy() = 0;
149  };
150 
152 
159  class MENGE_API SingleTarget : public TransitionTarget {
160  public:
164  SingleTarget();
165 
171  SingleTarget( const SingleTarget & tgt );
172 
178  SingleTarget( const std::string & toName );
179 
180  // TOOD: Change the goalPoint into a Goal instance
192  virtual State * nextState( Agents::BaseAgent * agent ) { return _next; }
193 
203  virtual bool connectStates( std::map< std::string, State * > & stateMap );
204 
213  virtual TransitionTarget * copy();
214 
215 
216  protected:
220  std::string _nextName;
221 
226  };
227 
228  } // namespace BFSM
229 } // namespace Menge
230 #endif // __TARGET_H__
The base class for transition targets.
Definition: Target.h:77
The basic state of the behavior finite state machine.
Definition: State.h:123
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Sets up the proper compiler directives for platform and dll export/import.
virtual State * nextState(Agents::BaseAgent *agent)
Determines the next state for the given agent.
Definition: Target.h:192
A TransitionTarget which assumes there is only one destination state.
Definition: Target.h:159
std::string _nextName
The name of the state to which this transition leads.
Definition: Target.h:220
State * _next
a pointer to the state to which this transition leads.
Definition: Target.h:225
Base class for all Menge elements.
The basic interface of extendible Menge Elements.
Definition: Element.h:67
virtual void onEnter(Agents::BaseAgent *agent)
Called when an agent enters a state with this exiting transition.
Definition: Target.h:107
The namespace contains the Behavior Finite State Machine (BFSM) definition.
virtual void onLeave(Agents::BaseAgent *agent)
Called when an agent exits the state with this transition.
Definition: Target.h:114
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
The namespace that contains the basic simulation mechanisms.