Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ListObstacleSet.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 __LIST_OBSTACLE_SET_H__
45 #define __LIST_OBSTACLE_SET_H__
46 
47 #include "mengeCommon.h"
51 #include "Obstacle.h"
52 #include <vector>
53 
54 namespace Menge {
55 
56  namespace Agents {
57 
62  class MENGE_API ListObstacleSet : public ObstacleSet {
63  public:
68 
69  protected:
73  ~ListObstacleSet();
74 
75  public:
81  virtual size_t obstacleCount() { return _obstacles.size(); }
82 
90  virtual Obstacle * getObstacle( size_t i );
91 
99  bool addObstacle(Obstacle * o);
100 
108  bool addObstacle(ObstacleVertexList o);
109 
110  friend class ExplicitObstacleSetFactory;
111 
112  protected:
116  std::vector< Obstacle *> _obstacles;
117  };
118 
119 
120  } // namespace Agents
121 } // namespace Menge
122 #endif // __EXPLICIT_OBSTACLE_SET_H__
The base class for obstacle set definitions.
Definition: ObstacleSet.h:101
Factory for ExplicitGenerator.
Definition: ExplicitObstacleSet.h:77
Definition of obstacle set class which produces obstacles based on explicit definition in an XML file...
Definition: ListObstacleSet.h:62
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Contains the Obstacle class.
virtual size_t obstacleCount()
Reports the number of obstacles in the set.
Definition: ListObstacleSet.h:81
The definition of the set of vertices for an explicit obstacle definition.
A strcuture for passing vertices and closed tags for obstacles.
Definition: ObstacleVertexList.h:60
std::vector< Obstacle * > _obstacles
The obstacles in an internal list.
Definition: ListObstacleSet.h:116
Defines static obstacles in the simulation.
Definition: Obstacle.h:56
The definition of the ObstacleSet element Defines the numbers and positions of obstacles in a set...
The factory for parsing xml data and instantiating ObstacleSet implementations.
The namespace that contains the basic simulation mechanisms.