Changeset 9724 in orxonox.OLD

Timestamp:

Sep 8, 2006, 12:20:55 PM (18 years ago)

Author:

bensch

Message:

many many documentations and one new functiopm

Location:

branches/new_class_id/src/lib/lang

Files:

• base_object.cc (modified) (3 diffs)
• base_object.h (modified) (2 diffs)
• object_list.cc (modified) (3 diffs)
• object_list.h (modified) (8 diffs)

branches/new_class_id/src/lib/lang/base_object.cc

@@ -25 +25 @@
 /**
  * @brief sets the name from a LoadXML-Element
- * @param root the element to load from
+ * @param objectName: The name of the Object.
  */
 BaseObject::BaseObject(const std::string& objectName)
@@ -100 +100 @@
 /**
  * @brief Seeks in the Inheritance if it matches objectList.
- * @param objectList The ObjectList this should be a member of (by Pointer-comparison).
+ * @param classID The ClassID this should be a member of (by Pointer-comparison).
  * @return True if found, false if not.
  */
@@ -141 +141 @@
 
 
+/**
+ * @brief This is for debug purposes, to see the Inheritances of this Object and its classes.
+ *
+ * The Inheritance will be listed in a Linear fashion, diamand structures are resolved in a linear dependency.
+ */
 void BaseObject::listInheritance() const
 {

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

@@ -26 +26 @@
 class BaseObject : public sigslot::has_slots<>
 {
+  //! Declare an ObjectList for this Class.
   ObjectListDeclaration(BaseObject);
 public:
@@ -48 +49 @@
   inline const std::string& getClassName() const { return _classes.front()._objectList->name(); };
 
+  /** @returns the ClassID of this Object */
   inline const ClassID& getClassID() const { return _classes.front()._objectList->identity(); }
   /** @returns the ID of the Topmost object of the ClassStack */

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

@@ -98 +98 @@
 /**
  * @brief Checks if a Class with name already exists.
- * @param name The Name of the Class to check.
+ * @param id The id of the Class to check.
  * @return true if such a class already exists.
  */
@@ -233 +233 @@
 }
 
+
+/**
+ * @returns An alphabetically sorted List of all stored ClassNames.
+ */
+const std::list<std::string>& ObjectListBase::getClassNames()
+{
+  if (ObjectListBase::classCount() != ObjectListBase::_classNames.size())
+  {
+    ObjectListBase::_classNames.clear();
+
+    for (classNameMap::const_iterator it = ObjectListBase::_classesByName->begin();
+         it != ObjectListBase::_classesByName->end();
+         ++it)
+    {
+      ObjectListBase::_classNames.push_back((*it).second->name());
+    }
+  }
+  return ObjectListBase::_classNames;
+}
+
+
 #include "base_object.h"
 
 /**
  * @brief Prints out some debugging information about a given List.
+ * @param level:
+ *  1: List ObjectListsand how many object.
+ *  2: 1+List ObjectLists entries, and information about Objects.
  */
 void ObjectListBase::debug(unsigned int level) const
@@ -259 +283 @@
 
 
+/**
+ * @brief prints out debug output about all Lists
+ * @param level:
+ *  0: list number of ClassList and general info.
+ *  1: 0+List ObjectLists and how many object.
+ *  2: 1+List ObjectLists entries, and information about Objects.
+ */
 void ObjectListBase::debugAll(unsigned int level)
 {

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

@@ -28 +28 @@
    static ObjectList<ClassName> _objectList
 
+/**
+ * @brief Use this macro to easily define a Class to store its own ObjectListDefinition
+ * @param ClassName: the Name of the Class.
+ * @param ID: optional set a Fixed ID.
+ */
 #define ObjectListDefinitionID(ClassName, ID) \
    ObjectList<ClassName> ClassName::_objectList(#ClassName, ID)
 
-
+/**
+ * @brief Use this macro to easily define a Class to store its own ObjectListDefinition
+ * @param ClassName: the Name of the Class.
+ */
 #define ObjectListDefinition(ClassName) \
     ObjectListDefinitionID(ClassName, -1)
@@ -43 +51 @@
 {
 public:
-  //! A fast iterator Base-Class, for iterator-casting and storing.
-  /**
-   * @note This Iterator is explicitely used only for storage purposes in the BaseObject
-   */
-  class IteratorBase { };
-
   /** @brief A Typedefinition for the Base-List that can be retrieved with getBaseObjectList(base_list*) */
   typedef std::list<BaseObject*>        base_list;
   /** @brief An iterator for the base_list */
   typedef base_list::iterator           base_iterator;
+  //! A fast iterator Base-Class, for iterator-casting and storing.
+  /** @note This Iterator is explicitely used only for storage purposes in the BaseObject */
+  class IteratorBase { };
 
 public:
   /** @returns The Identity of the Class stored within. */
-  inline const ClassID&              identity() const { return _identity; }
+  inline const ClassID&                 identity() const { return _identity; }
   /** @returns the ID of the Identity of the ObjectList */
   inline int                            id() const { return _id; };
@@ -67 +72 @@
   /** @param name The name to compare @returns true on match, false otherwise */
   inline bool                           operator==(const std::string& name) const { return _name == name; };
-  /** @param id The id to check @returns true on match, false otherwise */
+  /** @param id The id to acquire @param name the Name to acquire @brief stores a Name and an ID in a pointer. */
   inline void                           acquireID(const int*& id, const std::string*& name) const { id = &_id; name = &_name; };
   /** @brief fills a list of Objects into a BaseObject*-List. @param list the list to fill */
@@ -104 +109 @@
 
 private:
-  ObjectListBase(const ObjectListBase&);
+  /** @brief hidden copy constructor. */
+  ObjectListBase(const ObjectListBase&) {};
 
   static bool                         classIDExists(int id);
@@ -153 +159 @@
  *   and not loaded before the ObjectList.
  *
- * @example Iterating: Iteration is made easy, and fast as follows:
+ * example: Iterating: Iteration is made easy, and fast as follows:
  *   for (ObjectList<PlayerStats>::const_iterator it = PlayerStats::objectList().begin();
  *      it != PlayerStats::objectList().end();
@@ -161 +167 @@
  *   }
  *
- * @example Find an Object:
+ * example: Find an Object:
  * Playable* playable = Playable::objectList("orxonox-super-rocket-fighter"); // searches an Object By its name.
  *
@@ -192 +198 @@
   virtual BaseObject*                getBaseObject(const std::string& name) const;
   T*                                 getObject(const std::string& name) const;
+  /** @returns A constant list of Objects of this Class. */
   inline const list&                 objects() const { return _objects; };
   bool                               exists(const T* const object) const;
@@ -314 +321 @@
 /**
  * @brief registers an Object to the ObjectList.
- * @param T object the Object to register.
+ * @param object The Object to register.
  * @returns a pointer to the iterator inside of the list.
  */