DtMtlParameterDbEntry Class Reference

DtMtlParameterDbEntry; record in a DtMtlParameterDb. More...

Inheritance diagram for DtMtlParameterDbEntry:

Public Member Functions
	DtMtlParameterDbEntry ()
virtual	~DtMtlParameterDbEntry ()
	destructor More...
virtual DtVrfObjectParameters *	load ()
	Loads entry from disk. More...
virtual DtVrfObjectParameters *	loadFromFile (const DtFilename &filename)
virtual DtVrfObjectParameters *	readParameterEntry (FILE *fp, DtEnvironmentSP env, DtEnvValueSP objectNode)
virtual DtVrfObjectParameters *	loadParameters (DtlObjPtr arg, DtEnvironmentSP env, DtEnvValueSP objectNode)
virtual DtString	uniqueIdentifier () const
	Returns a string identifier that uniquely identifies this item. More...
virtual void	setPath (const DtFilename &path)
	Set the path to filename (will be concatenated with filename if filename is relative). More...
virtual const DtFilename &	path () const
virtual void	setVersion (int version)
	Set version number of parameter database file so we'll know where to set the search path for legacy parameter database files. More...
virtual void	setVariableBindings (const DtVariableBindingsSharedPtr &bindings)
virtual DtVariableBindingsSharedPtr	variableBindings ()
virtual void	setFilename (const DtFilename &filename)
	Filename of an object parameter entry file (*.ope) from which a DtVrfObjectParameter object can be loaded. More...
virtual const DtFilename &	filename ()
virtual DtReaderWriter::SearchPaths	searchPaths () const
	Additional search paths. More...
virtual void	setSearchPaths (const DtReaderWriter::SearchPaths &searchPaths)
Public Member Functions inherited from DtVrfParameterDbEntry
	DtVrfParameterDbEntry ()
	default constructor More...
virtual	~DtVrfParameterDbEntry ()
	destructor More...
virtual void	setObjectType (const DtObjectType &objectType)
virtual const DtObjectType &	objectType ()
virtual void	setParameters (DtVrfObjectParameters *parameters)
virtual DtVrfObjectParameters *	parameters ()
void	setTypeIsMatchType (bool isMatchType)
	Returns true if the type's object type is a matching type (a type used for matching remote entities / old object types) vs an object type (the type used for publishing). More...
bool	typeIsMatchType () const
void	setTemporary (bool)
	Get/set temporary flag. More...
bool	temporary () const

Protected Member Functions
	DtMtlParameterDbEntry (const DtMtlParameterDbEntry &orig)
	copy constructor - not implemented More...
DtMtlParameterDbEntry &	operator= (const DtMtlParameterDbEntry &orig)
	assignment operator - not implemented More...
Protected Member Functions inherited from DtVrfParameterDbEntry
	DtVrfParameterDbEntry (const DtVrfParameterDbEntry &orig)
	copy constructor - not implemented More...
DtVrfParameterDbEntry &	operator= (const DtVrfParameterDbEntry &orig)
	assignment operator - not implemented More...

Protected Attributes
DtFilename	myFilename
DtFilename	myPath
int	myVersion
DtVariableBindingsSharedPtr	myVariableBindings
DtReaderWriter::SearchPaths	mySearchPaths
Protected Attributes inherited from DtVrfParameterDbEntry
DtObjectType	myObjectType
DtVrfObjectParameters *	myParameters
bool	myTemporary
bool	myTypeIsMatchType

Detailed Description

DtMtlParameterDbEntry; record in a DtMtlParameterDb.

Instances of DtMtlParameterDbEntry are the data records used in a DtMtlParameterDb parameter database. It holds a DtVrfObjectParameter* object and the name of a parameter entry file (*.ope) from which a DtVrfObjectParameter object can be loaded.

Constructor & Destructor Documentation

DtMtlParameterDbEntry::DtMtlParameterDbEntry

(

)

virtual DtMtlParameterDbEntry::~DtMtlParameterDbEntry ( )

virtual

destructor

DtMtlParameterDbEntry::DtMtlParameterDbEntry ( const DtMtlParameterDbEntry &  orig )

protected

copy constructor - not implemented

Member Function Documentation

virtual void DtMtlParameterDbEntry::setFilename ( const DtFilename &  filename )

virtual

Filename of an object parameter entry file (*.ope) from which a DtVrfObjectParameter object can be loaded.

virtual const DtFilename& DtMtlParameterDbEntry::filename ( )

virtual

virtual DtVrfObjectParameters* DtMtlParameterDbEntry::load ( )

virtual

Loads entry from disk.

Currently no-op at this level (simply returns myParameters pointer)

Reimplemented from DtVrfParameterDbEntry.

virtual DtVrfObjectParameters* DtMtlParameterDbEntry::loadFromFile ( const DtFilename &  filename )

virtual

virtual DtVrfObjectParameters* DtMtlParameterDbEntry::readParameterEntry ( FILE *  fp, DtEnvironmentSP  env, DtEnvValueSP  objectNode  )

virtual

virtual DtVrfObjectParameters* DtMtlParameterDbEntry::loadParameters ( DtlObjPtr  arg, DtEnvironmentSP  env, DtEnvValueSP  objectNode  )

virtual

virtual DtString DtMtlParameterDbEntry::uniqueIdentifier ( ) const

virtual

Returns a string identifier that uniquely identifies this item.

This item returns the filename

Reimplemented from DtVrfParameterDbEntry.

virtual void DtMtlParameterDbEntry::setPath ( const DtFilename &  path )

virtual

Set the path to filename (will be concatenated with filename if filename is relative).

virtual const DtFilename& DtMtlParameterDbEntry::path ( ) const

virtual

virtual void DtMtlParameterDbEntry::setVersion ( int  version )

virtual

Set version number of parameter database file so we'll know where to set the search path for legacy parameter database files.

virtual void DtMtlParameterDbEntry::setVariableBindings ( const DtVariableBindingsSharedPtr &  bindings )

virtual

virtual DtVariableBindingsSharedPtr DtMtlParameterDbEntry::variableBindings ( )

virtual

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

virtual

Additional search paths.

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

virtual

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

protected

assignment operator - not implemented

Member Data Documentation

DtFilename DtMtlParameterDbEntry::myFilename

protected

DtFilename DtMtlParameterDbEntry::myPath

protected

int DtMtlParameterDbEntry::myVersion

protected

DtVariableBindingsSharedPtr DtMtlParameterDbEntry::myVariableBindings

protected

DtReaderWriter::SearchPaths DtMtlParameterDbEntry::mySearchPaths

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjparam/mtlParameterDbEntry.h