Orocos Real-Time Toolkit  2.6.0
ChannelElementBase.hpp
00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Oct 22 11:59:07 CEST 2009  ChannelElementBase.hpp
00003 
00004                         ChannelElementBase.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_CHANNEL_BASE_HPP
00040 #define ORO_CHANNEL_BASE_HPP
00041 
00042 #include "../os/oro_arch.h"
00043 #include <utility>
00044 #include <boost/intrusive_ptr.hpp>
00045 #include <boost/call_traits.hpp>
00046 
00047 #include <rtt/os/Mutex.hpp>
00048 #include "rtt-base-fwd.hpp"
00049 
00050 namespace RTT { namespace base {
00051 
00059     class RTT_API ChannelElementBase
00060     {
00061     public:
00062         typedef boost::intrusive_ptr<ChannelElementBase> shared_ptr;
00063 
00064     private:
00065         oro_atomic_t refcount;
00066         friend void RTT_API intrusive_ptr_add_ref( ChannelElementBase* e );
00067         friend void RTT_API intrusive_ptr_release( ChannelElementBase* e );
00068 
00069         shared_ptr input;
00070         shared_ptr output;
00071 
00072         RTT::os::Mutex inout_lock;
00073 
00074     protected:
00076         void ref();
00079         void deref();
00080 
00081     public:
00087         ChannelElementBase();
00088         virtual ~ChannelElementBase();
00089 
00094         void removeInput();
00102         ChannelElementBase::shared_ptr getInput();
00103 
00110         ChannelElementBase::shared_ptr getInputEndPoint();
00111 
00112 
00116         ChannelElementBase::shared_ptr getOutput();
00117 
00124         ChannelElementBase::shared_ptr getOutputEndPoint();
00125 
00133         void setOutput(shared_ptr output);
00134 
00140         virtual bool signal();
00141 
00149         virtual bool inputReady();
00150 
00157         virtual void clear();
00158 
00163         virtual void disconnect(bool forward);
00164 
00170         virtual PortInterface* getPort() const;
00171     };
00172 
00173     void RTT_API intrusive_ptr_add_ref( ChannelElementBase* e );
00174     void RTT_API intrusive_ptr_release( ChannelElementBase* e );
00175 
00176 }}
00177 
00178 #endif
00179