Changeset 9748 in orxonox.OLD for branches/new_class_id/src/lib/util/executor/executor.h

Timestamp:

Sep 16, 2006, 10:09:59 PM (18 years ago)

Author:

bensch

Message:

completely documented Executors

File:

• branches/new_class_id/src/lib/util/executor/executor.h (modified) (10 diffs)

branches/new_class_id/src/lib/util/executor/executor.h

@@ -16 +16 @@
 
 
-
+/** @returns the Type of an Argument taken by the Executor */
 template<typename type> MT_Type ExecutorParamType() { return MT_EXT1; };
 template<> MT_Type ExecutorParamType<bool>();
@@ -66 +66 @@
   inline bool hasRetVal() const { return bRetVal; };
 
-  /** executes a Command. @param objec the Object, @param count how many values, @param values the Values */
+  /** executes a Command. @param object the Object, @param values The Value of type CallType to pass to the Executor. */
   virtual void operator()(BaseClass* object, CallType& values) const = 0;
 
@@ -76 +76 @@
    * @param value3 the fourth default value
    * @param value4 the fifth default value
+   * @param value5 the sixth default value
+   * @param value6 the seventh default value
    * @returns itself
    * @note: THIS FUNCTION WILL BE REPLACED BY A CONFIGURATOR (most probably).
@@ -109 +111 @@
 protected:
   //! Now follows a List of Executor Constructors, to be fast in creating.
+  //! Creates an Executor with no Argument.
   Executor(bool hasRetVal, FunctionType functionType = FunctionMember)
   : bRetVal(hasRetVal), paramCount(0), functionType(functionType)
   { };
 
+  //! Creates an Executor with 1 Argument.
   Executor(bool hasRetVal, const MultiType& param0,
            FunctionType functionType = FunctionMember)
@@ -120 +124 @@
   };
 
+  //! Creates an Executor with 2 Arguments.
   Executor(bool hasRetVal, const MultiType& param0, const MultiType& param1,
            FunctionType functionType = FunctionMember)
@@ -128 +133 @@
   };
 
+  //! Creates an Executor with 3 Arguments.
   Executor(bool hasRetVal, const MultiType& param0, const MultiType& param1,
            const MultiType& param2,
@@ -138 +144 @@
   };
 
+  //! Creates an Executor with 4 Arguments.
   Executor(bool hasRetVal, const MultiType& param0, const MultiType& param1,
            const MultiType& param2, const MultiType& param3,
@@ -149 +156 @@
   };
 
+  //! Creates an Executor with 5 Arguments.
   Executor(bool hasRetVal, const MultiType& param0, const MultiType& param1,
            const MultiType& param2, const MultiType& param3,
@@ -162 +170 @@
   };
 
+  //! Creates an Executor with 6 Arguments.
   Executor(bool hasRetVal, const MultiType& param0, const MultiType& param1,
            const MultiType& param2, const MultiType& param3,
@@ -176 +185 @@
   };
 
+  //! Creates an Executor with 7 Arguments.
   Executor(bool hasRetVal, const MultiType& param0, const MultiType& param1,
            const MultiType& param2, const MultiType& param3,