ExecutionEngine.hpp

/***************************************************************************
  tag: Peter Soetens  Wed Jan 18 14:11:40 CET 2006  ExecutionEngine.hpp

                        ExecutionEngine.hpp -  description
                           -------------------
    begin                : Wed January 18 2006
    copyright            : (C) 2006 Peter Soetens
    email                : peter.soetens@mech.kuleuven.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef ORO_EXECUTION_ENGINE_HPP
#define ORO_EXECUTION_ENGINE_HPP

#include "RunnableInterface.hpp"
#include "ActivityInterface.hpp"
#include <vector>

#include "rtt-config.h"
#ifdef OROPKG_EXECUTION_ENGINE_EVENTS
#include "EventProcessor.hpp"
#endif
#ifdef OROPKG_EXECUTION_ENGINE_COMMANDS
#include "CommandProcessor.hpp"
#endif
#ifdef OROPKG_EXECUTION_ENGINE_PROGRAMS
#include "ProgramProcessor.hpp"
#endif
#ifdef OROPKG_EXECUTION_ENGINE_STATEMACHINES
#include "StateMachineProcessor.hpp"
#endif

namespace RTT
{
    class TaskCore;
    class CommandProcessor;
    class EventProcessor;
    class ProgramProcessor;
    class StateMachineProcessor;

    class RTT_API ExecutionEngine
        : public RunnableInterface
    {
    protected:
        enum EngineState { Stopped, Activating, Active, Running };
        TaskCore*     taskc;

        EngineState     estate;

        RunnableInterface* cproc;
        RunnableInterface* pproc;
        RunnableInterface* smproc;
        RunnableInterface* eproc;

        std::vector<TaskCore*> children;

        void setup();

        bool startContexts();
    public:
        ExecutionEngine( TaskCore* owner = 0);

        ~ExecutionEngine();

        bool activate();

        bool start();

        bool stop();

        virtual bool initialize();

        virtual void step();

        virtual bool breakLoop();

        virtual void finalize();

        virtual void setActivity(ActivityInterface* t);

        virtual bool hasWork();

        TaskCore* getParent();

        virtual void addChild(TaskCore* tc);

        virtual void removeChild(TaskCore* tc);

        TaskCore* getTaskCore() const { return taskc; }

        CommandProcessor* commands() const;

        ProgramProcessor* programs() const;

        StateMachineProcessor* states() const;

        EventProcessor* events() const;

        virtual void setCommandProcessor(CommandProcessor* c);

        virtual void setProgramProcessor(ProgramProcessor* p);

        virtual void setStateMachineProcessor(StateMachineProcessor* s);

        virtual void setEventProcessor(EventProcessor* e);

    };

}
#endif