Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VelModifier.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 
43 #ifndef __VEL_MODIFIER_H__
44 #define __VEL_MODIFIER_H__
45 
46 #include "fsmCommon.h"
47 #include "Element.h"
48 #include "PrefVelocity.h"
49 #include "MengeException.h"
50 
51 // STL
52 #include <vector>
53 
54 namespace Menge {
55 
56  // forward declaration
57  template < class Element >
58  class ElementFactory;
59 
60  namespace BFSM {
61 
62  // FORWARD DECLARATIONS
63  class VelModContext;
64 
68  class MENGE_API VelModException : public virtual MengeException {
69  public:
74 
80  VelModException( const std::string & s ): MengeException(s) {}
81 
82  };
83 
89  public:
94 
101  };
102 
110  class MENGE_API VelModifier : public Element {
111  public:
116 
117  protected:
121  virtual ~VelModifier(){}
122 
123  public:
124 
135  virtual void adaptPrefVelocity( const Agents::BaseAgent * agent, Agents::PrefVelocity & pVel ) = 0;
136 
146  virtual void registerAgent(const Agents::BaseAgent * agent) {}
147 
156  virtual void unregisterAgent(const Agents::BaseAgent * agent) {}
157 
167  void onEnter(const Agents::BaseAgent * agent);
168 
177  void onLeave(const Agents::BaseAgent * agent);
178 
184  virtual VelModifier* copy() const = 0;
185 
193  virtual VelModContext * getContext();
194 
195  friend class ElementFactory< VelModifier >;
196  };
197 
207  VelModifier * parseVelModifier( TiXmlElement * node, const std::string & behaveFldr );
208 
209  } // namespace BFSM
210 } // namespace Menge
211 
212 #endif // __VEL_MODIFIER_H__
VelModFatalException(const std::string &s)
Constructor with message.
Definition: VelModifier.h:100
Exception thrown when the velocity modifier has an error which cannot be recovered from...
Definition: VelModifier.h:88
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
virtual void unregisterAgent(const Agents::BaseAgent *agent)
Unregisters a registed agent.
Definition: VelModifier.h:156
virtual void registerAgent(const Agents::BaseAgent *agent)
Registers an agent for use with the VelModifier.
Definition: VelModifier.h:146
The definition of a preferred velocity.
The base definition for exceptions in Menge.
Base class for all Menge elements.
Base exception class for preferred velocity modification.
Definition: VelModifier.h:68
The basic interface of extendible Menge Elements.
Definition: Element.h:67
The templated base class for a plugin element.
Definition: VelComponent.h:58
VelModException()
Default constructor.
Definition: VelModifier.h:73
Base exception class for menge operations.
Definition: MengeException.h:58
VelModifier()
Default constructor.
Definition: VelModifier.h:115
Base class for fatal exceptions.
Definition: MengeException.h:99
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
The definition of a preferred velocity.
Definition: PrefVelocity.h:68
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
The base class for modifying preferred velocities.
Definition: VelModifier.h:110
virtual ~VelModifier()
Virtual destructor.
Definition: VelModifier.h:121
Base context for finite state machine velocity modifiers.
Definition: VelModifierContext.h:69
VelModFatalException()
Default constructor.
Definition: VelModifier.h:93
VelModException(const std::string &s)
Constructor with message.
Definition: VelModifier.h:80