OperationInterface.hpp

/***************************************************************************
  tag: FMTC  do nov 2 13:06:09 CET 2006  OperationInterface.hpp

                        OperationInterface.hpp -  description
                           -------------------
    begin                : do november 02 2006
    copyright            : (C) 2006 FMTC
    email                : peter.soetens@fmtc.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_OPERATION_INTERFACE_HPP
#define ORO_OPERATION_INTERFACE_HPP

#include <string>
#include <vector>
#include "rtt-config.h"
#include "CommandRepository.hpp"
#include "MethodRepository.hpp"
#ifdef OROPKG_EXECUTION_ENGINE_EVENTS
#include "EventService.hpp"
#endif
#include "AttributeRepository.hpp"

namespace RTT
{
    class ExecutionEngine;

    class RTT_API OperationInterface
    {
    protected:
        CommandRepository mcommands;

        MethodRepository mmethods;

#ifdef OROPKG_EXECUTION_ENGINE_EVENTS
        EventService mevents;
#endif

        AttributeRepository mattributes;

        typedef std::vector< OperationInterface* > Objects;
        Objects mobjects;
    public:
        OperationInterface();

        OperationInterface(ExecutionEngine* ee);
        typedef std::vector< std::string > ObjectList;

        CommandRepository* commands() { return &mcommands; }

        const CommandRepository* commands() const { return &mcommands; }

        MethodRepository* methods() { return &mmethods; }

        const MethodRepository* methods() const { return &mmethods; }

        EventService* events() {
#ifdef OROPKG_EXECUTION_ENGINE_EVENTS
            return &mevents;
#else
            return 0;
#endif
        }

        const EventService* events() const {
#ifdef OROPKG_EXECUTION_ENGINE_EVENTS
            return &mevents;
#else
            return 0;
#endif
        }

        AttributeRepository* attributes() { return &mattributes; }

        const AttributeRepository* attributes() const { return &mattributes; }

        virtual ~OperationInterface();

        virtual void clear();

        virtual const std::string& getName() const = 0;

        virtual const std::string& getDescription() const = 0;

        virtual bool addObject( OperationInterface *obj );

        virtual OperationInterface* getObject(const std::string& obj_name );

        virtual ObjectList getObjectList() const;

        virtual bool removeObject(const std::string& obj_name );

        virtual OperationInterface* getParent() = 0;

        virtual void setParent(OperationInterface* newparent) = 0;

        virtual void setEngine(ExecutionEngine* newengine) = 0;

    };
}


#endif