Inheritance diagram for DtExtMtlParameterDb:

Public Member Functions
	DtExtMtlParameterDb ()
virtual	~DtExtMtlParameterDb ()
virtual bool	save (const DtFilename &filename)
	Saves contents of parameter database to file.
Public Member Functions inherited from DtMtlParameterDb
	DtMtlParameterDb ()
	default constructor
virtual	~DtMtlParameterDb ()
	destructor
virtual bool	init ()
	Initialization - must be called before any other public member functions are called.
virtual DtMtlParameterDbEntry *	add (const DtObjectType &objectType, const DtFilename &filename, DtVrfObjectParameters *newParameters=NULL)
	Add a new entry to the parameter database, keyed on DtObjectType.
virtual void	createRemoteConfigurationList ()
	discard existing pMyRemoteConfigurationList and recreate using myRemoteConfigListCreatorFcn This is called from init();
virtual DtVrfObjectParameters *	lookup (const DtObjectType &objectType, DtObjectType matchingType, DtString source=NULL) const
	Lookup entry in parameter database that most closely matches given objectType.
virtual bool	load (const DtFilename &filename)
	Loads the contents of an MTL parameter database file (*.opd).
virtual bool	loadAll (const DtFilename &filename)
	Loads MTL parameter database file and loads all .ope files it references.
DtRemoteConfigurationList *	remoteConfigurationList ()
const DtRemoteConfigurationList *	remoteConfigurationList () const
DtRemoteConfigurationList::CreatorFcn	remoteConfigurationListCreatorFcn ()
void	setRemoteConfigurationListCreatorFcn (DtRemoteConfigurationList::CreatorFcn fcn)
virtual void	removeAll ()
	Overridden to clear out the variable bindings.
virtual void	setVersionNumber (int versionNumber)
	Version number of parameter database.
virtual int	versionNumber () const
virtual void	addDependentParameterFileToCopyPair (const DtFilename &fromFilename, const DtFilename &toFilename)
	Dependent parameter files (.asl, .hit, .frm, .det, .dmg) to copy upon save.
virtual void	clearDependentParameterFileToCopyPairs ()
virtual const std::map < std::string, std::string > &	dependentParameterFileToCopyPairs () const
virtual void	updateReaderWriterFilePaths (DtVrfObjectParameters &parameters)
	Updates paths to use relative-to-container convention for filenames in given parameters object.
DtMtlParameterDbReader *	dbReader ()
DtMtlParameterDbWriter *	dbWriter ()
virtual DtFilename	stripExtension (const DtFilename &filename, const DtString &extension)
	Strips the extension (the trailing portion of a filename starting with ".") from a given filename.
virtual void	setReader (DtMtlParameterDbReader *)
	Sets the reader, deleting old reader. Takes ownership of reader.
virtual void	setWriter (DtMtlParameterDbWriter *)
	Sets the writer, deleting old writer. Takes ownership of writer.
virtual void	addVariableBindings (DtVariableBindingsSharedPtr bindings)
	Returns filename loaded.
virtual std::list < DtVariableBindingsSharedPtr > &	variableBindings ()
	Returns filename loaded.
Public Member Functions inherited from DtVrfParameterDb
	DtVrfParameterDb ()
	default constructor
virtual	~DtVrfParameterDb ()
	destructor
virtual DtVrfParameterDbEntry *	add (const DtObjectType &objectType, DtVrfObjectParameters *parameters)
	Add a new parameter entry to database.
virtual void	remove (const DtObjectType &objectType)
	Remove the entry for the given object type from the database.
virtual const DtList &	parameterList () const
	List of all DtVrfParameterDbEntry* items in the database.
virtual void	addParameters (const DtObjectType &objectType, DtVrfObjectParameters *newParameters)
virtual DtVrfObjectParameters *	lookupParameters (const DtObjectType &objectType, DtObjectType *matchingType) const
virtual void	removeParameters (const DtObjectType &objectType)
virtual void	removeAndDeleteAll ()
virtual DtVrfParameterDbEntry *	lookupParameterDbEntry (const DtObjectType &objectType, DtObjectType *matchingType) const
	Returns entry most closely matching given object type.
virtual int	numParameterEntries () const
	Returns the number of parameter entries.
virtual std::list< DtString > *	getSysDefExtensionList ()
	Get the list of sysdef extensions currently accepted.
virtual void	addExtension (DtString)
	Add a new extension to the back of the line.

Protected Member Functions
virtual DtVrfParameterDbEntry *	createParameterEntry () const
	Override to create entry of type DtMtlParameterDbEntry.
virtual DtMtlParameterDbReader *	createParamDbReader ()
	Factory method that creates parameter database reader object used in load().
virtual DtMtlParameterDbWriter *	createMtlParamDbWriter ()
	Factory method that creates parameter database writer object used in save().
	DtExtMtlParameterDb (const DtExtMtlParameterDb &orig)
DtExtMtlParameterDb &	operator= (const DtExtMtlParameterDb &orig)
Protected Member Functions inherited from DtMtlParameterDb
virtual bool	copyDependentParameterDirectories (const DtFilename &oldPath, const DtFilename &newPath)
	Copies ammoselect, damage, detection, and hit subdirectories from oldPath location to newPath location.
virtual DtFilename	getPath (const DtFilename &filename)
	Extracts path from a given filename.
virtual DtVrfObjectParameters *	getParameters (DtMtlParameterDbEntry *entry) const
	Retrieves the parameters from a given parameter entry object.
Protected Member Functions inherited from DtVrfParameterDb
virtual void	addParameterDbEntry (DtVrfParameterDbEntry *newParameterEntry)
	Add news item to database.
virtual DtListItem *	lookupParameters (const DtObjectType &objectType) const
	Returns DtListItem (containing DtVrfParameterDbEntry*) for given object type.
void	emptyList ()
	Empties contents of database, deleting memory associated with each entry.

Additional Inherited Members
Static Public Member Functions inherited from DtMtlParameterDb
static DtVrfParameterDb *	create ()
	Returns a new instance of this class.
static const DtString &	opdFilenameExtension ()
	Default filename extension for parameter database file (.opd).
static const DtString &	opeFilenameExtension ()
	Default filename extension for parameter database entry files (.ope).
Static Protected Member Functions inherited from DtMtlParameterDb
static const std::map < DtString, DtFilename > &	extensionToPathMap ()
	Map of filename extensions of dependent parameter files (.dmg, .hit, .asl, .frm, .det) to corrsponding directory paths (.
Protected Attributes inherited from DtMtlParameterDb
DtMtlParameterDbReader *	myParameterDbReader
DtMtlParameterDbWriter *	myParameterDbWriter
int	myVersionNumber
DtVariableBindingsList	myVariableBindings
std::map< std::string, std::string >	myDependentParameterFileToCopyPairs
std::list < DtVariableBindingsSharedPtr >	myVariableBindingsList
	List of all top level variable bindings for each OPD file read in.
DtRemoteConfigurationList *	pMyRemoteConfigurationList
	List of DtRemoteConfigurationEntry* objects.
DtRemoteConfigurationList::CreatorFcn	myRemoteConfigListCreatorFcn
Static Protected Attributes inherited from DtMtlParameterDb
static DtString	theOpdFilenameExtension
static DtString	theOpeFilenameExtension
static DtFilename	theOldParameterDbDirectory
static std::map< DtString, DtFilename > *	theExtensionToPathMap

Constructor & Destructor Documentation

DtExtMtlParameterDb::DtExtMtlParameterDb ( )

virtual DtExtMtlParameterDb::~DtExtMtlParameterDb ( )

virtual

DtExtMtlParameterDb::DtExtMtlParameterDb ( const DtExtMtlParameterDb & orig )

protected

Member Function Documentation

virtual bool DtExtMtlParameterDb::save ( const DtFilename & filename )

virtual

Saves contents of parameter database to file.

Filename will be given .opd file extension if it does not already exist. Creates subdirectory of the same name minus the .opd extension and places individual object parameter entry files (.ope) for each entry in the database. Object parameter database file will contain list of filenames referencing individual .ope files.

Reimplemented from DtMtlParameterDb.

virtual DtVrfParameterDbEntry* DtExtMtlParameterDb::createParameterEntry ( ) const

protectedvirtual

Override to create entry of type DtMtlParameterDbEntry.

Reimplemented from DtMtlParameterDb.

virtual DtMtlParameterDbReader* DtExtMtlParameterDb::createParamDbReader ( )

protectedvirtual

Factory method that creates parameter database reader object used in load().

Creates an instance of DtMtlParameterDbReader.

Reimplemented from DtMtlParameterDb.

virtual DtMtlParameterDbWriter* DtExtMtlParameterDb::createMtlParamDbWriter ( )

protectedvirtual

Factory method that creates parameter database writer object used in save().

Creates an instance of DtMtlParameterDbWriter.

Reimplemented from DtMtlParameterDb.

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

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/examples/convertParamDb/extMtlParamDb.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation