DtMtlParameterDb Class Reference

Instances of DtMtlParameterDb are a database of DtVrfObjectParameters* entries that are loaded from an MTL (Mak Technologies Lisp) format file. More...

Inheritance diagram for DtMtlParameterDb:

Public Member Functions
	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 bool	save (const DtFilename &filename)
	Saves contents of parameter database to file.
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.
virtual DtReaderWriter::SearchPaths	searchPaths () const
	List of additional search paths from included SMSs.
virtual void	setSearchPaths (const DtReaderWriter::SearchPaths &searchPaths)
	List of additional search paths from included SMSs.
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.

Static Public Member Functions
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).

Protected Member Functions
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().
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.
virtual DtVrfParameterDbEntry *	createParameterEntry () const
	Override to create entry of type DtMtlParameterDbEntry.
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.

Static Protected Member Functions
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
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
DtReaderWriter::SearchPaths	mySearchPaths
	List of additional search paths from included SMSs.
Protected Attributes inherited from DtVrfParameterDb
DtList	myParameterList
	List of DtVrfParameterDbEntry* objects.

Static Protected Attributes
static DtString	theOpdFilenameExtension
static DtString	theOpeFilenameExtension
static DtFilename	theOldParameterDbDirectory
static std::map< DtString, DtFilename > *	theExtensionToPathMap

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

Detailed Description

Instances of DtMtlParameterDb are a database of DtVrfObjectParameters* entries that are loaded from an MTL (Mak Technologies Lisp) format file.

Constructor & Destructor Documentation

DtMtlParameterDb::DtMtlParameterDb

(

)

default constructor

virtual DtMtlParameterDb::~DtMtlParameterDb ( )

virtual

destructor

DtMtlParameterDb::DtMtlParameterDb ( const DtMtlParameterDb &  orig )

private

copy constructor - not implemented

Member Function Documentation

virtual bool DtMtlParameterDb::init ( )

virtual

Initialization - must be called before any other public member functions are called.

Reimplemented from DtVrfParameterDb.

virtual DtMtlParameterDbEntry* DtMtlParameterDb::add ( const DtObjectType &  objectType, const DtFilename &  filename, DtVrfObjectParameters *  newParameters = NULL  )

virtual

Add a new entry to the parameter database, keyed on DtObjectType.

If an entry with the exact object type already exists, then it will be removed and deleted before the new one is added. filename is the name of a object parameter entry file (*.ope), which is a MTL file containing the data representing a single DtVrfObjectParameter entry.

virtual void DtMtlParameterDb::createRemoteConfigurationList ( )

virtual

discard existing pMyRemoteConfigurationList and recreate using myRemoteConfigListCreatorFcn This is called from init();

virtual DtVrfObjectParameters* DtMtlParameterDb::lookup ( const DtObjectType &  objectType, DtObjectType *  matchingType, DtString *  source = NULL  ) const

virtual

Lookup entry in parameter database that most closely matches given objectType.

If matchingType is specified, return the object type of the entry (which may be less specific than the object type being looked up). Loads the object parameter entry from given filename, if corresponding data for the entry has not yet been loaded. If source is specified, it will be set to the filename of the OPE file loaded for these parameters.

Reimplemented from DtVrfParameterDb.

virtual bool DtMtlParameterDb::load ( const DtFilename &  filename )

virtual

Loads the contents of an MTL parameter database file (*.opd).

Reimplemented from DtVrfParameterDb.

virtual bool DtMtlParameterDb::loadAll ( const DtFilename &  filename )

virtual

Loads MTL parameter database file and loads all .ope files it references.

DtRemoteConfigurationList * DtMtlParameterDb::remoteConfigurationList ( )

inline

References pMyRemoteConfigurationList.

const DtRemoteConfigurationList * DtMtlParameterDb::remoteConfigurationList ( ) const

inline

References pMyRemoteConfigurationList.

DtRemoteConfigurationList::CreatorFcn DtMtlParameterDb::remoteConfigurationListCreatorFcn ( )

inline

References myRemoteConfigListCreatorFcn.

void DtMtlParameterDb::setRemoteConfigurationListCreatorFcn ( DtRemoteConfigurationList::CreatorFcn  fcn )

inline

References myRemoteConfigListCreatorFcn.

virtual bool DtMtlParameterDb::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 DtVrfParameterDb.

virtual void DtMtlParameterDb::removeAll ( )

virtual

Overridden to clear out the variable bindings.

Reimplemented from DtVrfParameterDb.

virtual void DtMtlParameterDb::setVersionNumber ( int  versionNumber )

virtual

Version number of parameter database.

Version number is stored in parameter databse file as of VR-Forces version 3.7. See CURRENT_PARAMETER_DB_FILE_FORMAT_VERSION at top of this file for latest version number.

virtual int DtMtlParameterDb::versionNumber ( ) const

virtual

virtual void DtMtlParameterDb::addDependentParameterFileToCopyPair ( const DtFilename &  fromFilename, const DtFilename &  toFilename  )

virtual

Dependent parameter files (.asl, .hit, .frm, .det, .dmg) to copy upon save.

These files are cached when a parameter database is loaded. Only the DtMtlParamDbReader and DtMtlParamDbWriter classes should need to call any of these functions.

virtual void DtMtlParameterDb::clearDependentParameterFileToCopyPairs ( )

virtual

virtual const std::map<std::string, std::string>& DtMtlParameterDb::dependentParameterFileToCopyPairs ( ) const

virtual

virtual void DtMtlParameterDb::updateReaderWriterFilePaths ( DtVrfObjectParameters &  parameters )

virtual

Updates paths to use relative-to-container convention for filenames in given parameters object.

Stores old/new parameter filenames in parameterDb, so if/when we go to write out the parameter database, it can find all of the files it need (to copy to the new path).

DtMtlParameterDbReader * DtMtlParameterDb::dbReader ( )

inline

References myParameterDbReader.

DtMtlParameterDbWriter * DtMtlParameterDb::dbWriter ( )

inline

References myParameterDbWriter.

virtual DtFilename DtMtlParameterDb::stripExtension ( const DtFilename &  filename, const DtString &  extension  )

virtual

Strips the extension (the trailing portion of a filename starting with ".") from a given filename.

virtual void DtMtlParameterDb::addVariableBindings ( DtVariableBindingsSharedPtr  bindings )

virtual

Returns filename loaded.

See Also

myVariableBindingsList

virtual std::list<DtVariableBindingsSharedPtr>& DtMtlParameterDb::variableBindings ( )

virtual

Returns filename loaded.

See Also

myVariableBindingsList

static DtVrfParameterDb* DtMtlParameterDb::create ( )

static

Returns a new instance of this class.

Reimplemented from DtVrfParameterDb.

static const DtString& DtMtlParameterDb::opdFilenameExtension ( )

static

Default filename extension for parameter database file (.opd).

static const DtString& DtMtlParameterDb::opeFilenameExtension ( )

static

Default filename extension for parameter database entry files (.ope).

virtual void DtMtlParameterDb::setReader ( DtMtlParameterDbReader *  )

virtual

Sets the reader, deleting old reader. Takes ownership of reader.

virtual void DtMtlParameterDb::setWriter ( DtMtlParameterDbWriter *  )

virtual

Sets the writer, deleting old writer. Takes ownership of writer.

virtual DtReaderWriter::SearchPaths DtMtlParameterDb::searchPaths ( ) const

virtual

List of additional search paths from included SMSs.

virtual void DtMtlParameterDb::setSearchPaths ( const DtReaderWriter::SearchPaths &  searchPaths )

virtual

List of additional search paths from included SMSs.

virtual DtMtlParameterDbReader* DtMtlParameterDb::createParamDbReader ( )

protectedvirtual

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

Creates an instance of DtMtlParameterDbReader.

virtual DtMtlParameterDbWriter* DtMtlParameterDb::createMtlParamDbWriter ( )

protectedvirtual

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

Creates an instance of DtMtlParameterDbWriter.

virtual bool DtMtlParameterDb::copyDependentParameterDirectories ( const DtFilename &  oldPath, const DtFilename &  newPath  )

protectedvirtual

Copies ammoselect, damage, detection, and hit subdirectories from oldPath location to newPath location.

virtual DtFilename DtMtlParameterDb::getPath ( const DtFilename &  filename )

protectedvirtual

Extracts path from a given filename.

virtual DtVrfObjectParameters* DtMtlParameterDb::getParameters ( DtMtlParameterDbEntry *  entry ) const

protectedvirtual

Retrieves the parameters from a given parameter entry object.

If the parameters component of an entry is non-NULL, returns the parameters. If the parameters component of an entry is NULL, loads the parameters from the filename given in the entry, storing the parameters in the entry, and then returns the parameters.

virtual DtVrfParameterDbEntry* DtMtlParameterDb::createParameterEntry ( ) const

protectedvirtual

Override to create entry of type DtMtlParameterDbEntry.

Reimplemented from DtVrfParameterDb.

static const std::map<DtString, DtFilename>& DtMtlParameterDb::extensionToPathMap ( )

staticprotected

Map of filename extensions of dependent parameter files (.dmg, .hit, .asl, .frm, .det) to corrsponding directory paths (.

\damage, .\hit, .\ammoselect, .\formation, .\detection). Used in updating legacy format parameter database files that mapped these supporting files relative to the application path.

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

private

assignment operator - not implemented

Member Data Documentation

DtMtlParameterDbReader* DtMtlParameterDb::myParameterDbReader

protected

Referenced by dbReader().

DtMtlParameterDbWriter* DtMtlParameterDb::myParameterDbWriter

protected

Referenced by dbWriter().

DtString DtMtlParameterDb::theOpdFilenameExtension

staticprotected

DtString DtMtlParameterDb::theOpeFilenameExtension

staticprotected

DtFilename DtMtlParameterDb::theOldParameterDbDirectory

staticprotected

int DtMtlParameterDb::myVersionNumber

protected

DtVariableBindingsList DtMtlParameterDb::myVariableBindings

protected

std::map<std::string, std::string> DtMtlParameterDb::myDependentParameterFileToCopyPairs

protected

std::list<DtVariableBindingsSharedPtr> DtMtlParameterDb::myVariableBindingsList

protected

List of all top level variable bindings for each OPD file read in.

Additional OPD files read will add their bindings to the end if the list.

DtRemoteConfigurationList* DtMtlParameterDb::pMyRemoteConfigurationList

protected

List of DtRemoteConfigurationEntry* objects.

Referenced by remoteConfigurationList().

DtRemoteConfigurationList::CreatorFcn DtMtlParameterDb::myRemoteConfigListCreatorFcn

protected

Referenced by remoteConfigurationListCreatorFcn(), and setRemoteConfigurationListCreatorFcn().

DtReaderWriter::SearchPaths DtMtlParameterDb::mySearchPaths

protected

List of additional search paths from included SMSs.

std::map<DtString, DtFilename>* DtMtlParameterDb::theExtensionToPathMap

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfobjparam/mtlParameterDb.h