OpenWalnut
1.4.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
src
core
scripting
wrappers
WPropertyGroupWrapper.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 WPROPERTYGROUPWRAPPER_H
26
#define WPROPERTYGROUPWRAPPER_H
27
28
#include <string>
29
30
#include "core/common/WPropertyGroup.h"
31
32
#include "WPropertyWrapper.h"
33
34
/**
35
* \class WPropertyGroupWrapper
36
*
37
* Encapsulates a property group.
38
*/
39
class
WPropertyGroupWrapper
40
{
41
public
:
42
/**
43
* Constructor.
44
*
45
* \param group The group.
46
*/
47
explicit
WPropertyGroupWrapper
( boost::shared_ptr< WPropertyGroup > group );
48
49
/**
50
* Return the name of the property group.
51
*
52
* \return The name of the property group.
53
*/
54
std::string
getName
()
const
;
55
56
/**
57
* Return the description of the property group.
58
*
59
* \return The description of the property group.
60
*/
61
std::string
getDescription
()
const
;
62
63
/**
64
* Retrieve a property by name.
65
*
66
* \param name The name of the property.
67
* \return The property with the given name.
68
*/
69
WPropertyWrapper
getProperty
( std::string
const
& name );
70
71
/**
72
* Retrieve a property group by name.
73
*
74
* \param name The name of the group to look for.
75
* \return The property group with the given name.
76
*/
77
WPropertyGroupWrapper
getGroup
( std::string
const
& name );
78
79
private
:
80
//! The property group.
81
boost::shared_ptr< WPropertyGroup >
m_group
;
82
};
83
84
#endif // WPROPERTYGROUPWRAPPER_H
Generated by
1.8.3.1