OpenWalnut  1.4.0
WOutputConnectorWrapper.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 WOUTPUTCONNECTORWRAPPER_H
26 #define WOUTPUTCONNECTORWRAPPER_H
27 
28 #include <boost/shared_ptr.hpp>
29 
30 #include "core/kernel/WModuleOutputConnector.h"
31 
32 /**
33  * \class WOutputConnectorWrapper
34  *
35  * A wrapper for output connectors.
36  */
38 {
39 public:
40  /**
41  * Constructor.
42  *
43  * \param conn The input connector.
44  */
45  explicit WOutputConnectorWrapper( boost::shared_ptr< WModuleOutputConnector > conn );
46 
47  /**
48  * Disconnect this connector.
49  */
50  void disconnect();
51 
52  /**
53  * Get the pointer to the actual connector.
54  *
55  * \return The pointer to the connector.
56  */
57  boost::shared_ptr< WModuleOutputConnector > getConnectorPtr();
58 
59 private:
60  //! The actual input connector.
61  boost::shared_ptr< WModuleOutputConnector > m_conn;
62 };
63 
64 #endif // WOUTPUTCONNECTORWRAPPER_H
WOutputConnectorWrapper(boost::shared_ptr< WModuleOutputConnector > conn)
Constructor.
void disconnect()
Disconnect this connector.
A wrapper for output connectors.
boost::shared_ptr< WModuleOutputConnector > m_conn
The actual input connector.
boost::shared_ptr< WModuleOutputConnector > getConnectorPtr()
Get the pointer to the actual connector.