Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/util/executor/executor.h @ 8703

Last change on this file since 8703 was 8408, checked in by bensch, 19 years ago

trunk: merged the script_engine branche back here
merged with command
svn merge https://svn.orxonox.net/orxonox/branches/script_engine . -r8284:HEAD
no conflicts

File size: 3.0 KB
Line 
1/*!
2 * @file executor.h
3 * Definition of an Executor
4 */
5
6#ifndef _EXECUTOR_H
7#define _EXECUTOR_H
8
9#include "base_object.h"
10
11#include "helper_functions.h"
12#include "multi_type.h"
13#include "substring.h"
14#include "functor_list.h" //< MUST BE INCLUDED HERE AT LEAST ONCE.
15
16//! an enumerator for the definition of the Type.
17typedef enum {
18  Executor_Objective         = 1,
19  Executor_Static            = 2,
20
21  Executor_NoLoadString      = 8,
22} Executor_Type;
23
24////////////////
25// BASE CLASS //
26////////////////
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 overhead, split up the function)
36 *  Functions with many types (@see functor_list.h)
37 */
38class Executor : public BaseObject
39{
40  public:
41    virtual ~Executor();
42
43    virtual Executor* clone () const = 0;
44//    virtual bool operator==(const Executor* executor) const = 0;
45
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]; };
52
53    // EXECUTE
54    /** executes a Command. @param objec the Object, @param count how many values, @param values the Values */
55    virtual void operator()(BaseObject* object, int& count, void* values) const = 0;
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;
58
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; };
64
65    static void debug();
66
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);
71
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.
78};
79
80#include "executor/executor_functional.h"
81#define EXECUTOR_FUNCTIONAL_USE_CONST
82#include "executor/executor_functional.h"
83#define EXECUTOR_FUNCTIONAL_USE_STATIC
84#include "executor/executor_functional.h"
85
86#endif /* _EXECUTOR_H */
Note: See TracBrowser for help on using the repository browser.