Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ObstacleSet.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 __OBSTACLE_SET_H__
45 #define __OBSTACLE_SET_H__
46 
47 #include "Element.h"
48 #include "MengeException.h"
49 
50 namespace Menge {
51 
52  namespace Agents {
53  // forward declaration
54  class Obstacle;
55  class ObstacleSetFactory;
56 
60  class MENGE_API ObstacleSetException : public virtual MengeException {
61  public:
66 
72  ObstacleSetException( const std::string & s ): MengeException(s) {}
73  };
74 
79  public:
84 
91  };
92 
93 
101  class MENGE_API ObstacleSet : public Element {
102  public:
106  ObstacleSet();
107 
108  friend class ObstacleSetFactory;
109 
110  protected:
115  virtual ~ObstacleSet();
116 
117  public:
118 
124  virtual size_t obstacleCount() = 0;
125 
133  virtual Obstacle * getObstacle( size_t i ) = 0;
134 
140  virtual void setClass( size_t cl) { _class = cl; };
141 
147  virtual size_t getClass() { return _class; };
148 
149  protected:
150 
157  size_t _class;
158  };
159 
160  } // namespace Agents
161 } // namespace Menge
162 #endif // __OBSTACLE_SET_H__
The base class for obstacle set definitions.
Definition: ObstacleSet.h:101
virtual void setClass(size_t cl)
Sets the class of this obstacle set.
Definition: ObstacleSet.h:140
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
The fatal obstacle set exception.
Definition: ObstacleSet.h:78
Exception class for obstacle set instantiation.
Definition: ObstacleSet.h:60
The base definition for exceptions in Menge.
Base class for all Menge elements.
The basic interface of extendible Menge Elements.
Definition: Element.h:67
Base exception class for menge operations.
Definition: MengeException.h:58
A class for parsing the xml description of an agent generator and instantiating particular instances...
Definition: ObstacleSetFactory.h:60
virtual size_t getClass()
Gets the class of this obstacle set.
Definition: ObstacleSet.h:147
ObstacleSetException()
Default constructor.
Definition: ObstacleSet.h:65
Base class for fatal exceptions.
Definition: MengeException.h:99
ObstacleSetFatalException(const std::string &s)
Constructor with message.
Definition: ObstacleSet.h:90
Defines static obstacles in the simulation.
Definition: Obstacle.h:56
The namespace that contains the basic simulation mechanisms.
ObstacleSetFatalException()
Default constructor.
Definition: ObstacleSet.h:83
ObstacleSetException(const std::string &s)
Constructor with message.
Definition: ObstacleSet.h:72