OpenWalnut  1.4.0
WOutputConnectorWrapper.h
00001 //---------------------------------------------------------------------------
00002 //
00003 // Project: OpenWalnut ( http://www.openwalnut.org )
00004 //
00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
00006 // For more information see http://www.openwalnut.org/copying
00007 //
00008 // This file is part of OpenWalnut.
00009 //
00010 // OpenWalnut is free software: you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as published by
00012 // the Free Software Foundation, either version 3 of the License, or
00013 // (at your option) any later version.
00014 //
00015 // OpenWalnut is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018 // GNU Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public License
00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
00022 //
00023 //---------------------------------------------------------------------------
00024 
00025 #ifndef WOUTPUTCONNECTORWRAPPER_H
00026 #define WOUTPUTCONNECTORWRAPPER_H
00027 
00028 #include <boost/shared_ptr.hpp>
00029 
00030 #include "core/kernel/WModuleOutputConnector.h"
00031 
00032 /**
00033  * \class WOutputConnectorWrapper
00034  *
00035  * A wrapper for output connectors.
00036  */
00037 class WOutputConnectorWrapper
00038 {
00039 public:
00040     /**
00041      * Constructor.
00042      *
00043      * \param conn The input connector.
00044      */
00045     explicit WOutputConnectorWrapper( boost::shared_ptr< WModuleOutputConnector > conn );
00046 
00047     /**
00048      * Disconnect this connector.
00049      */
00050     void disconnect();
00051 
00052     /**
00053      * Get the pointer to the actual connector.
00054      *
00055      * \return The pointer to the connector.
00056      */
00057     boost::shared_ptr< WModuleOutputConnector > getConnectorPtr();
00058 
00059 private:
00060     //! The actual input connector.
00061     boost::shared_ptr< WModuleOutputConnector > m_conn;
00062 };
00063 
00064 #endif  // WOUTPUTCONNECTORWRAPPER_H