Changeset 4938 in orxonox.OLD for orxonox/trunk/src/util/object_manager.cc

Timestamp:

Jul 22, 2005, 11:57:38 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen tags.

File:

• orxonox/trunk/src/util/object_manager.cc (modified) (10 diffs)

orxonox/trunk/src/util/object_manager.cc

@@ -23 +23 @@
 using namespace std;
 
-
-
-
-/**
- *  constructor, sets everything to zero and define factoryName
+/**
+ * Initializes a FastFactory
+ * @param classID the ClassID this Class belongs to (the top-most)
+ * @param fastFactoryName the Name of the ObjectClass-handled here
+ * @return a new FastFactory
  */
 FastFactory::FastFactory (ClassID classID, const char* fastFactoryName)
@@ -50 +50 @@
 /**
  *  destructor
- *  clear the Q
+ * deletes all the Instances of the FastFactory.
  */
 FastFactory::~FastFactory ()
@@ -61 +61 @@
 }
 
+/**
+ * registers a Factory to the List of known factories.
+ * @param fastFactory The factory to add
+ *
+ * needed, to step through all the FastFactories.
+ */
 void FastFactory::registerFastFactory(FastFactory* fastFactory)
 {
@@ -101 +107 @@
 
 /**
- *
+ * Removes all the stored Containers, and sets the Lists back to emptienes.
+ * @param hardFLUSH if true the containing Objects will also be deleted !! THIS IS DANGEROUS !!
  */
 void FastFactory::flushAll(bool hardFLUSH)
@@ -116 +123 @@
 /**
  * ereases all the remaining containers, without deleting the stored Objects inside of them.
+ * @param hardFLUSH if the the containing Objects will also be deleted !! THIS IS DANGEROUS !!
  */
 void FastFactory::flush(bool hardFLUSH)
@@ -140 +148 @@
 }
 
-
-
+/**
+ * generates count new Object of the Corresponding class. (precaching)
+ * @param count How many instances of the class should be generated.
+ */
 void FastFactory::prepare(unsigned int count)
 {
@@ -154 +164 @@
 }
 
-
-BaseObject* FastFactory::resurect(ClassID classID)
+/**
+ * gives back live to one Object.
+ * @return the Object to resurrect.
+ */
+BaseObject* FastFactory::resurrect()
 {
   PRINTF(4)("Resurecting Object of type %s\n", this->getName());
@@ -163 +176 @@
         "Fabricating a new %s", this->getName(), this->getName());
     this->fabricate();
-    return this->resurect(classID);
+    return this->resurrect();
   }
   else
@@ -177 +190 @@
 }
 
-
-
-void FastFactory::kill(ClassID classID, BaseObject* object)
+/**
+ * gives back live to one Object.
+ * @param classID the class From which to resurrect an Object.
+ * @return the Object to resurrect, NULL if classID is not found.
+ */
+BaseObject* FastFactory::resurrect(ClassID classID)
+{
+  FastFactory* tmpFac = FastFactory::getFirst();
+
+  while (tmpFac != NULL)
+  {
+    if (classID == tmpFac->storedClassID)
+      return tmpFac->resurrect();
+    tmpFac = tmpFac->next;
+  }
+  return NULL;
+}
+
+/**
+ * kills Object object, meaning, that it will be stored in the deadList of the FastFactory, and waiting for resurrection
+ * @param object the Object to kill.
+ */
+void FastFactory::kill(BaseObject* object)
 {
   FastObjectMember* tmpC;
@@ -194 +227 @@
   tmpC->next = this->deadList;
   tmpC->objectPointer = object;
-}
-
-
-
+  this->deadList = tmpC;
+}
+
+
+void FastFactory::kill(BaseObject* object, ClassID classID)
+{
+
+
+}