BlamConfigurationSection Class Reference

Structure representing a configuration section. More...

#include <config.h>

Public Member Functions
	BlamConfigurationSection (std::string _name, std::string _filename)
void	AddNewSetting (BlamConfigurationSetting *new_setting)
void	AddNewDefaultSetting (BlamConfigurationSetting *new_setting)
bool	HasOption (std::string option)
	Checks whether or not a given configuration setting exists in this section. More...
std::string *	GetString (std::string option)
	Retrieves a configuration setting as a string. More...
bool *	GetBool (std::string option)
	Retrieves a configuration setting as a bool. More...
float *	GetFloat (std::string option)
	Retrieves a configuration setting as a float. More...
int *	GetInt (std::string option)
	Retrieves a configuration setting as an int. More...
BlamColor *	GetColor (std::string option)
	Retrieves a configuration setting as a color. More...
void	ExpandSectionPlaceholders ()

Public Attributes
std::map< std::string, BlamConfigurationSetting * >	settings
std::map< std::string, BlamConfigurationSetting * >	default_settings
std::string	name

Detailed Description

Structure representing a configuration section.

Unlike the old configuration file setup, configuration files are broken up into sections, similar to an INI file. These can be used to group similar settings

Constructor & Destructor Documentation

BlamConfigurationSection()

BlamConfigurationSection::BlamConfigurationSection	(	std::string	_name,
		std::string	_filename
	)

Member Function Documentation

AddNewDefaultSetting()

void BlamConfigurationSection::AddNewDefaultSetting

(

BlamConfigurationSetting *

new_setting

)

AddNewSetting()

void BlamConfigurationSection::AddNewSetting

(

BlamConfigurationSetting *

new_setting

)

ExpandSectionPlaceholders()

void BlamConfigurationSection::ExpandSectionPlaceholders

(

)

GetBool()

bool * BlamConfigurationSection::GetBool

(

std::string

option

)

Retrieves a configuration setting as a bool.

Parameters

option

- The option to retrieve.

Returns

Pointer to the setting value if it exists, otherwise returns nullptr. If the setting exists but cannot be interpreted as a bool, then will also return nullptr.

GetColor()

BlamColor * BlamConfigurationSection::GetColor

(

std::string

option

)

Retrieves a configuration setting as a color.

Parameters

option

- The option to retrieve.

Returns

Pointer to the setting value if it exists, otherwise returns nullptr. If the setting exists but cannot be interpreted as a color, then will also return nullptr.

GetFloat()

float * BlamConfigurationSection::GetFloat

(

std::string

option

)

Retrieves a configuration setting as a float.

Parameters

option

- The option to retrieve.

Returns

Pointer to the setting value if it exists, otherwise returns nullptr. If the setting exists but cannot be interpreted as a float, then will also return nullptr.

GetInt()

int * BlamConfigurationSection::GetInt

(

std::string

option

)

Retrieves a configuration setting as an int.

Parameters

option

- The option to retrieve.

Returns

Pointer to the setting value if it exists, otherwise returns nullptr. If the setting exists but cannot be interpreted as an int, then will also return nullptr.

GetString()

std::string * BlamConfigurationSection::GetString

(

std::string

option

)

Retrieves a configuration setting as a string.

Parameters

option

- The option to retrieve.

Returns

Pointer to the setting value if it exists, otherwise returns nullptr. If the setting exists but is not listed as a string, then will also return nullptr.

HasOption()

bool BlamConfigurationSection::HasOption

(

std::string

option

)

Checks whether or not a given configuration setting exists in this section.

Parameters

option

- The setting to look for.

Returns

true if the option exists, otherwise returns false.

Member Data Documentation

default_settings

std::map<std::string, BlamConfigurationSetting*> BlamConfigurationSection::default_settings

name

std::string BlamConfigurationSection::name

settings

std::map<std::string, BlamConfigurationSetting*> BlamConfigurationSection::settings

---

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

• blam/components/settings/config/config.h
• blam/components/settings/config/BlamConfigurationSection.cpp