Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AgentPropertyManipulator.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 __AGENT_PROPERTY_MANIPULATOR_H__
46 #define __AGENT_PROPERTY_MANIPULATOR_H__
47 
48 #include "Element.h"
49 #include "mengeCommon.h"
50 #include "FSMEnumeration.h"
51 #include <map>
52 #include "SimpleLock.h"
53 
54 
55 namespace Menge {
56  // Forward declarations
57  namespace Agents {
58  class BaseAgent;
59  }
60 
61 
73  MENGE_API BFSM::PropertyOperand parsePropertyName( const std::string & opName );
74 
76 
83  class MENGE_API AgentPropertyManipulator : public Element {
84  public:
89 
90  protected:
94  virtual ~AgentPropertyManipulator();
95 
96  public:
103  void manipulate( Agents::BaseAgent * agent );
104 
113  void restore( Agents::BaseAgent * agent );
114 
123  void setGenerator( FloatGenerator * gen );
124 
130  void setProperty( BFSM::PropertyOperand prop ) { _property = prop; }
131 
132  protected:
140  virtual float newValue( float value, size_t agentID ) = 0;
141 
146 
150  BFSM::PropertyOperand _property;
151 
156  std::map< size_t, float > _originalMap;
157 
162  };
163 
165 
171  protected:
179  virtual float newValue( float value, size_t agentID );
180  };
181 
183 
190  protected:
198  virtual float newValue( float value, size_t agentID );
199  };
200 
202 
209  protected:
217  virtual float newValue( float value, size_t agentID );
218  };
219 
220 } // namespace Menge
221 #endif // __AGENT_PROPERTY_MANIPULATOR_H__
The definition of a simple thrading lock.
BFSM::PropertyOperand parsePropertyName(const std::string &opName)
Helper function for parsing property actions.
Definition: AgentPropertyManipulator.cpp:59
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Generic abstract class which generates a scalar float value.
Definition: RandGenerator.h:99
BFSM::PropertyOperand _property
The property to operate on.
Definition: AgentPropertyManipulator.h:150
void setProperty(BFSM::PropertyOperand prop)
Sets the property operand.
Definition: AgentPropertyManipulator.h:130
Modifies a particular agent property based by adding the value from a distribution to the original ag...
Definition: AgentPropertyManipulator.h:189
The definition of a simple mutex-style lock.
Definition: SimpleLock.h:62
Base class for all Menge elements.
The basic interface of extendible Menge Elements.
Definition: Element.h:67
SimpleLock _lock
Lock for guaranteeing thread-safety.
Definition: AgentPropertyManipulator.h:161
Modifies a particular agent property based by explicitly setting the property value from a distributi...
Definition: AgentPropertyManipulator.h:170
FloatGenerator * _operandGen
The generator for determining the operand value.
Definition: AgentPropertyManipulator.h:145
Modifies a particular agent property based by multiplying the value from a distribution to the origin...
Definition: AgentPropertyManipulator.h:208
Base class for manipulating agent properties in an undoable manner. The undo is limited, it only maintains knowledge of one manipulation. If multiple manipulations are applied, only the last can be undone.
Definition: AgentPropertyManipulator.h:83
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
Enumerated types for the State class.
std::map< size_t, float > _originalMap
A mapping from agent id to the agent's property value before the action was applied.
Definition: AgentPropertyManipulator.h:156
The namespace that contains the basic simulation mechanisms.