Menge Plugin Examples
A Collection of Example Plugins for the Menge Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
HelbingSimulator.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 
39 #ifndef __HELBING_SIMULATOR_H__
40 #define __HELBING_SIMULATOR_H__
41 
48 #include "mengeCommon.h"
49 #include "SimulatorBase.h"
50 #include "HelbingAgent.h"
51 
52 using namespace Menge;
53 
60 namespace Helbing {
64  class Simulator : public Agents::SimulatorBase< Agent > {
65  public:
69  Simulator(): Agents::SimulatorBase< Agent >() {}
70 
77  virtual bool hasExpTarget() { return true; }
78 
86  virtual bool isExpTarget( const std::string & tagName ) { return tagName == "Helbing"; }
87 
95  virtual bool setExpParam( const std::string & paramName, const std::string & value ) throw( Agents::XMLParamException );
96 
97  protected:
98  friend class Agent;
102  static float AGENT_SCALE;
103 
107  static float OBST_SCALE;
108 
112  static float REACTION_TIME;
113 
117  static float BODY_FORCE;
118 
122  static float FRICTION;
123 
127  static float FORCE_DISTANCE;
128  };
129 } // namespace Helbing
130 #endif // __HELBING_SIMULATOR_H__
static float AGENT_SCALE
The magnitude of the inter-agent repulsion forces.
Definition: HelbingSimulator.h:102
Simulator()
Constructor.
Definition: HelbingSimulator.h:69
virtual bool hasExpTarget()
Reports if there are non-common Experiment parameters that this simulator requires in the XML file...
Definition: HelbingSimulator.h:77
static float REACTION_TIME
The reaction time used to define the driving force.
Definition: HelbingSimulator.h:112
static float FRICTION
The magnitude of the friction force applied when agents collide.
Definition: HelbingSimulator.h:122
The agent specification for the pedestrian model based on the Helbing et al., 2000 paper...
static float BODY_FORCE
The magnitude of the body force applied when agents collide.
Definition: HelbingSimulator.h:117
virtual bool isExpTarget(const std::string &tagName)
Reports if the given Experiment attribute tag name belongs to this simulator.
Definition: HelbingSimulator.h:86
Defines the simulator operating on a Helbing::Agent.
Definition: HelbingSimulator.h:64
The namespace for the Helbing pedestrian model. This is a model based on the model proposed in the He...
Definition: HelbingAgent.cpp:43
static float OBST_SCALE
The magnitude of the agent-obstacle repulsion forces.
Definition: HelbingSimulator.h:107
Agent definition for the Helbing pedestrian model.
Definition: HelbingAgent.h:57
static float FORCE_DISTANCE
The the fall-off distance of repulsive forces.
Definition: HelbingSimulator.h:127