Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/util/loading/factory.h @ 6329

Last change on this file since 6329 was 5984, checked in by bensch, 19 years ago

orxonox/trunk: doxygen in Factory

File size: 2.5 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 "debug.h"
30#include <vector>
31
32/**
33 * Creates a factory to a Loadable Class.
34 * this should be used at the beginning of all the Classes that should be loadable (in the cc-file)
35*/
36#define CREATE_FACTORY(CLASS_NAME, CLASS_ID) \
37    tFactory<CLASS_NAME>* global_##CLASS_NAME##_Factory = new tFactory<CLASS_NAME>(#CLASS_NAME, CLASS_ID)
38
39//! The Factory is a loadable object handler
40class Factory : public BaseObject {
41
42 public:
43  Factory (const char* factoryName, ClassID classID);
44  virtual ~Factory ();
45
46  static void deleteFactories();
47
48  static  BaseObject* fabricate(const char* className);
49  static  BaseObject* fabricate(ClassID classID);
50  static  BaseObject* fabricate(const TiXmlElement* root = NULL);
51
52
53  bool operator==(ClassID classID) const;
54  bool operator==(const char* className) const;
55
56  protected:
57    virtual BaseObject* fabricateObject(const TiXmlElement* root = NULL) const = 0;
58
59  protected:
60    ClassID                       classID;              //!< The Class-Identifyer of the Factory.
61    const char*                   className;            //!< The name of the Class.
62    static std::list<Factory*>*   factoryList;          //!< List of Registered Factories
63};
64
65/**
66 *  a factory that is able to load any kind of Object
67 * (this is a Functor)
68 */
69template<class T> class tFactory : public Factory
70{
71 public:
72 /**
73  * creates a new type Factory to enable the loading of T
74  * @param factoryName the Name of the Factory to load.
75  * @param classID the ID of the Class to be created.
76  */
77  tFactory (const char* factoryName, ClassID classID)
78   : Factory(factoryName, classID)
79  {  }
80
81  private:
82   /**
83    * fabricates an Object of type T, with the constructor T::T(const TiXmlElemnt*)
84    * @param root the TiXmlElement T should load parameters from.
85    * @return the newly fabricated T.
86    */
87    virtual BaseObject* fabricateObject(const TiXmlElement* root = NULL) const
88    {
89      return new T(root);
90    }
91};
92
93#endif /* _FACTORY_H */
94
Note: See TracBrowser for help on using the repository browser.