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

Timestamp:

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

Author:

landauf

Message:

added comments

File:

• code/branches/objecthierarchy/src/orxonox/core/IdentifierIncludes.h (modified) (6 diffs)

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

@@ +1 @@
+/**
+    @file IDentifierIncludes.h
+    @brief Definition of macros for the class-hierarchy and the factory.
+
+    Every class needs the RegisterObject(class) macro in its constructor. If the class is an interface
+    or the BaseObject itself, it needs the macro RegisterRootObject(class) instead.
+
+    To allow the object being created through the factory, use the CreateFactory(class) macro outside
+    the of the class implementation, so it gets executed before main().
+*/
+
+// All needed header-files
 #include "Identifier.h"
 #include "Factory.h"
@@ -6 +18 @@
 
 
+// Intern macro, containing the common parts of RegisterObject and RegisterRootObject
 #define InternRegisterObject(ClassName, bRootClass) \
     this->setIdentifier(ClassIdentifier<ClassName>::registerClass(this->getParents(), #ClassName, bRootClass)); \
@@ -12 +25 @@
     ClassIdentifier<ClassName>::addObject(this)
 
+// Intern macro, containing the specific part of RegisterRootObject
 #define InternRegisterRootObject(ClassName) \
     if (Identifier::isCreatingHierarchy() && !this->getParents()) \
@@ -17 +31 @@
     InternRegisterObject(ClassName, true)
 
+// RegisterObject - with and without debug output
 #if HIERARCHY_VERBOSE
 #define RegisterObject(ClassName) \
@@ -26 +41 @@
 #endif
 
+// RegisterRootObject - with and without debug output
 #if HIERARCHY_VERBOSE
 #define RegisterRootObject(ClassName) \
@@ -35 +51 @@
 #endif
 
+// Class(ClassName) returns the Identifier of the given class
 #define Class(ClassName) \
     ClassIdentifier<ClassName>::getIdentifier()
 
+// Creates the entry in the Factory
 #define CreateFactory(ClassName) \
     bool bCreated##ClassName##Factory = ClassFactory<ClassName>::create()
 
-#define ID(NameOrID) \
-    Factory::getIdentifier(NameOrID)
+// ID(StringOrInt) returns the Identifier with either a given name or a given NetworkID through the factory
+#define ID(StringOrInt) \
+    Factory::getIdentifier(StringOrInt)