Changes between Version 1 and Version 2 of code/doc/Executor

Timestamp:

Sep 30, 2008, 7:46:37 PM (16 years ago)

Author:

landauf

Comment:

—

code/doc/Executor

@@ -7 +7 @@
 == Usage ==
 === Creation ===
-To create an Executor, you first have to create a [wiki:Functor] (usually with '''createFunctor('''''function-pointer''''')'''). Then you call '''createExecutor('''''functor''''')''' to create the Executor. Of course you can also use '''new Executor('''''functor''''')'''.
+To create an Executor, you first have to create a [wiki:Functor] (usually by using the helper function '''createFunctor('''''function-pointer''''')'''). Then you call '''createExecutor('''''functor''''')''' to create the Executor. Of course you can also use '''new Executor('''''functor''''')'''.
 {{{
 void function();
@@ -15 +15 @@
 
 '''Important''': createExecutor uses '''new''' to create the executor. If you are responsible for the Executor, you have to delete it afterwards.
+
+'''Important''': If an Executor gets deleted, it deletes it's Functor too, so you don't have to care about the Functor. '''Never''' share Functors among different Executors, this would lead to a crash.
+
+It's also possible to give the Executor a name:
+{{{
+void function();
+
+Executor* myexecutor = createExecutor(createFunctor(&function), "name");
+}}}
+This is usually unnecessary, but very important for [wiki:ConsoleCommand] and other features.
 
 === Call ===
@@ -40 +50 @@
 myexecutor->setDefaultValue(2, 10);    // the third argument
 }}}
+(The second variant allows you to only bind the last argument for example.)
 
-Then you can call the Executor without passing arguments:
+Then you can call the Executor without passing arguments; the Executor uses the previously added default values to compensate the missing arguments:
 {{{
 (*myexecutor)(); // equivalent to function(false, 2.5, 10);
 }}}
-The Executor uses the previously added default values to compensate the missing arguments.
 
-Of course you can still use arguments:
+Of course you can still use arguments to overwrite default values:
 {{{
 (*myexecutor)(true, 3.3); // equivalent to function(true, 3.3, 10);
 }}}
 
+=== Descriptions ===
+ * '''setDescription('''''description''''')''': Sets the description of the Executor (what the function does)
+ * '''getDescription()''': Returns the description of the Executor
+
+ * '''setDescriptionParam('''''param number (0-4)''''', '''''description''''')''': Sets the description of an argument (what the argument does)
+ * '''getDescriptionParam('''''param number (0-4)''''')''': Returns the description of an argument
+
+ * '''setDescriptionReturnvalue('''''description''''')''': Sets the description of the return value (what the return value does)
+ * '''getDescriptionReturnvalue()''': Returns the description of the return value
+
 === Other Functions ===
+ * '''getName()''': Returns the Executors name
+ * '''getFunctor()''': Returns a pointer to the Functor
+
+ * '''getDefaultValue('''''param number (0-4)''''')''': Returns the default value for the given argument
+ * '''allDefaultValuesSet()''': Returns true if there's a default value for every argument
+
+ * '''getParamCount()''': Returns the amount of parameters the function takes
+ * '''hasReturnvalue()''': Returns true if the function returns a value
+ * '''getReturnvalue()''': Returns the value returned by the last call of the Functor
+ * '''getType()''': Returns the type of the function as an enum: FT_MEMBER, FT_CONSTMEMBER, FT_STATIC
+ * '''getTypenameParam('''''param number (0-4)''''')''': Returns the typename
+ * '''getTypenameReturnvalue()''': Returns the typename of the returnvalue as a string
+
+== Types ==
+There are two subclasses of Executor:
+
+=== ExecutorStatic ===
+ExecutorStatic accepts only [wiki:Functor#FunctorStatic]. Read the linked chapter for more information.
+
+=== ExecutorMember ===
+ExecutorMember accepts only [wiki:Functor#FunctorMember]. Read the linked chapter for more information. To call an ExecutorMember, just use it like FunctorMember:
+{{{
+class SomeClass
+{
+    void someFunction(int value);
+};
+
+SomeClass* object = new SomeClass();
+ExecutorMember* executor = createExecutor(createFunctor(&SomeClass::someFunction));
+
+(*executor)(object, 10); // this is equivalent to object->someFunction(10);
+
+// And with default value:
+executor->setDefaultValues(20);
+
+(*executor)(object); // this is equivalent to object->someFunction(20);
+}}}