Changeset 9763 in orxonox.OLD for branches/new_class_id/src/lib/util/loading/load_param.h

Timestamp:

Sep 19, 2006, 5:18:04 PM (18 years ago)

Author:

bensch

Message:

more doc

File:

• branches/new_class_id/src/lib/util/loading/load_param.h (modified) (6 diffs)

branches/new_class_id/src/lib/util/loading/load_param.h

@@ -37 +37 @@
 /**
  * Loads a Parameter from ROOT named PARAMETER_NAME
- * onto OBJECT of CLASS, trough the FUNCTION
+ * onto OBJECT of CLASS, trough FUNCTION
  * @param ROOT the TiXmlElement to load the Parameter from
  * @param PARAMETER_NAME the Name of the Parameter to load
@@ -47 +47 @@
          CLoadParam(ROOT, PARAMETER_NAME, OBJECT, createExecutor<CLASS>(&CLASS::FUNCTION), false)
 
+/**
+ * @brief Does essentially the same as LoadParam, but within a Cycle in an ordered fashion.
+ *
+ * This Function looks in each Element, if the PARAMETER_NAME matches, and loads onto OBJECT
+ * of CLASS the ROOT through FUNCTION
+ *
+ * @see LoadParam(ROOT, PARAMETER_NAME, OBJECT, CLASS, FUNCTION)
+ */
 #define LoadParam_CYCLE(ROOT, PARAMETER_NAME, OBJECT, CLASS, FUNCTION) \
          CLoadParam(ROOT, PARAMETER_NAME, OBJECT, createExecutor<CLASS>(&CLASS::FUNCTION), true)
@@ -77 +85 @@
 **** REAL DECLARATIONS ****
 **************************/
-class LoadParamBase : public BaseObject
+//!< A BaseClass for all LoadParam's.
+class LoadParamBase
 {
 protected:
@@ -86 +95 @@
 
 protected:
-  BaseObject*              object;
-  const std::string        paramName;
-  bool                     inLoadCycle;
+  BaseObject*              object;               //!< The Object to work on
+  const std::string        paramName;            //!< The Name of the Parameter this LoadParams applies to.
+  bool                     inLoadCycle;          //!< If the Parameter is in a LoadCycle.
 
   LoadClassDescription*    classDesc;            //!< The LoadClassDescription of this CLoadParameter
@@ -96 +105 @@
 
 
-//! abstract Base class for a Loadable parameter
+//! The Loading Class of the LoadParam, that acctually executes the loading process.
 class CLoadParam : public LoadParamBase
 {
@@ -111 +120 @@
 
 private:
-  Executor<const SubString>*         executor;
+  Executor<const SubString>*         executor;            //!< The Executor, that actually executes the Loading process.
 };