class DtMtlParameterDbReader: More...

Public Member Functions
	DtMtlParameterDbReader ()
	default constructor
virtual	~DtMtlParameterDbReader ()
	destructor
virtual bool	loadParameterDb (const DtFilename &parameterDbFile, DtMtlParameterDb *parameterDb)
	Loads the given parameter database file.

Protected Member Functions
virtual DtMtlParameterDbFileData *	createParameterDbFileData ()
	Factory method that creates the DtMtlParameterDbFileData object used in loadParameterDb().
virtual bool	load (const DtFilename &parameterDbFile, DtMtlParameterDbFileData *paramDbFileData, DtFilename &dataPath)
	Load contents of parameter database file (.opd) into DtMtlParameterDbFileData object.
virtual bool	load (const DtFilename &parameterDbFile, DtVrfObjectParametersList *objectParamList)
	Load contents of legacy format parameter database file (pre-VR-Forces version 3.7 *.opd file) into DtVrfObjectParametersList object.
virtual bool	putFileDataInParameterDb (const DtMtlParameterDbFileData &paramDbFileData, const DtFilename &opdLocation, DtMtlParameterDb *parameterDb)
	Set contents of parameter database from DtMtlParameterDbFileData object.
virtual bool	putFileDataInParameterDb (const DtVrfObjectParametersList &objectParamList, DtMtlParameterDb *parameterDb)
	Set contents of parameter database from DtVrfObjectParametersList object.
virtual void	setFilenamePathsRelativeToFile (const DtFilename &parameterDbFile, DtMtlParameterDbFileData *paramDbFileData)
	Sets all of the filenames referenced in given parameter file to a path relative to to given filename.
virtual bool	readFileData (const DtFilename &, DtMtlParameterDbFileData , FILE , DtFilename &dataPath)
	dataPath is set to the directory where the data files can be found.
virtual void	entryAddedFor (DtMtlParameterDbFileEntry oldEntry, DtMtlParameterDbEntry newEntry)
	Called when an item is added to the database, this lets the developer know that a previous entry is being replaced by the new entry.

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

Detailed Description

class DtMtlParameterDbReader:

Instances of DtMtlParameterDbReader are used to load MTL format parameter database files (.opd) into a given DtMtlParameterDb object.

Constructor & Destructor Documentation

DtMtlParameterDbReader::DtMtlParameterDbReader ( )

default constructor

virtual DtMtlParameterDbReader::~DtMtlParameterDbReader ( )

virtual

destructor

DtMtlParameterDbReader::DtMtlParameterDbReader ( const DtMtlParameterDbReader & orig )

private

copy constructor - not implemented

Member Function Documentation

virtual bool DtMtlParameterDbReader::loadParameterDb	(	const DtFilename &	parameterDbFile,
		DtMtlParameterDb *	parameterDb
	)

virtual

Loads the given parameter database file.

virtual DtMtlParameterDbFileData* DtMtlParameterDbReader::createParameterDbFileData ( )

protectedvirtual

Factory method that creates the DtMtlParameterDbFileData object used in loadParameterDb().

virtual bool DtMtlParameterDbReader::load	(	const DtFilename &	parameterDbFile,
		DtMtlParameterDbFileData *	paramDbFileData,
		DtFilename &	dataPath
	)

protectedvirtual

Load contents of parameter database file (.opd) into DtMtlParameterDbFileData object.

dataPath is set to the path where the data files can be found.

virtual bool DtMtlParameterDbReader::load	(	const DtFilename &	parameterDbFile,
		DtVrfObjectParametersList *	objectParamList
	)

protectedvirtual

Load contents of legacy format parameter database file (pre-VR-Forces version 3.7 *.opd file) into DtVrfObjectParametersList object.

virtual bool DtMtlParameterDbReader::putFileDataInParameterDb	(	const DtMtlParameterDbFileData &	paramDbFileData,
		const DtFilename &	opdLocation,
		DtMtlParameterDb *	parameterDb
	)

protectedvirtual

Set contents of parameter database from DtMtlParameterDbFileData object.

opdLocation specifies the path to the opd file being loaded. This is used to know the start of the paths to the OPE entries inside the OPD.

virtual bool DtMtlParameterDbReader::putFileDataInParameterDb	(	const DtVrfObjectParametersList &	objectParamList,
		DtMtlParameterDb *	parameterDb
	)

protectedvirtual

Set contents of parameter database from DtVrfObjectParametersList object.

virtual void DtMtlParameterDbReader::setFilenamePathsRelativeToFile	(	const DtFilename &	parameterDbFile,
		DtMtlParameterDbFileData *	paramDbFileData
	)

protectedvirtual

Sets all of the filenames referenced in given parameter file to a path relative to to given filename.

virtual bool DtMtlParameterDbReader::readFileData	(	const DtFilename &	,
		DtMtlParameterDbFileData *	,
		FILE *	,
		DtFilename &	dataPath
	)

protectedvirtual

dataPath is set to the directory where the data files can be found.

virtual void DtMtlParameterDbReader::entryAddedFor	(	DtMtlParameterDbFileEntry *	oldEntry,
		DtMtlParameterDbEntry *	newEntry
	)

protectedvirtual

Called when an item is added to the database, this lets the developer know that a previous entry is being replaced by the new entry.

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

private

assignment operator - not implemented

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/mtlParameterDbReader.h

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation