Changeset 3664 in orxonox.OLD

Timestamp:

Mar 30, 2005, 12:11:23 AM (19 years ago)

Author:

patrick

Message:

orxonox/trunk: doxygen comments for garbage collector

File:

• orxonox/trunk/src/garbage_collector.cc (modified) (3 diffs)

orxonox/trunk/src/garbage_collector.cc

@@ -65 +65 @@
 
 
+/**
+   \brief this sets the collection delay
+   \param delay
+   
+   after this delay, the garbage collector starts its work and begins to collect unused object
+   to delete them afterwards. only objects in the worldentity list from the world object are lookded
+   at. 
+*/
 void GarbageCollector::setCollectionDelay(float delay)
-{}
+{
+  this->delay = delay;
+}
 
 
+/**
+   \brief this foreces a garbage collection
+
+   if this function is called, the gc tries to initiate the garbage collection routines. actually
+   this should always work.
+*/
 void GarbageCollector::forceCollection()
 {
-  
+  /* just make the time slitely bigger than the delay */
+  this->time = this->delay + 1;
+  /* and update, to get rid of the unused objects */
+  this->update();
 }
 
+
+/**
+   \brief this ticks the GarbageCollector to give it the time pulse
+   \param the time passed since last tick
+
+   like every other tick function eg. worldentity
+*/
 void GarbageCollector::tick(float time)
 {
@@ -80 +106 @@
 
 
+/**
+   \brief this updated the gargabe collection, if the time is ready
+
+
+*/
 void GarbageCollector::update()
 {
@@ -101 +132 @@
           /* second remove out of pnode tree */
           entity->remove();
-          //NullParent* np = NullParent::getInstance();
-          //np->removeChild(np);
-          
         }
       entity = iterator->nextElement();