OpenWalnut
1.4.0
|
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 WPROPERTYGROUPWRAPPER_H 00026 #define WPROPERTYGROUPWRAPPER_H 00027 00028 #include <string> 00029 00030 #include "core/common/WPropertyGroup.h" 00031 00032 #include "WPropertyWrapper.h" 00033 00034 /** 00035 * \class WPropertyGroupWrapper 00036 * 00037 * Encapsulates a property group. 00038 */ 00039 class WPropertyGroupWrapper 00040 { 00041 public: 00042 /** 00043 * Constructor. 00044 * 00045 * \param group The group. 00046 */ 00047 explicit WPropertyGroupWrapper( boost::shared_ptr< WPropertyGroup > group ); 00048 00049 /** 00050 * Return the name of the property group. 00051 * 00052 * \return The name of the property group. 00053 */ 00054 std::string getName() const; 00055 00056 /** 00057 * Return the description of the property group. 00058 * 00059 * \return The description of the property group. 00060 */ 00061 std::string getDescription() const; 00062 00063 /** 00064 * Retrieve a property by name. 00065 * 00066 * \param name The name of the property. 00067 * \return The property with the given name. 00068 */ 00069 WPropertyWrapper getProperty( std::string const& name ); 00070 00071 /** 00072 * Retrieve a property group by name. 00073 * 00074 * \param name The name of the group to look for. 00075 * \return The property group with the given name. 00076 */ 00077 WPropertyGroupWrapper getGroup( std::string const& name ); 00078 00079 private: 00080 //! The property group. 00081 boost::shared_ptr< WPropertyGroup > m_group; 00082 }; 00083 00084 #endif // WPROPERTYGROUPWRAPPER_H