Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Event.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 __EVENT_H__
45 #define __EVENT_H__
46 
47 #include <string>
48 #include <vector>
49 
50 // forward declaration
51 class TiXmlElement;
52 
53 namespace Menge {
54  // forward declaration
55  class EventTrigger;
56  class EventResponse;
57  class Event;
58  class EventSystem;
59 
61 
75  Event * parseEvent( TiXmlElement * node, const std::string & specFldr );
76 
78 
87  class Event {
88  public:
94  Event( const std::string & name );
95 
99  ~Event();
100 
108  void finalize();
109 
113  void evaluate();
114 
115  friend Event * parseEvent( TiXmlElement * node, const std::string & specFldr );
116  friend class EventSystem;
117  protected:
121  std::string _name;
122 
127 
131  std::vector< EventResponse * > _responses;
132  };
133 } // namespace Menge
134 
135 #endif // __EVENT_H__
~Event()
Destructor.
Definition: Event.cpp:62
EventTrigger * _trigger
The trigger for the event.
Definition: Event.h:126
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
void evaluate()
Evaluates the event (and triggers handlers as necessary).
Definition: Event.cpp:121
The definition of a Menge event.
Definition: Event.h:87
friend Event * parseEvent(TiXmlElement *node, const std::string &specFldr)
Parses the xml specification of an event and returns a parsed event.
Definition: Event.cpp:134
Event(const std::string &name)
Constructor.
Definition: Event.cpp:57
std::vector< EventResponse * > _responses
The effects registered to this event.
Definition: Event.h:131
std::string _name
The name of the event.
Definition: Event.h:121
Event * parseEvent(TiXmlElement *node, const std::string &specFldr)
Parses the xml specification of an event and returns a parsed event.
Definition: Event.cpp:134
The main event engine – causes event triggers to be evaluated and effects to be applied.
Definition: EventSystem.h:66
The base class for event triggers.
Definition: EventTrigger.h:57
void finalize()
Allows the event to finish initializing itself from its parsed state to its running state...
Definition: Event.cpp:71