Ion
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ion::base::SettingGroup Class Reference

A SettingGroup is a convenience class to hold Settings that are in the same hierarchical group. More...

#include "setting.h"

Public Member Functions

 SettingGroup (const std::string &name)
 
 SettingGroup (const SettingGroup &parent_group, std::string name)
 
 ~SettingGroup ()
 
const std::string GetGroupName () const
 Returns the name of the group that this wraps. More...
 

Detailed Description

A SettingGroup is a convenience class to hold Settings that are in the same hierarchical group.

It can be passed to the constructor of a Setting (see below) to place that setting in the group. Since SettingGroup is a simple wrapper, it does not have to have the same lifetime as the Settings in it. See SettingBase (above) for a discussion of groups.

Definition at line 115 of file setting.h.

Constructor & Destructor Documentation

ion::base::SettingGroup::SettingGroup ( const std::string &  name)
inlineexplicit

Definition at line 117 of file setting.h.

References ion::base::EndsWith(), and ion::base::RemoveSuffix().

ion::base::SettingGroup::SettingGroup ( const SettingGroup parent_group,
std::string  name 
)
inline
ion::base::SettingGroup::~SettingGroup ( )
inline

Definition at line 128 of file setting.h.

Member Function Documentation

const std::string ion::base::SettingGroup::GetGroupName ( ) const
inline

Returns the name of the group that this wraps.

Definition at line 131 of file setting.h.

Referenced by SettingGroup().


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