OpenWalnut  1.4.0
WModuleContainerWrapper.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 WMODULECONTAINERWRAPPER_H
00026 #define WMODULECONTAINERWRAPPER_H
00027 
00028 #include <string>
00029 
00030 #include <boost/shared_ptr.hpp>
00031 
00032 #include "core/kernel/WModuleContainer.h"
00033 
00034 #include "WModuleWrapper.h"
00035 
00036 /**
00037  * \class WModuleContainerWrapper
00038  *
00039  * Encapsulates a module container. This class is exposed to scripts.
00040  */
00041 class WModuleContainerWrapper
00042 {
00043 public:
00044     /**
00045      * Constructor. Creates an empty wrapper.
00046      */
00047     WModuleContainerWrapper();
00048 
00049     /**
00050      * Constructor.
00051      *
00052      * \param mc The module container.
00053      */
00054     explicit WModuleContainerWrapper( boost::shared_ptr< WModuleContainer > mc );
00055 
00056     /**
00057      * Destructor.
00058      */
00059     ~WModuleContainerWrapper();
00060 
00061     /**
00062      * Creates a module from the prototype with the given name.
00063      *
00064      * \param name The name of the module prototype.
00065      * \return The module.
00066      */
00067     WModuleWrapper create( std::string const& name );
00068 
00069     /**
00070      * Creates a data module and load the file given via filename.
00071      *
00072      * \param filename The name of the file to load.
00073      * \return The module.
00074      */
00075     WModuleWrapper createDataModule( std::string const& filename );
00076 
00077     /**
00078      * Remove a module from the container.
00079      *
00080      * \param module The module to remove.
00081      */
00082     void remove( WModuleWrapper module );
00083 
00084 private:
00085     //! The module container.
00086     boost::shared_ptr< WModuleContainer > m_mc;
00087 };
00088 
00089 #endif  // WMODULECONTAINERWRAPPER_H