OpenWalnut  1.4.0
WInputConnectorWrapper.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WINPUTCONNECTORWRAPPER_H
26 #define WINPUTCONNECTORWRAPPER_H
27 
28 #ifndef Q_MOC_RUN
29 #include <boost/shared_ptr.hpp>
30 #endif
31 
32 #include "core/kernel/WModuleInputConnector.h"
33 
34 #include "WOutputConnectorWrapper.h"
35 
36 /**
37  * \class WInputConnectorWrapper
38  *
39  * A wrapper for input connectors.
40  */
42 {
43 public:
44  /**
45  * Constructor.
46  *
47  * \param conn The input connector.
48  */
49  explicit WInputConnectorWrapper( boost::shared_ptr< WModuleInputConnector > conn );
50 
51  /**
52  * Connect this input connector to an output connector.
53  *
54  * \param conn The output connector to connect to.
55  */
56  void connect( WOutputConnectorWrapper conn );
57 
58  /**
59  * Disconnect this connector.
60  */
61  void disconnect();
62 
63  /**
64  * Wait for new input.
65  */
66  void waitForInput();
67 
68 private:
69  //! The actual input connector.
70  boost::shared_ptr< WModuleInputConnector > m_conn;
71 };
72 
73 #endif // WINPUTCONNECTORWRAPPER_H
boost::shared_ptr< WModuleInputConnector > m_conn
The actual input connector.
A wrapper for output connectors.
void connect(WOutputConnectorWrapper conn)
Connect this input connector to an output connector.
void disconnect()
Disconnect this connector.
void waitForInput()
Wait for new input.
WInputConnectorWrapper(boost::shared_ptr< WModuleInputConnector > conn)
Constructor.
A wrapper for input connectors.