Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Action.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 
50 #ifndef __ACTION_H__
51 #define __ACTION_H__
52 
53 #include "CoreConfig.h"
54 #include "fsmCommon.h"
55 #include "FSMEnumeration.h"
56 #include "Element.h"
57 
58 // forward declaration
59 class TiXmlElement;
60 
61 namespace Menge {
62 
67  namespace BFSM {
68 
69  // forward declaration
70  class ActionFactory;
71 
78  class MENGE_API Action : public Element {
79  public:
83  Action(): Element(), _undoOnExit(true){}
84 
85  protected:
89  virtual ~Action(){}
90 
91  public:
101  virtual void onEnter( Agents::BaseAgent * agent ) = 0;
102 
108  void onLeave( Agents::BaseAgent * agent );
109 
110  friend class ActionFactory;
111 
112  protected:
122  virtual void leaveAction( Agents::BaseAgent * agent ) = 0;
123 
128  };
129 
138  Action * parseAction( TiXmlElement * node, const std::string & behaveFldr );
139  } // namespace BFSM
140 } // namespace Menge
141 #endif // __ACTION_H__
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.
bool _undoOnExit
Determines if the action undoes itself on exiting the state.
Definition: Action.h:127
Base class for all Menge elements.
Action()
Constructor.
Definition: Action.h:83
The basic interface of extendible Menge Elements.
Definition: Element.h:67
virtual ~Action()
Virtual destructor.
Definition: Action.h:89
The namespace contains the Behavior Finite State Machine (BFSM) definition.
The abstract definition of an action.
Definition: Action.h:78
Collection of convenient pre-compiler information for fsm definitions.
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
Enumerated types for the State class.
A class for parsing the xml description of an action and instantiating particular instances...
Definition: ActionFactory.h:62