Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SimulatorDB.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 
48 #ifndef __SIMULATOR_DB_H__
49 #define __SIMULATOR_DB_H__
50 
51 #include "SimulatorDBEntry.h"
52 #include "CoreConfig.h"
53 #include "MengeException.h"
54 #include <list>
55 #include <algorithm>
56 #include <iostream>
57 #ifndef _WIN32
58 #include <typeinfo>
59 #endif
60 
61 namespace Menge {
62 
64 
68  class MENGE_API SimDBException : public virtual MengeException {
69  public:
74 
80  SimDBException( const std::string & s ): MengeException(s) {}
81  };
82 
86  class MENGE_API SimDBFatalException : public SimDBException, public MengeFatalException {
87  public:
92 
99  };
100 
102 
106  typedef std::list< SimulatorDBEntry * > EntryList;
107 
109 
117  class MENGE_API SimulatorDB {
118  public:
122  SimulatorDB();
123 
128 
134  inline size_t modelCount() const { return _entries.size(); }
135 
144  ::std::string paramList() const;
145 
153  ::std::string briefDescriptions() const;
154 
162  ::std::string longDescriptions() const;
163 
174  SimulatorDBEntry * getDBEntry( const std::string & modelName );
175 
186  SimulatorDBEntry * registerEntry( SimulatorDBEntry * entry );
187 
188  private:
195  EntryList _entries;
196  };
197 } // namespace Menge
198 #endif // __SIMULATOR_DB_H__
The fatal SimulatorDB exception.
Definition: SimulatorDB.h:86
SimDBFatalException(const std::string &s)
Constructor with message.
Definition: SimulatorDB.h:98
SimDBFatalException()
Default constructor.
Definition: SimulatorDB.h:91
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Sets up the proper compiler directives for platform and dll export/import.
std::list< SimulatorDBEntry * > EntryList
A list of database entries.
Definition: SimulatorDB.h:106
An entry in the simulator database.
Definition: SimulatorDBEntry.h:95
SimDBException(const std::string &s)
Constructor with message.
Definition: SimulatorDB.h:80
~SimulatorDB()
Destructor.
Definition: SimulatorDB.h:127
The base definition for exceptions in Menge.
Exception for SimulatorDB issues.
Definition: SimulatorDB.h:68
size_t modelCount() const
Reports the number of registered pedestrian models.
Definition: SimulatorDB.h:134
The simulator database class.
Definition: SimulatorDB.h:117
Base exception class for menge operations.
Definition: MengeException.h:58
SimDBException()
Default constructor.
Definition: SimulatorDB.h:73
Definition of an entry into the simulator database.
Base class for fatal exceptions.
Definition: MengeException.h:99