Changeset 9726 in orxonox.OLD for branches/new_class_id/src/lib/lang/object_list.h

Timestamp:

Sep 9, 2006, 7:42:16 PM (18 years ago)

Author:

bensch

Message:

stuff from yesterday

File:

• branches/new_class_id/src/lib/lang/object_list.h (modified) (6 diffs)

branches/new_class_id/src/lib/lang/object_list.h

@@ -9 +9 @@
 
 #include "class_id.h"
-#include <cassert>
 #include <map>
 #include <list>
 #include <string>
+
+#include <cassert>
 #include <iostream>
 
@@ -101 +102 @@
   static int                            StringToID(const std::string& className);
 
-  //! Only uset to unsubscribe a BaseObject.
+  //! Only used to unsubscribe a BaseObject. (just try to make a valid iterator, stupid :))
   virtual void                          unregisterObject(IteratorBase* _iterators) = 0;
 
@@ -117 +118 @@
 
 protected:
-  typedef std::map<int, ObjectListBase*>         classIDMap;   //!< The Generic Map.
-  typedef std::map<std::string, ObjectListBase*> classNameMap; //!< The Generic Map.
+  typedef std::map<int, ObjectListBase*>         IDMap;   //!< The Generic Map.
+  typedef std::map<std::string, ObjectListBase*> NameMap; //!< The Generic Map.
 
 private:
@@ -126 +127 @@
 
 private:
-  static classIDMap*            _classesByID;       //!< A Map of all the classes in existance.
-  static classNameMap*          _classesByName;     //!< A Map of all the classes in existance.
+  static IDMap*                 _classesByID;       //!< A Map of all the classes in existance.
+  static NameMap*               _classesByName;     //!< A Map of all the classes in existance.
   static std::list<std::string> _classNames;        //!< A list of all the registered ClassNames.
 };
@@ -135 +136 @@
 //// TEMPLATISATION /////
 /////////////////////////
-//! Defines a ObjectsList handler for objects of type T.
+//! Defines a ObjectList handler for objects of type T.
 /**
  * The ObjectList is a generic way to store every object created from a Class 'T'
- *  into a List. The list can be retrieved, and used constantly over iterators,
+ *  in a List. The list can be retrieved, and used constantly over iterators,
  *  as with normal std::list.
  *
  * Furthermore the linkage over the single Lists is given over the Superclass ObjectListBase.
  *
- *
- *
+ * The approach of ObjectList is an intrusive one, meaning, that each Class that wants to
+ * support it must implement a Declaration and a Definition for the ObjectList, as mentioned
+ * in the next statement:
  *
  * To define a Class with a ObjectList, you have to:
@@ -152 +154 @@
  *
  * @note The Class must define the compare with const std::string& operator for this to work.
+ *  The operator==(const std::string& name) should compare the object's name with name.
  *
  *