Changes between Version 2 and Version 3 of code/doc/ClassIdentifier

Timestamp:

Feb 24, 2008, 11:58:21 PM (17 years ago)

Author:

landauf

Comment:

—

code/doc/ClassIdentifier

@@ -7 +7 @@
 The constructor of ClassIdentifier is private. Only [wiki:IdentifierDistributor] is allowed to create and distribute new instances. (In fact only '''one''' instance per template-class. This is '''very''' important.)
 
-You can't access the ClassIdentifier of a class directly. Use [wiki:ClassManager]<!ClassName>::getIdentifier() instead.[[br]] The macro Class(classname) (include [wiki:CoreIncludes CoreIncludes.h] to use it) returns the ClassIdentifier of the given class. In fact this is only an abbreviation of ClassManager<!ClassName>::getIdentifier().
+You can't access the ClassIdentifier of a class directly. Use [wiki:ClassManager]<!ClassName>::getIdentifier() instead. A shorter version of this command is the macro Class(classname) (include [wiki:CoreIncludes CoreIncludes.h] to use it) that returns the ClassIdentifier of the given class.
+
+== The !ObjectList ==
 
 Every class that uses the !RegisterObject(classname) or !RegisterRootObject(interfacename) macro (see [wiki:CoreIncludes]) is represented by an [wiki:Identifier], that stores all objects of this class (and of all inherited classes) in a [wiki:ObjectList]. The object gets removed from the list if it gets deleted. This is handled by the destructor of [wiki:OrxonoxClass] and the [wiki:MetaObjectList].
 
 You can iterate through all objects in a [wiki:ObjectList] by using an [wiki:Iterator]. Read the related Wiki-page to get more informations.
+
+== Example ==
+
+{{{
+#!cpp
+MyClass.h:
+
+class MyClass : public BaseObject
+{
+  MyClass();
+};
+
+}}}
+
+{{{
+#!cpp
+MyClass.cc:
+
+#include "CoreIncludes.h"
+#include "MyClass.h"
+
+MyClass::MyClass()
+{
+  RegisterObject(MyClass);
+}
+}}}
+
+{{{
+#!cpp
+SomeOtherFile.cc:
+
+#include "CoreIncludes.h"
+#include "MyClass.h"
+
+Identifier* myidentifier = Class(MyClass);
+std::cout << myidentifier->getName() << std::endl;
+
+/*
+returns:
+MyClass
+*/
+}}}