Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ExplicitObstacleSet.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 __EXPLICIT_OBSTACLE_SET_H__
45 #define __EXPLICIT_OBSTACLE_SET_H__
46 
47 #include "mengeCommon.h"
50 #include "Obstacle.h"
52 #include <vector>
53 
54 namespace Menge {
55 
56  namespace Agents {
57 
58  class ExplicitObstacleSetFactory;
63  class MENGE_API ExplicitObstacleSet : public ListObstacleSet {
64  public:
69 
70  };
71 
73 
78  public:
87  virtual const char * name() const { return "explicit"; }
88 
96  virtual const char * description() const {
97  return "Obstacle definitions given by explicit vertex lists in the XML specification.";
98  };
99 
100  protected:
111  ObstacleSet * instance() const { return new ExplicitObstacleSet(); }
112 
131  virtual bool setFromXML( ObstacleSet * gen, TiXmlElement * node, const std::string & specFldr ) const;
132 
140  ObstacleVertexList parseObstacle( TiXmlElement * node) const;
141  };
142  } // namespace Agents
143 } // namespace Menge
144 #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.
An abstract class for any obstacle set which will need an _obstacles list. Provides transformations f...
Definition of obstacle set class which produces obstacles based on explicit definition in an XML file...
Definition: ExplicitObstacleSet.h:63
The definition of the set of vertices for an explicit obstacle definition.
ObstacleSet * instance() const
Create an instance of this class's obstacleset implementation.
Definition: ExplicitObstacleSet.h:111
A strcuture for passing vertices and closed tags for obstacles.
Definition: ObstacleVertexList.h:60
A class for parsing the xml description of an agent generator and instantiating particular instances...
Definition: ObstacleSetFactory.h:60
virtual const char * description() const
A description of the obstacle set.
Definition: ExplicitObstacleSet.h:96
The factory for parsing xml data and instantiating ObstacleSet implementations.
The namespace that contains the basic simulation mechanisms.
virtual const char * name() const
The name of the obstacleset type.
Definition: ExplicitObstacleSet.h:87