ChannelElementBase.hpp
Go to the documentation of this file.
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 #include "../internal/rtt-internal-fwd.hpp"
00050 
00051 namespace RTT { namespace base {
00052 
00060     class RTT_API ChannelElementBase
00061     {
00062     public:
00063         typedef boost::intrusive_ptr<ChannelElementBase> shared_ptr;
00064 
00065     private:
00066         oro_atomic_t refcount;
00067         friend void RTT_API intrusive_ptr_add_ref( ChannelElementBase* e );
00068         friend void RTT_API intrusive_ptr_release( ChannelElementBase* e );
00069 
00070         shared_ptr input;
00071         shared_ptr output;
00072 
00073         RTT::os::Mutex inout_lock;
00074 
00075     protected:
00077         void ref();
00080         void deref();
00081 
00082     public:
00088         ChannelElementBase();
00089         virtual ~ChannelElementBase();
00090 
00095         void removeInput();
00103         ChannelElementBase::shared_ptr getInput();
00104 
00111         ChannelElementBase::shared_ptr getInputEndPoint();
00112 
00113 
00117         ChannelElementBase::shared_ptr getOutput();
00118 
00125         ChannelElementBase::shared_ptr getOutputEndPoint();
00126 
00134         void setOutput(shared_ptr output);
00135 
00141         virtual bool signal();
00142 
00150         virtual bool inputReady();
00151 
00158         virtual void clear();
00159 
00164         virtual void disconnect(bool forward);
00165 
00171         virtual PortInterface* getPort() const;
00172 
00178         virtual internal::ConnID* getConnID() const;
00179     };
00180 
00181     void RTT_API intrusive_ptr_add_ref( ChannelElementBase* e );
00182     void RTT_API intrusive_ptr_release( ChannelElementBase* e );
00183 
00184 }}
00185 
00186 #endif
00187 


rtt
Author(s): RTT Developers
autogenerated on Wed Aug 26 2015 16:15:46