Changeset 790 for code/trunk/src/orxonox/core/Factory.h

Timestamp:

Feb 7, 2008, 5:01:44 PM (16 years ago)

Author:

nicolasc

Message:

merged FICN back into trunk
awaiting release.

Location:

code/trunk

Files:

• . (modified) (1 prop)
• src/orxonox/core/Factory.h (modified) (3 diffs)

code/trunk/src/orxonox/core/Factory.h

@@ +1 @@
+/*
+ *   ORXONOX - the hottest 3D action shooter ever to exist
+ *
+ *
+ *   License notice:
+ *
+ *   This program is free software; you can redistribute it and/or
+ *   modify it under the terms of the GNU General Public License
+ *   as published by the Free Software Foundation; either version 2
+ *   of the License, or (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program; if not, write to the Free Software
+ *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ *   Author:
+ *      Fabian 'x3n' Landau
+ *   Co-authors:
+ *      ...
+ *
+ */
+
+/*!
+    @file Factory.h
+    @brief Definition of the Factory and the BaseFactory class.
+
+    The Factory is a singleton, containing two maps to map either the name or the network ID
+    of a class with the corresponding Identifier.
+
+    Usage:
+    ID(classname) or ID(networkID) returns the corresponding Identifier.
+
+
+    BaseObject is the parent of ClassFactory which is defined in ClassFactory.h.
+    It can't be defined in ClassFactory.h, because of circular dependencies.
+*/
+
 #ifndef _Factory_H__
 #define _Factory_H__
@@ -5 +47 @@
 #include <string>
 
+#include "CorePrereqs.h"
+
 namespace orxonox
 {
-    class BaseObject;
-    class Identifier;
+    class BaseObject; // Forward declaration
 
     // ###############################
     // ###         Factory         ###
     // ###############################
-    class Factory
+    //! The Factory is used to map the name or the network ID of a class with its Identifier.
+    class _CoreExport Factory
     {
         public:
             static Identifier* getIdentifier(const std::string& name);
+            static Identifier* getIdentifier(const unsigned int id);
             static void add(const std::string& name, Identifier* identifier);
+            static void changeNetworkID(Identifier* identifier, const unsigned int oldID, const unsigned int newID);
+            static void createClassHierarchy();
+
+            static Factory* getFactoryPointer();    // avoid overriding order problem in the static intialisation process
 
         private:
-            Factory() {}
-            Factory(const Factory& factory) {}
-            ~Factory() {}
+            Factory() {}                            // don't create
+            Factory(const Factory& factory) {}      // don't copy
+            ~Factory() {}                           // don't delete
 
-            static Factory* pointer_s;
-            std::map<std::string, Identifier*> identifierMap_;
+            std::map<std::string, Identifier*> identifierStringMap_;            //!< The map, mapping the name with the Identifier
+            std::map<unsigned int, Identifier*> identifierNetworkIDMap_;        //!< The map, mapping the network ID with the Identifier
     };
 
@@ -31 +80 @@
     // ###       BaseFactory       ###
     // ###############################
-    class BaseFactory
+    //! Base-class of ClassFactory. Has to be defined separate because of circular dependencies.
+    class _CoreExport BaseFactory
     {
         public:
             virtual BaseObject* fabricate() = 0;
+            virtual ~BaseFactory() {};
     };
 }
 
-#endif
+#endif /* _Factory_H__ */