rtt: InputPortInterface.hpp Source File

00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Oct 22 11:59:07 CEST 2009  InputPortInterface.hpp
00003 
00004                         InputPortInterface.hpp -  description
00005                            -------------------
00006     begin                : Thu October 22 2009
00007     copyright            : (C) 2009 Sylvain Joyeux
00008     email                : sylvain.joyeux@m4x.org
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_INPUT_PORT_INTERFACE_HPP
00040 #define ORO_INPUT_PORT_INTERFACE_HPP
00041 
00042 #include <string>
00043 #include "PortInterface.hpp"
00044 #include "ChannelElement.hpp"
00045 #include "../internal/rtt-internal-fwd.hpp"
00046 #include "../internal/ConnectionManager.hpp"
00047 #include "../internal/Signal.hpp"
00048 #include "../base/DataSourceBase.hpp"
00049 
00050 namespace RTT
00051 { namespace base {
00052 
00053 
00058     class RTT_API InputPortInterface : public PortInterface
00059     {
00060     public:
00061         typedef internal::Signal<void(PortInterface*)> NewDataOnPortEvent;
00062         typedef NewDataOnPortEvent::SlotFunction SlotFunction;
00063 
00064     protected:
00065         internal::ConnectionManager cmanager;
00066         ConnPolicy        default_policy;
00067         NewDataOnPortEvent* new_data_on_port_event;
00068 
00069         InputPortInterface(const InputPortInterface& orig);
00070     public:
00071 
00072         InputPortInterface(std::string const& name, ConnPolicy const& default_policy = ConnPolicy());
00073 
00074         virtual ~InputPortInterface();
00075 
00079         void clear();
00080 
00081         ConnPolicy getDefaultPolicy() const;
00082 
00083         virtual bool addConnection(internal::ConnID* port_id, ChannelElementBase::shared_ptr channel_input, ConnPolicy const& policy = ConnPolicy() );
00084 
00093         virtual bool removeConnection(internal::ConnID* cid);
00094 
00099         virtual DataSourceBase* getDataSource() = 0;
00100 
00106         virtual FlowStatus read(DataSourceBase::shared_ptr source, bool copy_old_data = true);
00107 
00111         virtual void disconnect();
00112 
00116         virtual bool disconnect(PortInterface* port);
00117 
00118 
00120         virtual bool connected() const;
00121 
00130         virtual bool channelReady(base::ChannelElementBase::shared_ptr channel);
00131 
00135         NewDataOnPortEvent* getNewDataOnPortEvent();
00136 
00137         virtual bool connectTo(PortInterface* other, ConnPolicy const& policy);
00138 
00139         virtual bool connectTo(PortInterface* other);
00140 
00141         virtual const internal::ConnectionManager* getManager() const { return &cmanager; }
00142     };
00143 
00144 }}
00145 
00146 #endif