code::XMLDataEncoder Class Reference

Inheritance diagram for code::XMLDataEncoder:

List of all members.

---

Detailed Description

Wraps up the XMLEncoder class to act as a DataEncoder.

Author:

Lakshman

Version:

Id

code_XMLDataEncoder.h,v 1.3 2009/06/02 20:17:38 lakshman Exp

Public Member Functions
virtual	~XMLDataEncoder ()
Static Public Member Functions
static void	introduceSelf ()
static std::string	writeData (const DataType &dt, const std::string &outputDir, std::vector< Index::Record > &records)
	Chooses the correct data encoder for the particular data type, writes out the product, and appends the records to the given vector.
static std::string	writeData (const DataType &dt, const std::string &outputDir, const std::string &subtype, std::vector< Index::Record > &records)
	Chooses the correct data encoder for the particular data type, writes out the product, and appends the records to the given vector.
static std::string	writeData (const DataType &dt, const std::string &outputDir, IndexRecordNotifier &notifier)
	Chooses the correct data encoder for the particular data type, writes out the product, and notifies about the resulting record(s).
static std::string	writeData (const DataType &dt, const std::string &outputDir, const std::string &subtype, IndexRecordNotifier &notifier)
	Chooses the correct data encoder for the particular data type, writes out the product, and notifies about the resulting record(s).
static SmartPtr< DataFormatSettings >	getSetting (const std::string &datatype)
Protected Member Functions
virtual std::string	encode (const code::DataType &dt, std::vector< Index::Record > &records)
	Write out this product and append the Index::Record(s) for it into the resulting vector.
virtual std::string	encode (const code::DataType &dt, const std::string &subtype, std::vector< Index::Record > &records)
	Write out this product and append the Index::Record(s) for it (but use the specified subtype string) into the resulting vector.
virtual SmartPtr< DataEncoder >	createDataEncoder (const std::string &outputDir, bool compress, bool subdirs) const
	Create an encoder to write to this directory with these settings.
virtual void	applySettings (const std::map< std::string, std::string > &settings)
	Forward any extra settings specific to encoder from XML file.

---

Constructor & Destructor Documentation

virtual code::XMLDataEncoder::~XMLDataEncoder

(

)

[inline, virtual]

---

Member Function Documentation

virtual void code::DataEncoder::applySettings

(

const std::map< std::string, std::string > &

settings

)

[inline, protected, virtual, inherited]

Forward any extra settings specific to encoder from XML file.

Reimplemented in code::NetcdfDataEncoder.

virtual SmartPtr<DataEncoder> code::XMLDataEncoder::createDataEncoder	(	const std::string &	outputDir,
		bool	compress,
		bool	subdirs
	)			const [protected, virtual]

Create an encoder to write to this directory with these settings.

Implements code::DataEncoder.

virtual std::string code::XMLDataEncoder::encode	(	const code::DataType &	dt,
		const std::string &	subtype,
		std::vector< Index::Record > &	records
	)			[protected, virtual]

Write out this product and append the Index::Record(s) for it (but use the specified subtype string) into the resulting vector.

No record will be appended if there was a problem.

Implements code::DataEncoder.

virtual std::string code::XMLDataEncoder::encode	(	const code::DataType &	dt,
		std::vector< Index::Record > &	records
	)			[protected, virtual]

Write out this product and append the Index::Record(s) for it into the resulting vector.

No record will be appended if there was a problem.

Implements code::DataEncoder.

static SmartPtr<DataFormatSettings> code::DataEncoder::getSetting

(

const std::string &

datatype

)

[static, inherited]

static void code::XMLDataEncoder::introduceSelf

(

)

[static]

static std::string code::DataEncoder::writeData	(	const DataType &	dt,
		const std::string &	outputDir,
		const std::string &	subtype,
		IndexRecordNotifier &	notifier
	)			[static, inherited]

Chooses the correct data encoder for the particular data type, writes out the product, and notifies about the resulting record(s).

Returns:

filename (empty if error)

static std::string code::DataEncoder::writeData	(	const DataType &	dt,
		const std::string &	outputDir,
		IndexRecordNotifier &	notifier
	)			[static, inherited]

Chooses the correct data encoder for the particular data type, writes out the product, and notifies about the resulting record(s).

Returns:

filename (empty if error)

static std::string code::DataEncoder::writeData	(	const DataType &	dt,
		const std::string &	outputDir,
		const std::string &	subtype,
		std::vector< Index::Record > &	records
	)			[static, inherited]

Chooses the correct data encoder for the particular data type, writes out the product, and appends the records to the given vector.

The records all have the specified sub-type.

Returns:

filename (empty if error)

static std::string code::DataEncoder::writeData	(	const DataType &	dt,
		const std::string &	outputDir,
		std::vector< Index::Record > &	records
	)			[static, inherited]

Chooses the correct data encoder for the particular data type, writes out the product, and appends the records to the given vector.

Returns:

filename (empty if error)

---