Changeset 4764 in orxonox.OLD for orxonox/trunk/src/lib

Timestamp:

Jul 2, 2005, 1:55:44 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: nicer description of the class_list.h, little changelog

File:

• orxonox/trunk/src/lib/lang/class_list.h (modified) (1 diff)

orxonox/trunk/src/lib/lang/class_list.h

@@ -17 +17 @@
 //! A class that handles Pointers to Objects of all type.
 /**
-  here all the Pointers to all the Object of orxonox are stored, that implement BaseObject
-  for now, this is only for debugging reasons, and we should be able to detect undeleted
-  Objects.
+ * here all the Pointers to all the Object of orxonox are stored, that implement BaseObject
+ * for now.
+ * You can get Any Object's Reference to BaseObject with dynamic_cast<T>(ClassList::getObject(name, CL_T_NAME));
+ *  where: T: is the Class to cast to,
+ *   name: the name of the Object (not className)
+ *   CL_T_NAME: the class Identifier, (if CL_NULL or nothing it will take longer, because all BaseObject's are searched through)
+ *
+ * There is also the exists-function, that just checks, if a Reference is still in existence.
+ *
+ * @see ClassID, BaseObject, dynamic_cast
  */
 class ClassList {