OpenWalnut  1.4.0
WInputConnectorWrapper.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 WINPUTCONNECTORWRAPPER_H
00026 #define WINPUTCONNECTORWRAPPER_H
00027 
00028 #include <boost/shared_ptr.hpp>
00029 
00030 #include "core/kernel/WModuleInputConnector.h"
00031 
00032 #include "WOutputConnectorWrapper.h"
00033 
00034 /**
00035  * \class WInputConnectorWrapper
00036  *
00037  * A wrapper for input connectors.
00038  */
00039 class WInputConnectorWrapper
00040 {
00041 public:
00042     /**
00043      * Constructor.
00044      *
00045      * \param conn The input connector.
00046      */
00047     explicit WInputConnectorWrapper( boost::shared_ptr< WModuleInputConnector > conn );
00048 
00049     /**
00050      * Connect this input connector to an output connector.
00051      *
00052      * \param conn The output connector to connect to.
00053      */
00054     void connect( WOutputConnectorWrapper conn );
00055 
00056     /**
00057      * Disconnect this connector.
00058      */
00059     void disconnect();
00060 
00061     /**
00062      * Wait for new input.
00063      */
00064     void waitForInput();
00065 
00066 private:
00067     //! The actual input connector.
00068     boost::shared_ptr< WModuleInputConnector > m_conn;
00069 };
00070 
00071 #endif  // WINPUTCONNECTORWRAPPER_H