DataFlowInterface.hpp

/***************************************************************************
  tag: Peter Soetens  Thu Mar 2 08:30:18 CET 2006  DataFlowInterface.hpp

                        DataFlowInterface.hpp -  description
                           -------------------
    begin                : Thu March 02 2006
    copyright            : (C) 2006 Peter Soetens
    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_EXECUTION_DATA_FLOW_INTERFACE_HPP
#define ORO_EXECUTION_DATA_FLOW_INTERFACE_HPP

#include <vector>
#include <map>
#include <string>
#include "base/InputPortInterface.hpp"
#include "base/OutputPortInterface.hpp"
#include "rtt-fwd.hpp"
#include <boost/function.hpp>

namespace RTT
{

    class RTT_API DataFlowInterface
    {
    public:
        typedef std::vector<base::PortInterface*> Ports;

        typedef std::vector<std::string> PortNames;

        typedef boost::function<void(base::PortInterface*)> SlotFunction;

        DataFlowInterface(Service* parent = 0 );

        ~DataFlowInterface();

        base::PortInterface& addPort(const std::string& name, base::PortInterface& port) {
            if ( !chkPtr("addPort", name, &port) ) return port;
            port.setName(name);
            return addPort(port);
        }

        base::PortInterface& addPort(base::PortInterface& port);

        base::InputPortInterface& addEventPort(const std::string& name, base::InputPortInterface& port, SlotFunction callback = SlotFunction() ) {
            if ( !chkPtr("addEventPort", name, &port) ) return port;
            port.setName(name);
            return addEventPort(port,callback);
        }

        base::InputPortInterface& addEventPort(base::InputPortInterface& port, SlotFunction callback = SlotFunction() );

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

        Ports getPorts() const;

        PortNames getPortNames() const;

        base::PortInterface* getPort(const std::string& name) const;

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

        bool setPortDescription(const std::string& name, const std::string description);

        TaskContext* getOwner() const;

        Service* getService() const { return mservice; }

        base::PortInterface& addLocalPort(base::PortInterface& port);

        base::InputPortInterface& addLocalEventPort(base::InputPortInterface& port,
                SlotFunction callback = SlotFunction() );

        template< class Type>
        Type* getPortType(const std::string& name) {
            return dynamic_cast<Type*>( this->getPort(name) );
        }

        void clear();

#ifdef ORO_SIGNALLING_PORTS

        void setupHandles();
        void cleanupHandles();
#else

        void dataOnPort(base::PortInterface* port);
#endif
    protected:
        Service* createPortObject(const std::string& name);

        bool chkPtr(const std::string &where, const std::string& name, const void* ptr);
        Ports mports;
        Service* mservice;
#ifdef ORO_SIGNALLING_PORTS

        typedef std::vector< Handle > Handles;
        Handles handles;
#endif

    };

}

#endif