Changeset 4489 in orxonox.OLD for orxonox/trunk/src/util/track/track_manager.cc

Timestamp:

Jun 3, 2005, 1:21:05 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: track: doxy-tags, redesign, and minor speed-update

File:

• orxonox/trunk/src/util/track/track_manager.cc (modified) (9 diffs)

orxonox/trunk/src/util/track/track_manager.cc

@@ -148 +148 @@
    \brief checks if there are any BackLoops in the Track (Backloops only 
    \param trackElem the trackElement to check about
+   \param depth the depth to search in
    \returns true if NO loop was found, false Otherwise
    You actually have to act on false!!
    it simply does this by looking if the current trackElem is found again somewhere else in the Track
+
+   \todo this has to be reimplemented
 */
 bool TrackElement::backLoopCheck(const TrackElement* trackElem, unsigned int depth) const
@@ -177 +180 @@
 
 /**
-   \param childNumber which child to return
+   \param childCount which child to return
    \returns the n-the children (starting at 0). 
    Be aware, that when the trackElement has no Children, NULL will be returned
@@ -217 +220 @@
 
 /**
-   \returns The name of this TrackElement
-*/
-const char* TrackElement::getName(void) const
-{
-  return this->name;
-}
-
-/**
    \brief prints out debug information about this TrackElement
 */
@@ -404 +399 @@
    \param root the TiXmlElement to load the Data from
 */
-bool TrackManager::load( TiXmlElement* root)
+bool TrackManager::loadParams( TiXmlElement* root)
 {
   TiXmlElement* element;
@@ -489 +484 @@
 }
 
-
-
 /**
    \brief standard destructor
@@ -509 +502 @@
 //! Singleton Reference to TrackManager
 TrackManager* TrackManager::singletonRef = NULL;
-
-/**
-   \returns The reference on the TrackManager.
-
-   If the TrackManager does not exist, it will be created.
-*/
-TrackManager* TrackManager::getInstance(void) 
-{
-  if (!TrackManager::singletonRef)
-    TrackManager::singletonRef = new TrackManager();
-  return TrackManager::singletonRef;
-}
-
 
 // INITIALIZE //
@@ -655 +635 @@
    \brief adds save/splitpoint.
    \param newPoint The point to add.
+   \param trackElem if supplied it will add a hotpoint on this TrackElement
    \returns A Pointer to a newly appended Curve
 */
@@ -721 +702 @@
 
 /**
-   \param string the String to parse.
+   \param count how many children to produce
+   \param ... the information on the children (these are the Stings of their names
    \see TrackManager::fork(unsigned int count, ...)
 
@@ -760 +742 @@
    \param count The Count of childrens the current HotPoint will have.
    \param trackIDs A Pointer to an Array of ints which will hold the trackID's (the user will have to reserve space for this).
+   \param trackNames the names for the tracks as a char-arrey-array 
    \param trackElem The TrackElement to appy this to. (if NULL choose this->currentTrackElement)
    \see TrackManager::fork(unsigned int count, ...)