Blam::Config::ConfigFile Struct Reference

Data structure representing a legacy configuration file. More...

#include <config.h>

Public Member Functions
	ConfigFile (std::string _filename)
	Prepares a new legacy configuration file. More...
std::string	GetString (std::string option)
	Retrieves a string option from a configuration file. More...
bool	GetBoolean (std::string option)
	Retrieves a boolean option from a configuration file. More...
int	GetInt (std::string option)
	Retrieves an integer option from a configuration file. More...
float	GetFloat (std::string option)
	Retrieves a float option from a configuration file. More...

Public Attributes
std::string	filename
	The legacy configuration file name. More...

Detailed Description

Data structure representing a legacy configuration file.

Deprecated:

Only for legacy compatiability. Will be removed soon.

Constructor & Destructor Documentation

ConfigFile()

Blam::Config::ConfigFile::ConfigFile

(

std::string

_filename

)

Prepares a new legacy configuration file.

Parameters

_filename

- The new configuration filename.

Deprecated:

Only for legacy compatiability. Will be removed soon.

Member Function Documentation

GetBoolean()

bool Blam::Config::ConfigFile::GetBoolean

(

std::string

option

)

Retrieves a boolean option from a configuration file.

Parameters

option

- The name of the option.

Returns

The boolean value of the option.

Deprecated:

Only for legacy compatiability. Will be removed soon.

Here is the call graph for this function:

Here is the caller graph for this function:

GetFloat()

float Blam::Config::ConfigFile::GetFloat

(

std::string

option

)

Retrieves a float option from a configuration file.

Parameters

option

- The name of the option.

Returns

The float value of the option.

Deprecated:

Only for legacy compatiability. Will be removed soon.

Here is the call graph for this function:

GetInt()

int Blam::Config::ConfigFile::GetInt

(

std::string

option

)

Retrieves an integer option from a configuration file.

Parameters

option

- The name of the option.

Returns

The integer value of the option.

Deprecated:

Only for legacy compatiability. Will be removed soon.

Here is the call graph for this function:

GetString()

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

(

std::string

option

)

Retrieves a string option from a configuration file.

Parameters

option

- The name of the option.

Returns

The string value of the option.

Deprecated:

Only for legacy compatiability. Will be removed soon.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

filename

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

The legacy configuration file name.

---

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

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