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

Encapsulates a property group. More...

#include <WPropertyGroupWrapper.h>

+ Collaboration diagram for WPropertyGroupWrapper:

Public Member Functions

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

Private Attributes

std::shared_ptr< WPropertyGroupm_group
 The property group. More...
 

Detailed Description

Encapsulates a property group.

Definition at line 39 of file WPropertyGroupWrapper.h.

Constructor & Destructor Documentation

◆ WPropertyGroupWrapper()

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

Constructor.

Parameters
groupThe group.

Definition at line 30 of file WPropertyGroupWrapper.cpp.

Referenced by getGroup().

+ Here is the caller graph for this function:

Member Function Documentation

◆ getDescription()

std::string WPropertyGroupWrapper::getDescription ( ) const

Return the description of the property group.

Returns
The description of the property group.

Definition at line 40 of file WPropertyGroupWrapper.cpp.

References m_group.

◆ getGroup()

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 50 of file WPropertyGroupWrapper.cpp.

References m_group, and WPropertyGroupWrapper().

+ Here is the call graph for this function:

◆ getName()

std::string WPropertyGroupWrapper::getName ( ) const

Return the name of the property group.

Returns
The name of the property group.

Definition at line 35 of file WPropertyGroupWrapper.cpp.

References m_group.

◆ getProperty()

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 45 of file WPropertyGroupWrapper.cpp.

References m_group.

Member Data Documentation

◆ m_group

std::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: