OpenWalnut  1.4.0
Public Member Functions | Private Attributes | List of all members
WPropertyGroupWrapper Class Reference

Encapsulates a property group. More...

#include <WPropertyGroupWrapper.h>

Public Member Functions

 WPropertyGroupWrapper (boost::shared_ptr< WPropertyGroup > group)
 Constructor.
std::string getName () const
 Return the name of the property group.
std::string getDescription () const
 Return the description of the property group.
WPropertyWrapper getProperty (std::string const &name)
 Retrieve a property by name.
WPropertyGroupWrapper getGroup (std::string const &name)
 Retrieve a property group by name.

Private Attributes

boost::shared_ptr< WPropertyGroupm_group
 The property group.

Detailed Description

Encapsulates a property group.

Definition at line 39 of file WPropertyGroupWrapper.h.

Constructor & Destructor Documentation

WPropertyGroupWrapper::WPropertyGroupWrapper ( boost::shared_ptr< WPropertyGroup group)
explicit

Constructor.

Parameters
groupThe group.

Definition at line 29 of file WPropertyGroupWrapper.cpp.

Referenced by getGroup().

Member Function Documentation

std::string WPropertyGroupWrapper::getDescription ( ) const

Return the description of the property group.

Returns
The description of the property group.

Definition at line 39 of file WPropertyGroupWrapper.cpp.

References m_group.

WPropertyGroupWrapper WPropertyGroupWrapper::getGroup ( std::string const &  name)

Retrieve a property group by name.

Parameters
nameThe name of the group to look for.
Returns
The property group with the given name.

Definition at line 49 of file WPropertyGroupWrapper.cpp.

References m_group, and WPropertyGroupWrapper().

std::string WPropertyGroupWrapper::getName ( ) const

Return the name of the property group.

Returns
The name of the property group.

Definition at line 34 of file WPropertyGroupWrapper.cpp.

References m_group.

WPropertyWrapper WPropertyGroupWrapper::getProperty ( std::string const &  name)

Retrieve a property by name.

Parameters
nameThe name of the property.
Returns
The property with the given name.

Definition at line 44 of file WPropertyGroupWrapper.cpp.

References m_group.

Member Data Documentation

boost::shared_ptr< WPropertyGroup > WPropertyGroupWrapper::m_group
private

The property group.

Definition at line 81 of file WPropertyGroupWrapper.h.

Referenced by getDescription(), getGroup(), getName(), and getProperty().


The documentation for this class was generated from the following files: