Changeset 365 for code/branches/objecthierarchy/src/orxonox/core/Factory.h

Timestamp:

Dec 1, 2007, 4:24:56 AM (16 years ago)

Author:

landauf

Message:

added comments

File:

• code/branches/objecthierarchy/src/orxonox/core/Factory.h (modified) (4 diffs)

code/branches/objecthierarchy/src/orxonox/core/Factory.h

@@ +1 @@
+/*!
+    @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 networkID
+    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__
@@ -7 +22 @@
 namespace orxonox
 {
-    class BaseObject;
-    class Identifier;
+    class BaseObject; // Forward declaration
+    class Identifier; // Forward declaration
 
     // ###############################
     // ###         Factory         ###
     // ###############################
+    //! The Factory is used to map name or networkID of a class with its Identifier.
     class Factory
     {
@@ -22 +38 @@
 
         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*> identifierStringMap_;
-            std::map<unsigned int, Identifier*> identifierNetworkIDMap_;
+            static Factory* pointer_s;                                          //!< The pointer to the singleton
+            std::map<std::string, Identifier*> identifierStringMap_;            //!< The map mapping string with Identifier
+            std::map<unsigned int, Identifier*> identifierNetworkIDMap_;        //!< The map mapping networkID with Identifier
     };
 
@@ -34 +50 @@
     // ###       BaseFactory       ###
     // ###############################
+    //! Base-class of ClassFactory. Has to be defined separate because of circular dependencies.
     class BaseFactory
     {