DtMtlParameterDbWriter Class Reference

class DtMtlParameterDbWriter: More...

Inheritance diagram for DtMtlParameterDbWriter:

List of all members.

Public Member Functions
	DtMtlParameterDbWriter ()
	default constructor
virtual	~DtMtlParameterDbWriter ()
	destructor
virtual bool	write (DtMtlParameterDb *parameterDb, const DtFilename &opdFilename, const DtFilename &opeDirectory=DtFilename::nullFilename())
	Write MTL format parameter database to given opdFilename.
virtual DtFilename	generateFilename (const DtString &rdrWriterName, const DtObjectType &objectType) const
	Generates an object parameter entry file (*.ope) filename from a string and an object type (used to auto-generate filenames when converting existing single file format parameter databases).
Static Public Member Functions
static void	prePutSelfCb (DtReaderWriter *readerWriterObject, FILE *fp, void *userData)
	Callback invoked before DtReaderWriter::putSelf() is called.
Protected Member Functions
virtual DtMtlParameterDbFileData *	createParameterDbFileData ()
	Factory method that creates a the DtReaderWriter data object written to the parameter database file in write().
virtual bool	writeTopLevelParameterDbFile (const DtMtlParameterDbFileData &parameterFileData, const DtFilename &parameterDbFile) const
	Writes the top level parameter database object (the DtReaderWriter contents of the parameter database file).
virtual bool	writeParameterFile (const DtFilename &parameterFilename, DtVrfObjectParameters *parameters) const
	Writes object parameter entry file.
virtual void	processPrePutSelfCb (DtReaderWriter *readerWriterObject, FILE *fp)
virtual DtFilename	getPath (const DtFilename &newFormatParamDbFile)
	Utility function for obtaining path from a filename.
virtual void	writeEntry (DtMtlParameterDbFileData *parameterDb, DtMtlParameterDbEntry *paramDbEntry, const DtFilename &parameterDbFile, const DtFilename &opeDirectory)
	Writes out a single parameter entry and returns the entry in the parameterDbFile data structure added.
virtual void	preWrite (const DtMtlParameterDbFileData &, const DtFilename &, FILE *) const
	Called immediately before writing the main body of the file (from writeTopLevelParameterDb() call)
virtual void	postWrite (const DtMtlParameterDbFileData &, const DtFilename &, FILE *) const
	Called immediately after writing the main body of the file (from writeTopLevelParameterDb() call)
virtual DtFilename	generateOpeDirectory (const DtFilename &parameterDbFile, const DtFilename &opeDirectory)
	Returns an ope directory combined of the two supplied directories.
Protected Attributes
DtFilename	myOpeDirectory
Private Member Functions
	DtMtlParameterDbWriter (const DtMtlParameterDbWriter &orig)
	copy constructor - not implemented
DtMtlParameterDbWriter &	operator= (const DtMtlParameterDbWriter &orig)
	assignment operator - not implemented

---

Detailed Description

class DtMtlParameterDbWriter:

Instances of DtMtlParameterDbWriter are used to save DtMtlParameterDb parameter database objects to file in MTL format (DtReaderWriter) format.

---

Constructor & Destructor Documentation

DtMtlParameterDbWriter::DtMtlParameterDbWriter

(

)

default constructor

virtual DtMtlParameterDbWriter::~DtMtlParameterDbWriter

(

)

[virtual]

destructor

DtMtlParameterDbWriter::DtMtlParameterDbWriter

(

const DtMtlParameterDbWriter &

orig

)

[private]

copy constructor - not implemented

---

Member Function Documentation

virtual bool DtMtlParameterDbWriter::write	(	DtMtlParameterDb *	parameterDb,
		const DtFilename &	opdFilename,
		const DtFilename &	opeDirectory = DtFilename::nullFilename()
	)		[virtual]

Write MTL format parameter database to given opdFilename.

If opdFilename does not have a .opd extension, it adds the extension. opeDirectory is a directory to write individual parameter entry files (*.ope). If no directory is specified, creates a directory with the same path as the opdFilename, and with the same name as the opdFilename, minus the .opd extensions.

Reimplemented in MyMtlParameterDbWriter.

static void DtMtlParameterDbWriter::prePutSelfCb	(	DtReaderWriter *	readerWriterObject,
		FILE *	fp,
		void *	userData
	)		[static]

Callback invoked before DtReaderWriter::putSelf() is called.

Uses DtReaderWriterCommentMap to look up comments associated with DtReaderWriter object. If one exists, writes out comment to file. (Comment assoicated with symbol will appear immediately before it in the file.)

virtual DtFilename DtMtlParameterDbWriter::generateFilename	(	const DtString &	rdrWriterName,
		const DtObjectType &	objectType
	)		const [virtual]

Generates an object parameter entry file (*.ope) filename from a string and an object type (used to auto-generate filenames when converting existing single file format parameter databases).

virtual DtMtlParameterDbFileData* DtMtlParameterDbWriter::createParameterDbFileData

(

)

[protected, virtual]

Factory method that creates a the DtReaderWriter data object written to the parameter database file in write().

virtual bool DtMtlParameterDbWriter::writeTopLevelParameterDbFile	(	const DtMtlParameterDbFileData &	parameterFileData,
		const DtFilename &	parameterDbFile
	)		const [protected, virtual]

Writes the top level parameter database object (the DtReaderWriter contents of the parameter database file).

Reimplemented in MyMtlParameterDbWriter.

virtual bool DtMtlParameterDbWriter::writeParameterFile	(	const DtFilename &	parameterFilename,
		DtVrfObjectParameters *	parameters
	)		const [protected, virtual]

Writes object parameter entry file.

virtual void DtMtlParameterDbWriter::processPrePutSelfCb	(	DtReaderWriter *	readerWriterObject,
		FILE *	fp
	)		[protected, virtual]

Reimplemented in MyMtlParameterDbWriter, and DtExtMtlParameterDbWriter.

virtual DtFilename DtMtlParameterDbWriter::getPath

(

const DtFilename &

newFormatParamDbFile

)

[protected, virtual]

Utility function for obtaining path from a filename.

virtual void DtMtlParameterDbWriter::writeEntry	(	DtMtlParameterDbFileData *	parameterDb,
		DtMtlParameterDbEntry *	paramDbEntry,
		const DtFilename &	parameterDbFile,
		const DtFilename &	opeDirectory
	)		[protected, virtual]

Writes out a single parameter entry and returns the entry in the parameterDbFile data structure added.

Reimplemented in MyMtlParameterDbWriter.

virtual void DtMtlParameterDbWriter::preWrite	(	const DtMtlParameterDbFileData &	,
		const DtFilename &	,
		FILE *
	)		const [protected, virtual]

Called immediately before writing the main body of the file (from writeTopLevelParameterDb() call)

Reimplemented in MyMtlParameterDbWriter, and DtExtMtlParameterDbWriter.

virtual void DtMtlParameterDbWriter::postWrite	(	const DtMtlParameterDbFileData &	,
		const DtFilename &	,
		FILE *
	)		const [protected, virtual]

Called immediately after writing the main body of the file (from writeTopLevelParameterDb() call)

virtual DtFilename DtMtlParameterDbWriter::generateOpeDirectory	(	const DtFilename &	parameterDbFile,
		const DtFilename &	opeDirectory
	)		[protected, virtual]

Returns an ope directory combined of the two supplied directories.

Reimplemented in MyMtlParameterDbWriter.

DtMtlParameterDbWriter& DtMtlParameterDbWriter::operator=

(

const DtMtlParameterDbWriter &

orig

)

[private]

assignment operator - not implemented

---

Member Data Documentation

DtFilename DtMtlParameterDbWriter::myOpeDirectory [protected]

---

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

• include/vrfobjparam/mtlParamDbWriter.h