OperationInterface.hpp

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

                        OperationInterface.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_OPERATION_REPOSITORY_HPP
#define ORO_OPERATION_REPOSITORY_HPP

#include <string>
#include <vector>
#include <map>

#include "rtt-config.h"
#include "base/DataSourceBase.hpp"
#include "internal/DataSource.hpp"
#include "ArgumentDescription.hpp"
#include "FactoryExceptions.hpp"
#include "OperationInterfacePart.hpp"


namespace RTT
{
    class RTT_API OperationInterface
    {
    protected:
        typedef std::map<std::string, OperationInterfacePart*> map_t;
        map_t data;
    public:
        typedef std::vector<base::DataSourceBase::shared_ptr> Arguments;

        void clear();

        std::vector<std::string> getNames() const;

        bool hasMember(const std::string& name) const;

        int getArity(const std::string& name) const;

        int getCollectArity(const std::string& name) const;

        bool isSynchronous(const std::string& name) const;

        base::DataSourceBase::shared_ptr produce(const std::string& name, const Arguments& args, ExecutionEngine* caller) const;

        base::DataSourceBase::shared_ptr produceSend(const std::string& name, const Arguments& args, ExecutionEngine* caller) const;

        base::DataSourceBase::shared_ptr produceHandle(const std::string& name) const;

        base::DataSourceBase::shared_ptr produceCollect(const std::string& name, const Arguments& args, internal::DataSource<bool>::shared_ptr blocking) const;

#ifdef ORO_SIGNALLING_OPERATIONS

        Handle produceSignal(const std::string& name, base::ActionInterface* func, const std::vector<base::DataSourceBase::shared_ptr>& args) const;
#endif

        typedef std::vector<ArgumentDescription> Descriptions;

        Descriptions getArgumentList(const std::string& name) const;

        std::string getResultType(const std::string& name) const;

        std::string getDescription(const std::string& name) const;

        void add(const std::string& name, OperationInterfacePart* part);

        void remove(const std::string& name);

        OperationInterfacePart* getPart(const std::string& name);
    };
}

#endif