Menge Plugin Examples
A Collection of Example Plugins for the Menge Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
FundamentalDiagramModifier.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 
45 #ifndef __FDMODIFIER_MODIFIER_H__
46 #define __FDMODIFIER_MODIFIER_H__
47 
51 #include "FSMEnumeration.h"
52 #include "SimpleLock.h"
53 #include "mengeCommon.h"
54 
55 using namespace Menge;
56 
63 namespace FDModifier {
64 
65  class FDModifierFactory;
66 
73  class FDMODIFIER_API FDModifier : public BFSM::VelModifier {
74  public:
75 
79  FDModifier();
80 
91  FDModifier( FloatGenerator * buffer, FloatGenerator * factor, float sigmaAgent, float sigmaObstacle );
92 
96  BFSM::VelModifier* copy() const;
97 
104  void adaptPrefVelocity( const Agents::BaseAgent * agent, Agents::PrefVelocity & pVel );
105 
111  void setBuffer( FloatGenerator * buffer) { if ( _bufferGen ) delete _bufferGen; _bufferGen = buffer; }
112 
118  void setFactor( FloatGenerator * factor ) {if ( _factorGen ) delete _factorGen; _factorGen = factor; }
119 
125  void setSigmaAgent( float sigma ) { _sigmaAgent = sigma; }
126 
132  void setSigmaObstacle( float sigma ) { _sigmaObstacle = sigma; }
133 
134  friend class FDModifierFactory;
135 
136  protected:
141  struct FDParam {
145  FDParam() : _strideConst(1.f), _speedConst(1.f) {}
146 
153  FDParam( float factor, float buffer ) {
154  _strideConst = 0.5f * ( 1.f + buffer ) / factor ;
155  _speedConst = 1.f / ( _strideConst * _strideConst );
156  }
157 
163 
168  float _speedConst;
169  };
170 
176 
180  HASH_MAP< size_t, FDParam > _strideParams;
181 
185  FloatGenerator * _bufferGen;
186 
190  FloatGenerator * _factorGen;
191 
195  float _sigmaAgent;
196 
201  };
202 
204 
208  class FDMODIFIER_API FDModifierFactory : public BFSM::VelModFactory {
209  public:
214 
223  virtual const char * name() const { return "fundamental_diagram"; }
224 
232  virtual const char * description() const {
233  return "Adjusts the agent's preferred speed to adhere to the fundamental diagram ";
234  };
235 
236  protected:
247  BFSM::VelModifier * instance() const { return new FDModifier(); }
248 
267  virtual bool setFromXML( BFSM::VelModifier * modifier, TiXmlElement * node, const std::string & behaveFldr ) const;
268 
272  size_t _bufferID;
273 
277  size_t _factorID;
278 
283 
288  };
289 };
290 #endif // __FDMODIFIER_MODIFIER_H__
FDParam()
Default constructor.
Definition: FundamentalDiagramModifier.h:145
HASH_MAP< size_t, FDParam > _strideParams
The per-agent parameters.
Definition: FundamentalDiagramModifier.h:180
void setBuffer(FloatGenerator *buffer)
Sets the stride buffer.
Definition: FundamentalDiagramModifier.h:111
float _speedConst
The second of two derived constants for fundamental diagram compliance. This is a function of the str...
Definition: FundamentalDiagramModifier.h:168
FloatGenerator * _factorGen
The Stride factor value generator.
Definition: FundamentalDiagramModifier.h:190
Configures the shared library aspect of the includes.
The factory for the FDModifier class.
Definition: FundamentalDiagramModifier.h:208
BFSM::VelModifier * instance() const
Create an instance of this class's modifier.
Definition: FundamentalDiagramModifier.h:247
virtual const char * name() const
The name of the modifier.
Definition: FundamentalDiagramModifier.h:223
size_t _factorID
The identifier for the "stride_factor" float attribute.
Definition: FundamentalDiagramModifier.h:277
void setFactor(FloatGenerator *factor)
Sets the stride factor.
Definition: FundamentalDiagramModifier.h:118
float _sigmaObstacle
Sigma for obstacle density estimation.
Definition: FundamentalDiagramModifier.h:200
void setSigmaObstacle(float sigma)
Sets the agent sigma.
Definition: FundamentalDiagramModifier.h:132
FloatGenerator * _bufferGen
The Stride buffer value generator.
Definition: FundamentalDiagramModifier.h:185
SimpleLock _paramLock
The readers-writer lock to preserve thread-safety on _strideParams.
Definition: FundamentalDiagramModifier.h:175
Defines the parameters which define the density-aware behavior.
Definition: FundamentalDiagramModifier.h:141
float _sigmaAgent
Agent sigma for density calculation.
Definition: FundamentalDiagramModifier.h:195
void setSigmaAgent(float sigma)
Sets the agent sigma.
Definition: FundamentalDiagramModifier.h:125
size_t _sigmaAgentID
The identifier for the "sigma_agent" float attribute.
Definition: FundamentalDiagramModifier.h:282
float _strideConst
One of two derived constants for fundamental diagram compliance. This is a function of the stride fac...
Definition: FundamentalDiagramModifier.h:162
size_t _sigmaObstacleID
The identifier for the "sigma_obstacle" float attribute.
Definition: FundamentalDiagramModifier.h:287
FDParam(float factor, float buffer)
Constructor.
Definition: FundamentalDiagramModifier.h:153
The name space for the Fundamental Diagram adherence model.
Definition: FundamentalDiagramModifier.cpp:46
size_t _bufferID
The identifier for the "stride_buffer" float attribute.
Definition: FundamentalDiagramModifier.h:272
virtual const char * description() const
A description of the modifier.
Definition: FundamentalDiagramModifier.h:232