class DtMtlParameterDbReader:

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

Public Member Functions
	DtMtlParameterDbReader ()

virtual	~DtMtlParameterDbReader ()

virtual bool	loadParameterDb (const DtFilename &parameterDbFile, DtMtlParameterDb *parameterDb, bool preloadParameters=false)

Protected Member Functions
virtual DtMtlParameterDbFileData *	createParameterDbFileData ()

virtual bool	load (const DtFilename &parameterDbFile, DtMtlParameterDbFileData *paramDbFileData, DtFilename &dataPath, bool preloadParameters=false)

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

virtual bool	putFileDataInParameterDb (const DtMtlParameterDbFileData &paramDbFileData, const DtFilename &opdLocation, DtMtlParameterDb *parameterDb, bool preloadParameters=false)

virtual bool	putFileDataInParameterDb (const DtVrfObjectParametersList &objectParamList, DtMtlParameterDb *parameterDb, bool preloadParameters=false)

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

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

virtual void	entryAddedFor (DtMtlParameterDbFileEntry oldEntry, DtMtlParameterDbEntry newEntry)

Private Member Functions
	DtMtlParameterDbReader (const DtMtlParameterDbReader &orig)

DtMtlParameterDbReader &	operator= (const DtMtlParameterDbReader &orig)

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,
		bool	preloadParameters = `false`
	)

virtual

Loads the given parameter database file. If the preloadParameters value is true will load all the parameters found in the database from disk (versus waiting until it is needed)

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,
		bool	preloadParameters = `false`
	)

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,
		bool	preloadParameters = `false`
	)

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,
		bool	preloadParameters = `false`
	)

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/mtlParameterDbReader.h

Public Member Functions

Protected Member Functions

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation