MyMtlParameterDbWriter Class Reference

Inheritance diagram for MyMtlParameterDbWriter:

Public Member Functions
	MyMtlParameterDbWriter ()
	default constructor
virtual	~MyMtlParameterDbWriter ()
	destructor
void	setSaveHeaderOnSave (bool)
bool	saveHeaderOnSave () const
void	setCommentInformation (const std::string &, const DtReaderWriterCommentMap &)
Public Member Functions inherited from DtMtlParameterDbWriter
	DtMtlParameterDbWriter ()
	default constructor
virtual	~DtMtlParameterDbWriter ()
	destructor
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	setForceSave (bool b)
static bool	forceSave ()
Static Public Member Functions inherited from DtMtlParameterDbWriter
static void	prePutSelfCb (DtReaderWriter *readerWriterObject, FILE *fp, void *userData)
	Callback invoked before DtReaderWriter::putSelf() is called.

Protected Member Functions
virtual bool	write (DtMtlParameterDb *parameterDb, const DtFilename &parameterDbFile, const DtFilename &opeDirectory)
	Override to only write out changed entries.
virtual bool	writeTopLevelParameterDbFile (const DtMtlParameterDbFileData &parameterFileData, const DtFilename &parameterDbFile) const
	Override to no-op.
virtual void	processPrePutSelfCb (DtReaderWriter *readerWriterObject, FILE *fp)
virtual void	preWrite (const DtMtlParameterDbFileData &, const DtFilename &, FILE *) const
	Called immediately before writing the main body of the file (from writeTopLevelParameterDb() call)
virtual void	writeEntry (DtMtlParameterDbFileData *, DtMtlParameterDbEntry *, const DtFilename &, const DtFilename &)
	Writes out a single parameter entry and returns the entry in the parameterDbFile data structure added.
virtual DtFilename	generateOpeDirectory (const DtFilename &parameterDbFile, const DtFilename &opeDirectory)
	Returns an ope directory combined of the two supplied directories.
virtual void	removeAllParametersNamed (DtReaderWriterRegistry &reg, const char *name)
virtual void	removeAllParametersNamed (const DtComponentDescriptorList &lst, const char *name)
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	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	postWrite (const DtMtlParameterDbFileData &, const DtFilename &, FILE *) const
	Called immediately after writing the main body of the file (from writeTopLevelParameterDb() call)

Protected Attributes
DtReaderWriterCommentMap	myFileCommentMap
DtReaderWriterCommentMap	myObjectCommentMap
std::string	myFileComment
bool	mySaveHeaderOnSave
Protected Attributes inherited from DtMtlParameterDbWriter
DtFilename	myOpeDirectory

Static Protected Attributes
static bool	theForceFlag

Private Member Functions
	MyMtlParameterDbWriter (const MyMtlParameterDbWriter &orig)
	copy constructor - not implemented
MyMtlParameterDbWriter &	operator= (const MyMtlParameterDbWriter &orig)
	assignment operator - not implemented

Constructor & Destructor Documentation

MyMtlParameterDbWriter::MyMtlParameterDbWriter

(

)

default constructor

virtual MyMtlParameterDbWriter::~MyMtlParameterDbWriter ( )

virtual

destructor

MyMtlParameterDbWriter::MyMtlParameterDbWriter ( const MyMtlParameterDbWriter &  orig )

private

copy constructor - not implemented

Member Function Documentation

void MyMtlParameterDbWriter::setSaveHeaderOnSave ( bool  b )

inline

References mySaveHeaderOnSave.

bool MyMtlParameterDbWriter::saveHeaderOnSave ( ) const

inline

References mySaveHeaderOnSave.

void MyMtlParameterDbWriter::setCommentInformation ( const std::string &  f, const DtReaderWriterCommentMap &  c  )

inline

References myFileComment, and myFileCommentMap.

static void MyMtlParameterDbWriter::setForceSave ( bool  b )

inlinestatic

static bool MyMtlParameterDbWriter::forceSave ( )

inlinestatic

virtual bool MyMtlParameterDbWriter::write ( DtMtlParameterDb *  parameterDb, const DtFilename &  parameterDbFile, const DtFilename &  opeDirectory  )

protectedvirtual

Override to only write out changed entries.

Reimplemented from DtMtlParameterDbWriter.

virtual bool MyMtlParameterDbWriter::writeTopLevelParameterDbFile ( const DtMtlParameterDbFileData &  parameterFileData, const DtFilename &  parameterDbFile  ) const

protectedvirtual

Override to no-op.

Reimplemented from DtMtlParameterDbWriter.

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

protectedvirtual

Reimplemented from DtMtlParameterDbWriter.

virtual void MyMtlParameterDbWriter::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 MyMtlParameterDbWriter::writeEntry ( DtMtlParameterDbFileData *  parameterDb, DtMtlParameterDbEntry *  paramDbEntry, const DtFilename &  parameterDbFile, const DtFilename &  opeDirectory  )

protectedvirtual

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

Reimplemented from DtMtlParameterDbWriter.

virtual DtFilename MyMtlParameterDbWriter::generateOpeDirectory ( const DtFilename &  parameterDbFile, const DtFilename &  opeDirectory  )

protectedvirtual

Returns an ope directory combined of the two supplied directories.

Reimplemented from DtMtlParameterDbWriter.

virtual void MyMtlParameterDbWriter::removeAllParametersNamed ( DtReaderWriterRegistry &  reg, const char *  name  )

protectedvirtual

virtual void MyMtlParameterDbWriter::removeAllParametersNamed ( const DtComponentDescriptorList &  lst, const char *  name  )

protectedvirtual

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

private

assignment operator - not implemented

Member Data Documentation

DtReaderWriterCommentMap MyMtlParameterDbWriter::myFileCommentMap

protected

Referenced by setCommentInformation().

DtReaderWriterCommentMap MyMtlParameterDbWriter::myObjectCommentMap

protected

std::string MyMtlParameterDbWriter::myFileComment

protected

Referenced by setCommentInformation().

bool MyMtlParameterDbWriter::mySaveHeaderOnSave

protected

Referenced by saveHeaderOnSave(), and setSaveHeaderOnSave().

bool MyMtlParameterDbWriter::theForceFlag

staticprotected

---

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

• include/entityEditorImpl/myMtlParamDbWriter.h