rtt: OperationInterfacePart.hpp Source File

00001 /***************************************************************************
00002   tag: The SourceWorks  Tue Sep 7 00:55:18 CEST 2010  OperationInterfacePart.hpp
00003 
00004                         OperationInterfacePart.hpp -  description
00005                            -------------------
00006     begin                : Tue September 07 2010
00007     copyright            : (C) 2010 The SourceWorks
00008     email                : peter@thesourceworks.com
00009 
00010  ***************************************************************************
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU General Public                   *
00013  *   License as published by the Free Software Foundation;                 *
00014  *   version 2 of the License.                                             *
00015  *                                                                         *
00016  *   As a special exception, you may use this file as part of a free       *
00017  *   software library without restriction.  Specifically, if other files   *
00018  *   instantiate templates or use macros or inline functions from this     *
00019  *   file, or you compile this file and link it with other files to        *
00020  *   produce an executable, this file does not by itself cause the         *
00021  *   resulting executable to be covered by the GNU General Public          *
00022  *   License.  This exception does not however invalidate any other        *
00023  *   reasons why the executable file might be covered by the GNU General   *
00024  *   Public License.                                                       *
00025  *                                                                         *
00026  *   This library is distributed in the hope that it will be useful,       *
00027  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00028  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00029  *   Lesser General Public License for more details.                       *
00030  *                                                                         *
00031  *   You should have received a copy of the GNU General Public             *
00032  *   License along with this library; if not, write to the Free Software   *
00033  *   Foundation, Inc., 59 Temple Place,                                    *
00034  *   Suite 330, Boston, MA  02111-1307  USA                                *
00035  *                                                                         *
00036  ***************************************************************************/
00037 
00038 
00039 #ifndef ORO_OPERATIONREPOSITORYPART_HPP_
00040 #define ORO_OPERATIONREPOSITORYPART_HPP_
00041 
00042 #include <string>
00043 #include <vector>
00044 
00045 #include "base/DataSourceBase.hpp"
00046 #include "internal/DataSource.hpp"
00047 #include "ArgumentDescription.hpp"
00048 
00049 
00050 namespace RTT
00051 {
00069     class OperationInterfacePart
00070     {
00071     public:
00072         RTT_API virtual ~OperationInterfacePart();
00073 
00078          virtual std::string getName() const = 0;
00079 
00084         virtual std::string description() const = 0;
00085 
00090         virtual std::vector<ArgumentDescription> getArgumentList() const = 0;
00091 
00095         virtual std::string resultType() const = 0;
00096 
00101         virtual unsigned int arity() const = 0;
00102 
00109         virtual const types::TypeInfo* getArgumentType(unsigned int arg) const = 0;
00110 
00116         virtual unsigned int collectArity() const = 0;
00117 
00124         virtual const types::TypeInfo* getCollectType(unsigned int arg) const = 0;
00125 
00138         virtual base::DataSourceBase::shared_ptr produce(const std::vector<base::DataSourceBase::shared_ptr>& args, ExecutionEngine* caller) const = 0;
00139 
00154         virtual base::DataSourceBase::shared_ptr produceSend(const std::vector<base::DataSourceBase::shared_ptr>& args, ExecutionEngine* caller) const = 0;
00155 
00164         virtual base::DataSourceBase::shared_ptr produceHandle() const = 0;
00165 
00180         virtual base::DataSourceBase::shared_ptr produceCollect(const std::vector<base::DataSourceBase::shared_ptr>& args, internal::DataSource<bool>::shared_ptr blocking) const = 0;
00181 
00191         virtual Handle produceSignal( base::ActionInterface* func, const std::vector<base::DataSourceBase::shared_ptr>& args) const = 0;
00192 
00198         RTT_API virtual boost::shared_ptr<base::DisposableInterface> getLocalOperation() const;
00199     };
00200 }
00201 #endif /* ORO_OPERATIONREPOSITORYPART_HPP_ */