Properties Class Reference

#include <properties.h>

Inheritance diagram for Properties:

Public Member Functions
	Properties ()
virtual	~Properties ()
const std::string	getProperty (const std::string &name, const std::string &def) const
float	getFloatProperty (const std::string &name, const float def) const
bool	getBoolProperty (const std::string &name, const bool def) const
bool	hasProperty (const std::string &name) const
void	setProperty (const std::string &name, const std::string &value)

Private Types
typedef std::map< std::string, std::string >	PropertyMap

Private Attributes
PropertyMap	mProperties

Detailed Description

A class holding a set of properties.

Definition at line 35 of file properties.h.

Member Typedef Documentation

PropertyMap

typedef std::map<std::string, std::string> Properties::PropertyMap

private

Definition at line 133 of file properties.h.

Constructor & Destructor Documentation

Properties()

Properties::Properties ( )

inline

Definition at line 38 of file properties.h.

                     :
            mProperties()
        {
        }

~Properties()

virtual Properties::~Properties ( )

inlinevirtual

Destructor.

Definition at line 48 of file properties.h.

        { }

Member Function Documentation

getBoolProperty()

bool Properties::getBoolProperty ( const std::string &  name, const bool  def  ) const

inline

Gets a map property as a boolean.

Parameters

name	The name of the property.
def	Default value, false by default.

Returns

the value of the given property or the given default when it doesn't exist.

Definition at line 97 of file properties.h.

        {
            const PropertyMap::const_iterator i = mProperties.find(name);
            bool ret = def;
            if (i != mProperties.end())
            {
                if (i->second == "true")
                    ret = true;
                if (i->second == "false")
                    ret = false;
            }
            return ret;
        }

References mProperties.

Referenced by Map::initializeAmbientLayers().

getFloatProperty()

float Properties::getFloatProperty ( const std::string &  name, const float  def  ) const

inline

Gets a map property as a float.

Parameters

name	The name of the property.
def	Default value, 0.0F by default.

Returns

the value of the given property or the given default when it doesn't exist.

Definition at line 75 of file properties.h.

        {
            const PropertyMap::const_iterator i = mProperties.find(name);
            float ret = def;
            if (i != mProperties.end())
            {
                std::stringstream ss;
                ss.str(i->second);
                ss >> ret;
            }
            return ret;
        }

References mProperties.

Referenced by Map::initializeAmbientLayers().

getProperty()

const std::string Properties::getProperty ( const std::string &  name, const std::string &  def  ) const

inline

Get a map property.

Parameters

name	The name of the property.
def	Default value, empty string by default.

Returns

the value of the given property or the given default when it doesn't exist.

Definition at line 59 of file properties.h.

        {
            const PropertyMap::const_iterator i = mProperties.find(name);
            return (i != mProperties.end()) ? i->second : def;
        }

References mProperties.

Referenced by Map::getFilename(), Map::getGatName(), Map::getMusicFile(), Map::getName(), Map::getUserMapDirectory(), Map::initializeAmbientLayers(), MapDebugTab::logic(), LocalPlayer::moveToHome(), LocalPlayer::removeHome(), LocalPlayer::setHome(), Minimap::setMap(), QuestsWindow::setMap(), MapReader::updateMusic(), and LocalPlayer::updateNavigateList().

hasProperty()

bool Properties::hasProperty ( const std::string &  name ) const

inline

Returns whether a certain property is available.

Parameters

name	The name of the property.

Returns

true when a property is defined, false otherwise.

Definition at line 119 of file properties.h.

        { return (mProperties.find(name) != mProperties.end()); }

References mProperties.

Referenced by Map::getName(), and Map::initializeAmbientLayers().

setProperty()

void Properties::setProperty ( const std::string &  name, const std::string &  value  )

inline

Set a map property.

Parameters

name	The name of the property.
value	The value of the property.

Definition at line 128 of file properties.h.

        { mProperties[name] = value; }

References mProperties.

Referenced by MapReader::createEmptyMap(), and MapReader::updateMusic().

Field Documentation

mProperties

PropertyMap Properties::mProperties

private

Definition at line 134 of file properties.h.

Referenced by getBoolProperty(), getFloatProperty(), getProperty(), hasProperty(), and setProperty().

---

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

• src/resources/map/properties.h (986a3bf)