PWToolBox::Configuration::ConfigurationWriter Class Reference

The base interface used by all writers of configuration files. More...

#include <ConfigurationWriter.h>

Inheritance diagram for PWToolBox::Configuration::ConfigurationWriter:

[legend]List of all members.

Public Member Functions
	ConfigurationWriter (std::ostream &outputStream)
virtual	~ConfigurationWriter ()
void	write (ConfigurationSection const &configuration)
	Writes configuration and all of its settings and child sections.
void	write (ConfigurationSection::ConstSharedPtr const configuration)
	Writes configuration and all of its settings and child sections.
virtual bool	_writeBegin (ConfigurationSection const &configuration)
	This is called once at the beginning of the write.
virtual bool	_writeEnd (ConfigurationSection const &configuration)
	This is called once at the end of the write.
virtual bool	_writeSectionBegin (ConfigurationSection const &configuration, std::string const &key, ConfigurationSetting::AttributeList const &attrs)
	This is called at the beginning of each section.
virtual bool	_writeSettingBegin (ConfigurationSection const &configuration, std::string const &key, ConfigurationSetting::AttributeList const &attrs)
	This is called at the beginning of each setting.
virtual bool	_writeData (ConfigurationSection const &configuration, std::string const &data)
	This is called when writing the data.
virtual bool	_writeSectionEnd (ConfigurationSection const &configuration, std::string const &key)
	This is called at the end of each section.
virtual bool	_writeSettingEnd (ConfigurationSection const &configuration, std::string const &key)
	This is called at the end of each setting.
virtual void	_writeComment (ConfigurationSection const &configuration, std::string const &comment)
	This is called for each comment.
Protected Member Functions
void	writeSection (ConfigurationSection const &configuration)
	Recursively writes the sections and settings of configuration.
Protected Attributes
std::ostream &	m_outputStream
	The stream to write to.

---

Detailed Description

The base interface used by all writers of configuration files.

Uses the visitor pattern to write configurations.

---

Constructor & Destructor Documentation

PWToolBox::Configuration::ConfigurationWriter::ConfigurationWriter

(

std::ostream &

outputStream

)

[inline]

Parameters:

outputStream

The output stream to use for writing.

virtual PWToolBox::Configuration::ConfigurationWriter::~ConfigurationWriter

(

)

[inline, virtual]

---

Member Function Documentation

void PWToolBox::Configuration::ConfigurationWriter::write

(

ConfigurationSection const &

configuration

)

Writes configuration and all of its settings and child sections.

Parameters:

configuration

The ConfigurationSection to write

void PWToolBox::Configuration::ConfigurationWriter::write

(

ConfigurationSection::ConstSharedPtr const

configuration

)

Writes configuration and all of its settings and child sections.

Parameters:

configuration

The ConfigurationSection to write

virtual bool PWToolBox::Configuration::ConfigurationWriter::_writeBegin

(

ConfigurationSection const &

configuration

)

[inline, virtual]

This is called once at the beginning of the write.

This function should not be called directly.

Parameters:

configuration

The ConfigurationSection being written

Returns:

true if writing should continue, false otherwise

Reimplemented in PWToolBox::Configuration::XMLConfigurationWriter.

virtual bool PWToolBox::Configuration::ConfigurationWriter::_writeEnd

(

ConfigurationSection const &

configuration

)

[inline, virtual]

This is called once at the end of the write.

This function should not be called directly.

Parameters:

configuration

The ConfigurationSection being written

Returns:

true if writing should continue, false otherwise

Reimplemented in PWToolBox::Configuration::XMLConfigurationWriter.

virtual bool PWToolBox::Configuration::ConfigurationWriter::_writeSectionBegin	(	ConfigurationSection const &	configuration,
		std::string const &	key,
		ConfigurationSetting::AttributeList const &	attrs
	)			[inline, virtual]

This is called at the beginning of each section.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	key	The section name
	attrs	The attributes of the section

Returns:

true if writing should continue, false otherwise

Reimplemented in PWToolBox::Configuration::INIConfigurationWriter, and PWToolBox::Configuration::XMLConfigurationWriter.

virtual bool PWToolBox::Configuration::ConfigurationWriter::_writeSettingBegin	(	ConfigurationSection const &	configuration,
		std::string const &	key,
		ConfigurationSetting::AttributeList const &	attrs
	)			[inline, virtual]

This is called at the beginning of each setting.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	key	The setting name
	attrs	The attributes of the section

Returns:

true if writing should continue, false otherwise

Reimplemented in PWToolBox::Configuration::INIConfigurationWriter, and PWToolBox::Configuration::XMLConfigurationWriter.

virtual bool PWToolBox::Configuration::ConfigurationWriter::_writeData	(	ConfigurationSection const &	configuration,
		std::string const &	data
	)			[inline, virtual]

This is called when writing the data.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	data	The data to write

Returns:

true if writing should continue, false otherwise

Reimplemented in PWToolBox::Configuration::INIConfigurationWriter, and PWToolBox::Configuration::XMLConfigurationWriter.

virtual bool PWToolBox::Configuration::ConfigurationWriter::_writeSectionEnd	(	ConfigurationSection const &	configuration,
		std::string const &	key
	)			[inline, virtual]

This is called at the end of each section.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	key	The section name

Returns:

true if writing should continue, false otherwise

Reimplemented in PWToolBox::Configuration::INIConfigurationWriter, and PWToolBox::Configuration::XMLConfigurationWriter.

virtual bool PWToolBox::Configuration::ConfigurationWriter::_writeSettingEnd	(	ConfigurationSection const &	configuration,
		std::string const &	key
	)			[inline, virtual]

This is called at the end of each setting.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	key	The setting name

Returns:

true if writing should continue, false otherwise

Reimplemented in PWToolBox::Configuration::INIConfigurationWriter, and PWToolBox::Configuration::XMLConfigurationWriter.

virtual void PWToolBox::Configuration::ConfigurationWriter::_writeComment	(	ConfigurationSection const &	configuration,
		std::string const &	comment
	)			[inline, virtual]

This is called for each comment.

This function is not supported yet

Parameters:

	configuration	The ConfigurationSection being written
	comment	The comment being written

Reimplemented in PWToolBox::Configuration::INIConfigurationWriter, and PWToolBox::Configuration::XMLConfigurationWriter.

void PWToolBox::Configuration::ConfigurationWriter::writeSection

(

ConfigurationSection const &

configuration

)

[protected]

Recursively writes the sections and settings of configuration.

Parameters:

configuration

The ConfigurationSection being written

---

Member Data Documentation

std::ostream& PWToolBox::Configuration::ConfigurationWriter::m_outputStream [protected]

The stream to write to.

---

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

• ConfigurationWriter.h

---