Blam::Config::ConfigFile Class Reference

Class to contain data related to a Config file. More...

#include <config.h>

Public Member Functions
std::string	GetString (std::string option)
	Retrieves the specified config option's value as a string. More...
const char *	GetCString (std::string option)
	Retrieves the specified config option's value as a const char*, also referred to as a C-String. More...
std::wstring	GetWString (std::string option)
	Retrieves the specified config option's value as a wstring. More...
float	GetFloat (std::string option)
	Retrieves the specified config option's value as an int (32-bit integer) More...
int	GetInt (std::string option)
	Retrieves the specified config option's value as a float More...
double	GetDouble (std::string option)
	Retrieves the specified config option's value as a double More...
bool	GetBoolean (std::string option)
	Retrieves the specified config option's value as a bool More...

Public Attributes
std::string	path
	The path to the configuration file. Can be either absolute or relative. More...
std::string	filename
	The name of the configuration file. More...
std::map< std::string, ConfigOption >	options
	Contains all options contained within the config file. More...
std::map< std::string, ConfigOption >	default_options
	Contains all defaults for the config file. More...

Detailed Description

Class to contain data related to a Config file.

Member Function Documentation

GetBoolean()

bool Blam::Config::ConfigFile::GetBoolean

(

std::string

option

)

Retrieves the specified config option's value as a bool

Parameters

option

- The ID of the configuration option.

GetCString()

const char * Blam::Config::ConfigFile::GetCString

(

std::string

option

)

Retrieves the specified config option's value as a const char*, also referred to as a C-String.

Parameters

option

- The ID of the configuration option.

GetDouble()

double Blam::Config::ConfigFile::GetDouble

(

std::string

option

)

Retrieves the specified config option's value as a double

Parameters

option

- The ID of the configuration option.

GetFloat()

float Blam::Config::ConfigFile::GetFloat

(

std::string

option

)

Retrieves the specified config option's value as an int (32-bit integer)

Parameters

option

- The ID of the configuration option.

GetInt()

int Blam::Config::ConfigFile::GetInt

(

std::string

option

)

Retrieves the specified config option's value as a float

Parameters

option

- The ID of the configuration option.

GetString()

std::string Blam::Config::ConfigFile::GetString

(

std::string

option

)

Retrieves the specified config option's value as a string.

Parameters

option

- The ID of the configuration option.

GetWString()

std::wstring Blam::Config::ConfigFile::GetWString

(

std::string

option

)

Retrieves the specified config option's value as a wstring.

Parameters

option

- The ID of the configuration option.

Member Data Documentation

default_options

std::map<std::string, ConfigOption> Blam::Config::ConfigFile::default_options

Contains all defaults for the config file.

Usually, defaults are stored as a resource embedded within the application.

filename

std::string Blam::Config::ConfigFile::filename

The name of the configuration file.

options

std::map<std::string, ConfigOption> Blam::Config::ConfigFile::options

Contains all options contained within the config file.

path

std::string Blam::Config::ConfigFile::path

The path to the configuration file. Can be either absolute or relative.

---

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

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