DtExtMtlParameterDbWriter Class Reference

Inheritance diagram for DtExtMtlParameterDbWriter:

Public Member Functions
	DtExtMtlParameterDbWriter ()
virtual	~DtExtMtlParameterDbWriter ()
virtual void	setInitialComment (const std::string &comment)
virtual void	setReaderWriterCommentMap (const DtReaderWriterCommentMap *map)
Public Member Functions inherited from DtMtlParameterDbWriter
	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).

Protected Member Functions
virtual void	preWrite (const DtMtlParameterDbFileData &, const DtFilename &, FILE *) const
	Called immediately before writing the main body of the file (from writeTopLevelParameterDb() call)
virtual void	processPrePutSelfCb (DtReaderWriter *readerWriterObject, FILE *fp)
	DtExtMtlParameterDbWriter (const DtExtMtlParameterDbWriter &orig)
DtExtMtlParameterDbWriter &	operator= (const DtExtMtlParameterDbWriter &orig)
Protected Member Functions inherited from DtMtlParameterDbWriter
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 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	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
std::string	myInitialComment
const DtReaderWriterCommentMap *	myReaderWriterCommentMap
Protected Attributes inherited from DtMtlParameterDbWriter
DtFilename	myOpeDirectory

Additional Inherited Members
Static Public Member Functions inherited from DtMtlParameterDbWriter
static void	prePutSelfCb (DtReaderWriter *readerWriterObject, FILE *fp, void *userData)
	Callback invoked before DtReaderWriter::putSelf() is called.

Constructor & Destructor Documentation

DtExtMtlParameterDbWriter::DtExtMtlParameterDbWriter

(

)

virtual DtExtMtlParameterDbWriter::~DtExtMtlParameterDbWriter ( )

virtual

DtExtMtlParameterDbWriter::DtExtMtlParameterDbWriter ( const DtExtMtlParameterDbWriter &  orig )

protected

Member Function Documentation

virtual void DtExtMtlParameterDbWriter::setInitialComment ( const std::string &  comment )

virtual

virtual void DtExtMtlParameterDbWriter::setReaderWriterCommentMap ( const DtReaderWriterCommentMap *  map )

virtual

virtual void DtExtMtlParameterDbWriter::preWrite ( const DtMtlParameterDbFileData &  , const DtFilename &  , FILE *    ) const

protectedvirtual

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

Reimplemented from DtMtlParameterDbWriter.

virtual void DtExtMtlParameterDbWriter::processPrePutSelfCb ( DtReaderWriter *  readerWriterObject, FILE *  fp  )

protectedvirtual

Reimplemented from DtMtlParameterDbWriter.

DtExtMtlParameterDbWriter& DtExtMtlParameterDbWriter::operator= ( const DtExtMtlParameterDbWriter &  orig )

protected

Member Data Documentation

std::string DtExtMtlParameterDbWriter::myInitialComment

protected

const DtReaderWriterCommentMap* DtExtMtlParameterDbWriter::myReaderWriterCommentMap

protected

---

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

• examples/convertParamDb/extMtlParamDbWriter.h