Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/new_class_id/src/lib/util/loading/factory.h @ 9757

Last change on this file since 9757 was 9757, checked in by bensch, 18 years ago

new_class_id: hups… this was bad naming… confusing too.

File size: 2.6 KB
Line 
1/*
2   orxonox - the future of 3D-vertical-scrollers
3
4   Copyright (C) 2004 orx
5
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 2, or (at your option)
9   any later version.
10
11   ### File Specific:
12   main-programmer: Christian Meyer
13   co-programmer: Benjamin Grauer
14*/
15
16/*!
17 * @file factory.h
18 * @brief A loadable object handler
19*/
20
21
22#ifndef __FACTORY_H
23#define __FACTORY_H
24
25class BaseObject;
26
27#include "parser/tinyxml/tinyxml.h"
28#include "base_object.h"
29#include <list>
30
31/**
32 * Creates a factory to a Loadable Class.
33 * this should be used at the beginning of all the Classes that should be loadable (in the cc-file)
34 */
35#define CREATE_FACTORY(CLASS_NAME) \
36    tFactory<CLASS_NAME>* global_##CLASS_NAME##_Factory = new tFactory<CLASS_NAME>(CLASS_NAME::staticClassID())
37
38//! The Factory is a loadable object handler
39class Factory : public BaseObject
40{
41  ObjectListDeclaration(Factory);
42public:
43  virtual ~Factory ();
44
45  static void deleteFactories();
46
47  static  BaseObject* fabricate(const std::string& className);
48  static  BaseObject* fabricate(const ClassID& classID);
49  static  BaseObject* fabricate(const TiXmlElement* root);
50
51
52  bool operator==(int classID) const;
53  bool operator==(const std::string& className) const;
54  bool operator==(const ClassID& classID) const { return _classID == classID; };
55
56protected:
57  Factory (const ClassID& id);
58  virtual BaseObject* fabricateObject(const TiXmlElement* root = NULL) const = 0;
59
60private:
61  Factory (const Factory&) {};
62
63protected:
64  const ClassID              _classID;              //!< The Class-Identifyer of the Factory.
65  static std::list<Factory*>*   _factoryList;          //!< List of Registered Factories
66};
67
68/**
69 *  @brief a factory that is able to load any kind of Object
70 * (this is a Functor)
71 */
72template<class T> class tFactory : public Factory
73{
74public:
75  /**
76   * @brief creates a new type Factory to enable the loading of T
77   * @param factoryName the Name of the Factory to load.
78   * @param classID the ID of the Class to be created.
79   */
80  tFactory (const ClassID& classID)
81      : Factory(classID)
82  {  }
83
84private:
85  tFactory (const tFactory&) {};
86  /**
87   * @brief fabricates an Object of type T, with the constructor T::T(const TiXmlElemnt*)
88   * @param root the TiXmlElement T should load parameters from.
89   * @return the newly fabricated T.
90   */
91  virtual BaseObject* fabricateObject(const TiXmlElement* root = NULL) const
92  {
93    return new T(root);
94  }
95};
96
97#endif /* _FACTORY_H */
98
Note: See TracBrowser for help on using the repository browser.