[4838] | 1 | /*! |
---|
[5632] | 2 | * @file executor.h |
---|
[7197] | 3 | * Definition of an Executor |
---|
[5391] | 4 | */ |
---|
[1853] | 5 | |
---|
[5632] | 6 | #ifndef _EXECUTOR_H |
---|
| 7 | #define _EXECUTOR_H |
---|
[1853] | 8 | |
---|
[5129] | 9 | #include "base_object.h" |
---|
[1853] | 10 | |
---|
[5141] | 11 | #include "helper_functions.h" |
---|
[5552] | 12 | #include "multi_type.h" |
---|
[5155] | 13 | #include "substring.h" |
---|
[5635] | 14 | #include "functor_list.h" //< MUST BE INCLUDED HERE AT LEAST ONCE. |
---|
[5141] | 15 | |
---|
[5328] | 16 | //! an enumerator for the definition of the Type. |
---|
| 17 | typedef enum { |
---|
[7221] | 18 | Executor_Objective = 1, |
---|
| 19 | Executor_Static = 2, |
---|
[5652] | 20 | |
---|
[7221] | 21 | Executor_NoLoadString = 8, |
---|
[5632] | 22 | } Executor_Type; |
---|
[5328] | 23 | |
---|
[5161] | 24 | //////////////// |
---|
| 25 | // BASE CLASS // |
---|
| 26 | //////////////// |
---|
[7197] | 27 | //! a BaseClass for all possible Executors |
---|
| 28 | /** |
---|
| 29 | * An Executor is an Object, that is able to call Objects of Any type (class) |
---|
| 30 | * and execute a function with given parameters on it. |
---|
| 31 | * |
---|
| 32 | * The Executor is able to handle: |
---|
| 33 | * Objects of any Class (Templated) |
---|
| 34 | * Default Values |
---|
| 35 | * Functions with up to 5 parameters (more seems useless) |
---|
[7331] | 36 | * Functions with many types (@see functor_list.h) |
---|
[7197] | 37 | */ |
---|
[7714] | 38 | class Executor : public BaseObject |
---|
[5170] | 39 | { |
---|
[8035] | 40 | public: |
---|
| 41 | virtual ~Executor(); |
---|
[5641] | 42 | |
---|
[8035] | 43 | virtual Executor* clone () const = 0; |
---|
| 44 | // virtual bool operator==(const Executor* executor) const = 0; |
---|
[5641] | 45 | |
---|
[8035] | 46 | // SETTING up the EXECUTOR |
---|
| 47 | Executor* defaultValues(const MultiType& value0 = MT_NULL, const MultiType& value1 = MT_NULL, |
---|
| 48 | const MultiType& value2 = MT_NULL, const MultiType& value3 = MT_NULL, |
---|
| 49 | const MultiType& value4 = MT_NULL); |
---|
| 50 | /** @param i the i'th defaultValue, @returns reference to the MultiType */ |
---|
| 51 | inline MultiType& getDefaultValue(unsigned int i) { return defaultValue[i]; }; |
---|
[5164] | 52 | |
---|
[8035] | 53 | // EXECUTE |
---|
| 54 | /** executes a Command. @param objec the Object, @param count how many values, @param values the Values */ |
---|
[8271] | 55 | virtual void operator()(BaseObject* object, int& count, void* values) const = 0; |
---|
[8035] | 56 | /** executes a Command @param object the object to apply this to @param parameters the parameters the command takes */ |
---|
| 57 | virtual void operator()(BaseObject* object, const SubString& sub = SubString()) const = 0; |
---|
[5161] | 58 | |
---|
[8035] | 59 | // RETRIEVE INFORMATION |
---|
| 60 | /** @returns the Type of this Function (either static or objective) */ |
---|
| 61 | inline long getType() const { return this->functorType; }; |
---|
| 62 | /** @returns the Count of Parameters this Executor takes */ |
---|
| 63 | inline unsigned int getParamCount() const { return this->paramCount; }; |
---|
[5161] | 64 | |
---|
[8035] | 65 | static void debug(); |
---|
[5161] | 66 | |
---|
[8035] | 67 | protected: |
---|
| 68 | Executor(const MultiType& param0 = MT_NULL, const MultiType& param1 = MT_NULL, |
---|
| 69 | const MultiType& param2 = MT_NULL, const MultiType& param3 = MT_NULL, |
---|
| 70 | const MultiType& param4 = MT_NULL); |
---|
[5328] | 71 | |
---|
[8035] | 72 | void cloning(Executor* executor) const; |
---|
| 73 | |
---|
| 74 | protected: |
---|
| 75 | short functorType; //!< The type of Function we've got (either static or objective). |
---|
| 76 | unsigned int paramCount; //!< the count of parameters. |
---|
| 77 | MultiType defaultValue[5]; //!< Default Values. |
---|
[5161] | 78 | }; |
---|
| 79 | |
---|
[7722] | 80 | #include "executor/executor_functional.h" |
---|
[7725] | 81 | #define EXECUTOR_FUNCTIONAL_USE_CONST |
---|
| 82 | #include "executor/executor_functional.h" |
---|
[7722] | 83 | #define EXECUTOR_FUNCTIONAL_USE_STATIC |
---|
| 84 | #include "executor/executor_functional.h" |
---|
[5161] | 85 | |
---|
[5632] | 86 | #endif /* _EXECUTOR_H */ |
---|