PortInterface.hpp

Go to the documentation of this file.

/***************************************************************************
  tag: Peter Soetens  Thu Oct 22 11:59:07 CEST 2009  PortInterface.hpp

                        PortInterface.hpp -  description
                           -------------------
    begin                : Thu October 22 2009
    copyright            : (C) 2009 Sylvain Joyeux
    email                : sylvain.joyeux@m4x.org

 ***************************************************************************
 *   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_PORT_INTERFACE_HPP
#define ORO_EXECUTION_PORT_INTERFACE_HPP

#include <string>
#include "../internal/rtt-internal-fwd.hpp"
#include "../ConnPolicy.hpp"
#include "../internal/ConnectionManager.hpp"
#include "../internal/ConnID.hpp"
#include "ChannelElementBase.hpp"
#include "../types/rtt-types-fwd.hpp"
#include "../os/Mutex.hpp"
#include "../rtt-fwd.hpp"

namespace RTT
{ namespace base {

    class RTT_API PortInterface
    {
        std::string name;
        std::string fullName;
        std::string mdesc;

        void updateFullName();

    protected:
        DataFlowInterface* iface;
        internal::ConnectionManager cmanager;
        os::MutexRecursive connection_lock;
        friend class internal::PortConnectionLock;

        PortInterface(const std::string& name);

    public:
        virtual ~PortInterface();

        virtual internal::ConnID* getPortID() const;

        const std::string& getName() const { return name; }

        const std::string& getFullName() const { return fullName; }

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

        const std::string& getDescription() const { return mdesc; }

        PortInterface& doc(const std::string& desc);


        virtual bool connected() const = 0;

        virtual bool connectedTo(PortInterface* port);

        virtual const types::TypeInfo* getTypeInfo() const = 0;

        virtual void disconnect() = 0;

        virtual bool disconnect(PortInterface* port) = 0;

        virtual bool isLocal() const;

        virtual int serverProtocol() const;

        virtual PortInterface* clone() const = 0;

        virtual PortInterface* antiClone() const = 0;

        virtual Service* createPortObject();

        virtual bool connectTo(PortInterface* other, ConnPolicy const& policy) = 0;

        virtual bool connectTo(PortInterface* other) = 0;

        virtual bool createStream(ConnPolicy const& policy) = 0;

        virtual bool createConnection(internal::SharedConnectionBase::shared_ptr shared_connection, ConnPolicy const& policy = ConnPolicy()) = 0;

        virtual bool addConnection(internal::ConnID* cid, ChannelElementBase::shared_ptr channel,
                                   ConnPolicy const& policy = ConnPolicy()) = 0;

        virtual bool removeConnection(internal::ConnID* cid);

        void setInterface(DataFlowInterface* iface);

        DataFlowInterface* getInterface() const;

        virtual internal::ConnectionManager* getManager() { return &cmanager; }

        virtual ChannelElementBase* getEndpoint() const = 0;

        virtual internal::SharedConnectionBase::shared_ptr getSharedConnection() const;
    };

}}

#endif