Changeset 9696 in orxonox.OLD

Timestamp:

Aug 24, 2006, 10:50:47 PM (18 years ago)

Author:

bensch

Message:

orxonox/trunk: more functionality: getObject, getObjectList, and many new doxy-tags

Location:

branches/new_class_id/src/lib/lang

Files:

• new_object_list.cc (modified) (3 diffs)
• new_object_list.h (modified) (6 diffs)

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

@@ -113 +113 @@
 
 /**
+ * @brief Searches for a ObjectList with the ID classID
+ * @param classID the ID to search for.
+ * @return The NewObjectList if found, NULL otherwise.
+ */
+const NewObjectListBase* const NewObjectListBase::getObjectList(int classID)
+{
+  assert (NewObjectListBase::_classesByID != NULL);
+  NewObjectListBase::classIDMap::iterator it = NewObjectListBase::_classesByID->find(classID);
+  if (it != NewObjectListBase::_classesByID->end())
+    return (*it).second;
+  else
+    return NULL;
+}
+
+/**
+ * @brief Searches for a ObjectList with the Name className
+ * @param className the Name to search for.
+ * @return The NewObjectList if found, NULL otherwise.
+ */
+const NewObjectListBase* const NewObjectListBase::getObjectList(const std::string& className)
+{
+  assert (NewObjectListBase::_classesByName != NULL);
+  NewObjectListBase::classNameMap::iterator it = NewObjectListBase::_classesByName->find(className);
+  if (it != NewObjectListBase::_classesByName->end())
+    return (*it).second;
+  else
+    return NULL;
+}
+
+/**
+ * @brief Searches for a ObjectList with the NewClassID classID
+ * @param classID the ID to search for.
+ * @return The NewObjectList if found, NULL otherwise.
+ */
+const NewObjectListBase* const NewObjectListBase::getObjectList(const NewClassID& classID)
+{
+  return NewObjectListBase::getObjectList(classID.id());
+}
+
+/**
+ * @brief Retrieves the first BaseObject matching the name objectName from the List matching classID.
+ * @param classID the ID of the List.
+ * @param objectName the Name of the Object to search for
+ */
+BaseObject* NewObjectListBase::getObject(int classID, const std::string& objectName)
+{
+  const NewObjectListBase* const base = NewObjectListBase::getObjectList(classID);
+
+  if (base != NULL)
+    return base->getBaseObject(objectName);
+  else
+    return NULL;
+}
+
+/**
+ * @brief Retrieves the first BaseObject matching the name objectName from the List matching className.
+ * @param className the Name of the List.
+ * @param objectName the Name of the Object to search for
+ */
+BaseObject* NewObjectListBase::getObject(const std::string& className, const std::string& objectName)
+{
+  const NewObjectListBase* const base = NewObjectListBase::getObjectList(className);
+
+  if (base != NULL)
+    return base->getBaseObject(objectName);
+  else
+    return NULL;
+}
+
+/**
+ * @brief Retrieves the first BaseObject matching the name objectName from the List matching classID.
+ * @param classID The NewClassID of the List.
+ * @param objectName the Name of the Object to search for
+ */
+BaseObject* NewObjectListBase::getObject(const NewClassID& classID, const std::string& objectName)
+{
+  const NewObjectListBase* const base = NewObjectListBase::getObjectList(classID);
+
+  if (base != NULL)
+    return base->getBaseObject(objectName);
+  else
+    return NULL;
+}
+
+
+/**
  * @brief Converts an ID into a ClassName String.
  * @param classID The ID to convert.
@@ -119 +205 @@
 const std::string& NewObjectListBase::IDToString(int classID)
 {
-  assert (NewObjectListBase::_classesByID != NULL);
-  NewObjectListBase::classIDMap::iterator it = NewObjectListBase::_classesByID->find(classID);
-  if (it != NewObjectListBase::_classesByID->end())
-    return (*it).second->name();
+  const NewObjectListBase* const base = NewObjectListBase::getObjectList(classID);
+
+  if (base != NULL)
+    return base->name();
   else
   {
@@ -138 +224 @@
 int NewObjectListBase::StringToID(const std::string& className)
 {
-  assert (NewObjectListBase::_classesByName != NULL);
-  NewObjectListBase::classNameMap::iterator it = NewObjectListBase::_classesByName->find(className);
-  if (it != NewObjectListBase::_classesByName->end())
-    return (*it).second->id();
+  const NewObjectListBase* const base = NewObjectListBase::getObjectList(className);
+
+  if (base != NULL)
+    return base->id();
   else
     return -1;

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

@@ -116 +116 @@
   virtual base_iterator base_end() const = 0;
 
+  static const NewObjectListBase* const getObjectList(int classID);
+  static const NewObjectListBase* const getObjectList(const std::string& className);
+  static const NewObjectListBase* const getObjectList(const NewClassID& classID);
+
+  static BaseObject* getObject(int classID, const std::string& objectName);
+  static BaseObject* getObject(const std::string& className, const std::string& objectName);
+  static BaseObject* getObject(const NewClassID& classID, const std::string& objectName);
+
+  virtual BaseObject* getBaseObject(const std::string& name) const = 0;
 
 protected:
@@ -166 +175 @@
   ~NewObjectList();
 
+  virtual BaseObject*     getBaseObject(const std::string& name) const;
   T*                      getObject(const std::string& name) const;
   inline const list&      objects() const { return _objects; };
@@ -239 +249 @@
 }
 
+/**
+ * @brief Retrieves a BaseObject matching the Name name in this List.
+ * @param name the Name of the Object.
+ * @returns a BaseObject pointing to the object if found, NULL otherwise.
+ */
+template <class T>
+BaseObject* NewObjectList<T>::getBaseObject(const std::string& name) const
+{
+  return this->getObject(name);
+}
+
+
+
+/**
+ * @brief Retrieves an Object of type T matching the Name name in this List.
+ * @param name the Name of the Object.
+ * @returns an Object of type T pointing to the object if found, NULL otherwise.
+ */
 template <class T>
 T* NewObjectList<T>::getObject(const std::string& name) const
@@ -249 +277 @@
 }
 
+/**
+ * @brief registers an Object to the NewObjectList.
+ * @param T object the Object to register.
+ * @returns a pointer to the iterator inside of the list.
+ */
 template <class T>
 NewObjectListBase::IteratorBase* NewObjectList<T>::registerObject(T* object)
@@ -256 +289 @@
 }
 
+/**
+ * @brief removes an Object from the ClassList.
+ * @param iterator the Position at which to remove the Object.
+ */
 template <class T>
 void NewObjectList<T>::unregisterObject(IteratorBase* iterator)
@@ -263 +300 @@
 }
 
-
+/**
+ * @brief print out some debug information
+ * @note this function will most probably vanish from here and be completely moved to the base class.
+ */
 template <class T>
 void NewObjectList<T>::debug() const