Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ElementFactory.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 
45 #ifndef __ELEMENT_FACTORY_H__
46 #define __ELEMENT_FACTORY_H__
47 
48 #include "AttributeSet.h"
49 
50 // forward declaration
51 class TiXmlElement;
52 
53 namespace Menge {
54 
58  template < class Element >
59  class ElementFactory {
60  public:
65 
76  void destroy() {
77  delete this;
78  }
79 
80  protected:
84  virtual ~ElementFactory(){}
85 
86  public:
87 
96  virtual const char * name() const = 0;
97 
105  virtual const char * description() const = 0;
106 
117  bool thisFactory( const std::string & typeName ) const { return typeName == name(); }
118 
132  Element * createInstance( TiXmlElement * node, const std::string & behaveFldr ) const {
133  Element * element = instance();
134  if ( ! setFromXML( element, node, behaveFldr ) ) {
135  element->destroy();
136  element = 0x0;
137  }
138  return element;
139  }
140 
141  protected:
152  virtual Element * instance() const = 0;
153 
176  virtual bool setFromXML( Element * element, TiXmlElement * node, const std::string & specFldr ) const {
177  _attrSet.clear();
178  return _attrSet.extract( node );
179  }
180 
185  };
186 } // namespace Menge
187 
188 #endif // __ELEMENT_FACTORY_H__
A set of attributes.
Definition: AttributeSet.h:88
virtual Element * instance() const =0
Create an instance of this class's condition.
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
void clear()
Prepares the set to parse a new instance.
Definition: AttributeSet.cpp:177
ElementFactory()
Default constructor.
Definition: ElementFactory.h:64
virtual ~ElementFactory()
Destructor.
Definition: ElementFactory.h:84
void destroy()
This supplants the destructor.
Definition: ElementFactory.h:76
virtual const char * description() const =0
A description of the action.
virtual const char * name() const =0
The name of the action.
The basic interface of extendible Menge Elements.
Definition: Element.h:67
Element * createInstance(TiXmlElement *node, const std::string &behaveFldr) const
Parses the xml data.
Definition: ElementFactory.h:132
virtual bool setFromXML(Element *element, TiXmlElement *node, const std::string &specFldr) const
Given a pointer to an element instance, sets the appropriate fields from the provided XML node...
Definition: ElementFactory.h:176
void destroy()
This supplants the destructor.
Definition: Element.h:83
Defines the set of element attributes.
AttributeSet _attrSet
The attribute set for this factory.
Definition: ElementFactory.h:184
bool extract(TiXmlElement *node)
Parses the node for the given attributes.
Definition: AttributeSet.cpp:185
bool thisFactory(const std::string &typeName) const
Reports if the xml node defines an element for this factory.
Definition: ElementFactory.h:117