OperationInterfacePart.hpp

Go to the documentation of this file.

/***************************************************************************
  tag: The SourceWorks  Tue Sep 7 00:55:18 CEST 2010  OperationInterfacePart.hpp

                        OperationInterfacePart.hpp -  description
                           -------------------
    begin                : Tue September 07 2010
    copyright            : (C) 2010 The SourceWorks
    email                : peter@thesourceworks.com

 ***************************************************************************
 *   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_OPERATIONREPOSITORYPART_HPP_
#define ORO_OPERATIONREPOSITORYPART_HPP_

#include <string>
#include <vector>

#include "base/DataSourceBase.hpp"
#include "internal/DataSource.hpp"
#include "ArgumentDescription.hpp"


namespace RTT
{
    class OperationInterfacePart
    {
    public:
        RTT_API virtual ~OperationInterfacePart();

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

        virtual std::string description() const = 0;

        virtual std::vector<ArgumentDescription> getArgumentList() const = 0;

        virtual std::string resultType() const = 0;

        virtual unsigned int arity() const = 0;

        virtual const types::TypeInfo* getArgumentType(unsigned int arg) const = 0;

        virtual unsigned int collectArity() const = 0;

        virtual const types::TypeInfo* getCollectType(unsigned int arg) const = 0;

        virtual base::DataSourceBase::shared_ptr produce(const std::vector<base::DataSourceBase::shared_ptr>& args, ExecutionEngine* caller) const = 0;

        virtual base::DataSourceBase::shared_ptr produceSend(const std::vector<base::DataSourceBase::shared_ptr>& args, ExecutionEngine* caller) const = 0;

        virtual base::DataSourceBase::shared_ptr produceHandle() const = 0;

        virtual base::DataSourceBase::shared_ptr produceCollect(const std::vector<base::DataSourceBase::shared_ptr>& args, internal::DataSource<bool>::shared_ptr blocking) const = 0;

#ifdef ORO_SIGNALLING_OPERATIONS

        virtual Handle produceSignal( base::ActionInterface* func, const std::vector<base::DataSourceBase::shared_ptr>& args, ExecutionEngine* subscriber) const = 0;
#endif

        RTT_API virtual boost::shared_ptr<base::DisposableInterface> getLocalOperation() const;
    };
}
#endif /* ORO_OPERATIONREPOSITORYPART_HPP_ */