Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AttributeSet.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 __ATTRIBUTE_SET_H__
45 #define __ATTRIBUTE_SET_H__
46 
47 #include <vector>
48 #include "CoreConfig.h"
49 #include "Math/Vector2.h"
50 
51 // forward declaration
52 class TiXmlElement;
53 
54 namespace Menge {
55 
56  class Attribute;
57  namespace Math {
58  class FloatGenerator;
59  class IntGenerator;
60  class Vec2DGenerator;
61  }
62  using namespace Math;
88  class MENGE_API AttributeSet {
89  public:
93  AttributeSet();
94 
98  ~AttributeSet();
99 
111  size_t addBoolAttribute( const std::string & name, bool required, bool defValue=false );
112 
124  size_t addIntAttribute( const std::string & name, bool required, int defValue=0 );
125 
137  size_t addSizeTAttribute( const std::string & name, bool required, size_t defValue=0 );
138 
150  size_t addFloatAttribute( const std::string & name, bool required, float defValue=0 );
151 
164  size_t addFloatDistAttribute( const std::string & prefix, bool required, float defValue, float scale );
165 
177  size_t addVec2DDistAttribute( bool required, const Vector2 & defValue, float scale=1.f );
178 
190  size_t addIntDistAttribute( const std::string & prefix, bool required, int defValue=0 );
191 
203  size_t addStringAttribute( const std::string & name, bool required, const std::string & defValue="" );
204 
208  void clear();
209 
216  bool extract( TiXmlElement * node );
217 
229  int getInt( size_t propID );
230 
242  size_t getSizeT( size_t propID );
243 
255  bool getBool( size_t propID );
256 
268  float getFloat( size_t propID );
269 
281  std::string getString( size_t propID );
282 
295  FloatGenerator * getFloatGenerator( size_t propID );
296 
309  Vec2DGenerator * getVec2DGenerator( size_t propID );
310 
323  IntGenerator * getIntGenerator( size_t propID );
324 
325  protected:
329  bool isUniqueName( const std::string & name );
330 
334  std::vector< Attribute * > _attrs;
335  };
336 } // namespace Menge
337 #endif // __ATTRIBUTE_SET_H__
A set of attributes.
Definition: AttributeSet.h:88
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
Sets up the proper compiler directives for platform and dll export/import.
std::vector< Attribute * > _attrs
The attributes in the set.
Definition: AttributeSet.h:334
Generic abstract class which generates a 2D vector float values.
Definition: RandGenerator.h:706
The namespace for math primitives for simulation and visualization.
Definition of a vector in R2.
Generic abstract class which generates a scalar integer value.
Definition: RandGenerator.h:486