Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
System.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 
39 // A system drives attributes of a graph
40 // Before drawing a graph, systems get evaluated to make sure what's being drawn
41 // is "correct" and "updated".
42 // Systems are relatively lazy. Their update can be called, but only if the system KNOWS it needs
43 // to be updated, will it update.
44 
50 #ifndef __SYSTEM_H__
51 #define __SYSTEM_H__
52 
53 #include "CoreConfig.h"
54 #include "MengeException.h"
55 #include <list>
56 #include <string>
57 
58 namespace Menge {
59 
60  namespace SceneGraph {
61 
69  class MENGE_API SystemStopException : public Menge::MengeException {
70  public:
75  };
76 
83  class MENGE_API System {
84  public:
88  System() {}
89 
93  virtual ~System() {}
94 
102  virtual void finish(){}
103 
110  virtual bool updateScene( float time ) = 0;
111  };
112 
116  typedef std::list< System * > SystemList;
117 
121  typedef SystemList::iterator SystemListItr;
122 
126  typedef SystemList::const_iterator SystemListCItr;
127 
128  } // namespace SceneGraph
129 } // namespace Menge
130 #endif // __SYSTEM_H__
An animation system. Responsible for updating the scene based based on increasing time values...
Definition: System.h:83
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.
The base definition for exceptions in Menge.
The SceneGraph (SceneGraph) name space, containing all elements to use in a SceneGraph.
virtual ~System()
Virtual destructor.
Definition: System.h:93
System()
Default constructor.
Definition: System.h:88
Base exception class for menge operations.
Definition: MengeException.h:58
SystemStopException()
Default constructor.
Definition: System.h:74
Exception class for indicating that a system is done.
Definition: System.h:69
virtual void finish()
Finalizing function for the system.
Definition: System.h:102