Odyssey::Config Class Reference

#include <Config.h>

List of all members.

Public Types
typedef MapContainerIterator< OptionMap >	OptionIterator
typedef ConstMapContainerIterator< OptionMap >	ConstOptionIterator
Public Member Functions
	Config ()
	Create a new blank instance.
	Config (const Config &rhs)
	Share the option information from the given config.
void	copy (const Config &rhs)
	Force a copy of data from the given Config.
Option	operator[] (const String &name) const
	Operator access to the named options within.
Config &	operator= (const Config &rhs)
	Assigns shared access of data from the given Config.
Config &	option (const String &name, const Option &value)
	Inserts a new named Option.
Option	getOption (const String &name)
	Returns an Options with the given name.
void	removeOption (const String &name)
	Removes an option from this Config.
bool	containsOption (const String &name) const
	Returns true of the named Option exists.
size_t	getOptionCount () const
	Returns the number of options within this config.
OptionIterator	getOptionIterator ()
	Returns an iterator over the options within this config.
ConstOptionIterator	getOptionIterator () const
	Returns an iterator over the options within this config.
template<class Archive>
void	serialize (Archive &ar, const unsigned int version)
	This is an archiver function for options.
Protected Types
typedef std::map< String, Option >	OptionMap
typedef boost::shared_ptr< ConfigData >	ConfigDataPtr
Protected Attributes
ConfigDataPtr	_ptr
Classes
struct	ConfigData

---

Detailed Description

This class stores configuration options in name-option pairs.

---

Member Typedef Documentation

typedef boost::shared_ptr<ConfigData> Odyssey::Config::ConfigDataPtr [protected]

typedef ConstMapContainerIterator<OptionMap> Odyssey::Config::ConstOptionIterator

typedef MapContainerIterator<OptionMap> Odyssey::Config::OptionIterator

typedef std::map<String,Option> Odyssey::Config::OptionMap [protected]

---

Constructor & Destructor Documentation

Odyssey::Config::Config (   )

Create a new blank instance.

Odyssey::Config::Config (  const Config &  rhs  )

Share the option information from the given config.

---

Member Function Documentation

bool Odyssey::Config::containsOption (  const String &  name  )  const

Returns true of the named Option exists.

void Odyssey::Config::copy (  const Config &  rhs  )

Force a copy of data from the given Config.

Option Odyssey::Config::getOption (  const String &  name  )

Returns an Options with the given name.

size_t Odyssey::Config::getOptionCount (   )  const

Returns the number of options within this config.

ConstOptionIterator Odyssey::Config::getOptionIterator (   )  const

Returns an iterator over the options within this config.

OptionIterator Odyssey::Config::getOptionIterator (   )

Returns an iterator over the options within this config.

Config& Odyssey::Config::operator= (  const Config &  rhs  )

Assigns shared access of data from the given Config.

Option Odyssey::Config::operator[] (  const String &  name  )  const

Operator access to the named options within.

Config& Odyssey::Config::option (  const String &  name, const Option &  value )

Inserts a new named Option.

void Odyssey::Config::removeOption (  const String &  name  )

Removes an option from this Config.

template<class Archive> void Odyssey::Config::serialize (  Archive &  ar, const unsigned int  version )  [inline]

This is an archiver function for options.

---

Member Data Documentation

ConfigDataPtr Odyssey::Config::_ptr [protected]

---

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

• D:/Programs/odyssey/odyssey/include/Config.h

---