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

Timestamp:

Sep 1, 2006, 11:56:54 PM (18 years ago)

Author:

bensch

Message:

more thoughts on Resources, and soon going to adapt… i think i've got a clue

File:

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

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

@@ -72 +72 @@
   virtual void                          getBaseObjectList(base_list* list) const = 0;
 
-  static const ClassID&              retrieveIdentity(int id);
-  static const ClassID&              retrieveIdentity(const std::string& name);
-
-  static const ObjectListBase* const getObjectList(int classID);
-  static const ObjectListBase* const getObjectList(const std::string& className);
-  static const ObjectListBase* const getObjectList(const ClassID& classID);
+  static const ClassID&                 retrieveIdentity(int id);
+  static const ClassID&                 retrieveIdentity(const std::string& name);
+
+  static const ObjectListBase* const    getObjectList(int classID);
+  static const ObjectListBase* const    getObjectList(const std::string& className);
+  static const ObjectListBase* const    getObjectList(const ClassID& classID);
 
   static BaseObject*                    getBaseObject(int classID, const std::string& objectName);
@@ -115 +115 @@
 
 private:
-  int                           _id;
+  int                           _id;                //!< The Unique ID of the Class.
   const std::string             _name;              //!< The Name of the Class.
-  ClassID                    _identity;          //!< The Identity of the Class. (equal to _id and _name)
+  ClassID                       _identity;          //!< The Identity of the Class. (equal to _id and _name)
 
 private:
@@ -169 +169 @@
 {
 public:
-  typedef std::list<T*>                  list;
-  typedef typename list::iterator        iterator;
-  typedef typename list::const_iterator  const_iterator;
-
-
+  typedef std::list<T*>                  list;             //!< The list of Type T* (used for Objects in this ObjectList)
+  typedef typename list::iterator        iterator;         //!< The iterator for the List of type T (use with ObjectList<Type>::iterator)
+  typedef typename list::const_iterator  const_iterator;   //!< A constant iterator for the List of type T (use with ObjectList<Type>::const_iterator)
+
+
+  //! An iterator to store Objects in the BaseObject, and remove Objects fast.
 class Iterator : public ObjectListBase::IteratorBase
   {
   public:
-    Iterator(iterator it) { _it = it; }
+    /** @brief creates an Iterator fast. @param it the Iterator. */
+    inline Iterator(iterator it) { _it = it; }
+    /** @returns the Iterator */
     inline iterator& it() { return _it; }
-    typename ObjectList::iterator _it;
+  private:
+    typename ObjectList::iterator _it;  //!< Stored Iterator
   };
 
@@ -210 +214 @@
 
 
-  ObjectListBase::IteratorBase*   registerObject(T* object);
+  ObjectListBase::IteratorBase*      registerObject(T* object);
   virtual void                       unregisterObject(IteratorBase* iterator);
 
@@ -288 +292 @@
  */
 template <class T>
-    bool ObjectList<T>::exists(const T* const object) const
+bool ObjectList<T>::exists(const T* const object) const
 {
   return (std::find(_objects.begin(), _objects.end(), object) != _objects.end());