rtt: OutputPortInterface.hpp Source File

00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Oct 22 11:59:07 CEST 2009  OutputPortInterface.hpp
00003 
00004                         OutputPortInterface.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_OUTPUT_PORT_INTERFACE_HPP
00040 #define ORO_OUTPUT_PORT_INTERFACE_HPP
00041 
00042 #include "PortInterface.hpp"
00043 #include "../internal/ConnectionManager.hpp"
00044 #include "DataSourceBase.hpp"
00045 
00046 namespace RTT
00047 { namespace base {
00048 
00053     class RTT_API OutputPortInterface : public PortInterface
00054     {
00055     protected:
00056         internal::ConnectionManager cmanager;
00057 
00061         virtual bool connectionAdded(ChannelElementBase::shared_ptr channel_input, ConnPolicy const& policy) = 0;
00062 
00063         OutputPortInterface(OutputPortInterface const& orig);
00064     public:
00070         virtual bool addConnection(internal::ConnID* port_id, ChannelElementBase::shared_ptr channel_input, ConnPolicy const& policy);
00071 
00072         OutputPortInterface(std::string const& name);
00073 
00074         virtual ~OutputPortInterface();
00075 
00079         virtual bool keepsLastWrittenValue() const = 0;
00080 
00089         virtual void keepLastWrittenValue(bool new_flag) = 0;
00090 
00095         virtual DataSourceBase::shared_ptr getDataSource() const = 0;
00096 
00097         virtual void disconnect();
00098 
00102         virtual bool connected() const;
00103 
00107         virtual void write(DataSourceBase::shared_ptr source);
00108 
00112         bool createDataConnection( InputPortInterface& sink, int lock_policy = ConnPolicy::LOCK_FREE );
00113 
00118         bool createBufferConnection( InputPortInterface& sink, int size, int lock_policy = ConnPolicy::LOCK_FREE );
00119 
00123         bool createConnection( InputPortInterface& sink );
00124 
00128         virtual bool createConnection( InputPortInterface& sink, ConnPolicy const& policy ) = 0;
00129 
00131         virtual bool disconnect(PortInterface* port);
00132 
00136         virtual bool removeConnection(internal::ConnID* cid);
00137 
00138         virtual bool connectTo(PortInterface* other, ConnPolicy const& policy);
00139 
00140         virtual bool connectTo(PortInterface* other);
00141 
00142         virtual const internal::ConnectionManager* getManager() const { return &cmanager; }
00143     };
00144 }}
00145 
00146 #endif