DtMtlParameterDbFileData Class Reference

Instances of DtMtlParameterDbFileData are the readable, writeable parameter data stored in MTL (Mak technologies Lisp) parameter database files. More...

Inheritance diagram for DtMtlParameterDbFileData:

List of all members.

Public Member Functions
	DtMtlParameterDbFileData (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	constructor - name is the DtReaderWriter name of the object (the name that will be written to file identifying the object).
	DtMtlParameterDbFileData (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtMtlParameterDbFileData ()
	destructor
	DtMtlParameterDbFileData (const DtString &name, const DtMtlParameterDbFileData &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtMtlParameterDbFileData (const DtSymbolString &name, const DtMtlParameterDbFileData &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtMtlParameterDbFileData &	operator= (const DtMtlParameterDbFileData &orig)
	assignment operator
virtual void	setVersion (int version)
	Version number of the parameter database.
virtual int	version () const
virtual DtMtlParameterDbFileEntry *	addEntry (const DtObjectType &objectType, const DtFilename &filename, DtVrfObjectParameters *parameters=NULL)
	Add an parameter data entry.
virtual const DtMtlParameterDbFileEntryList &	entryList () const
	List of DtMtlParameterDbFileEntry* maintained by this class.
virtual DtMtlParameterDbFileEntryList &	entryList ()
DtRemoteConfigurationList *	remoteConfigurationList ()
	Get/Set there remote configuration list The remote configuration list is created outside of DtMtlParameterDbFileData by DtMtlParameterDb. DtMtlParameterDb retains ownership of the pointer, and lends it to DtMtlParameterDbFileData for purposes of loading an MTL-based parameter DB file.
const DtRemoteConfigurationList *	remoteConfigurationList () const
	Get/Set there remote configuration list The remote configuration list is created outside of DtMtlParameterDbFileData by DtMtlParameterDb. DtMtlParameterDb retains ownership of the pointer, and lends it to DtMtlParameterDbFileData for purposes of loading an MTL-based parameter DB file.
virtual void	setRemoteConfigurationList (DtRemoteConfigurationList *pList)
	Get/Set there remote configuration list The remote configuration list is created outside of DtMtlParameterDbFileData by DtMtlParameterDb. DtMtlParameterDb retains ownership of the pointer, and lends it to DtMtlParameterDbFileData for purposes of loading an MTL-based parameter DB file.
Static Public Member Functions
static bool	getVersion (const DtFilename &parameterDbFile, int &version)
	Returns version number of parameter database file, if it exists.
Protected Attributes
DtRwInt	myVersion
DtMtlParameterDbFileEntryList	myEntryList
DtRemoteConfigurationList *	pMyRemoteConfigurationList
Static Protected Attributes
static int	theCurrentVersion

---

Detailed Description

Instances of DtMtlParameterDbFileData are the readable, writeable parameter data stored in MTL (Mak technologies Lisp) parameter database files.

Used as intermediate storage when reading and writing DtMtlParameterDb objects.

---

Constructor & Destructor Documentation

DtMtlParameterDbFileData::DtMtlParameterDbFileData	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

constructor - name is the DtReaderWriter name of the object (the name that will be written to file identifying the object).

DtMtlParameterDbFileData::DtMtlParameterDbFileData	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

virtual DtMtlParameterDbFileData::~DtMtlParameterDbFileData

(

)

[virtual]

destructor

DtMtlParameterDbFileData::DtMtlParameterDbFileData	(	const DtString &	name,
		const DtMtlParameterDbFileData &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtMtlParameterDbFileData::DtMtlParameterDbFileData	(	const DtSymbolString &	name,
		const DtMtlParameterDbFileData &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

---

Member Function Documentation

DtMtlParameterDbFileData& DtMtlParameterDbFileData::operator=

(

const DtMtlParameterDbFileData &

orig

)

assignment operator

virtual void DtMtlParameterDbFileData::setVersion

(

int

version

)

[virtual]

Version number of the parameter database.

virtual int DtMtlParameterDbFileData::version

(

)

const [virtual]

virtual DtMtlParameterDbFileEntry* DtMtlParameterDbFileData::addEntry	(	const DtObjectType &	objectType,
		const DtFilename &	filename,
		DtVrfObjectParameters *	parameters = NULL
	)		[virtual]

Add an parameter data entry.

Filename is the name of the object parameter file entry (.ope) referenced by the parameter database file (.opd). The parameters data is typically NULL when using this object to cache data read in from file, while it may be NON-null when saving the data to file.

virtual const DtMtlParameterDbFileEntryList& DtMtlParameterDbFileData::entryList

(

)

const [virtual]

List of DtMtlParameterDbFileEntry* maintained by this class.

virtual DtMtlParameterDbFileEntryList& DtMtlParameterDbFileData::entryList

(

)

[virtual]

static bool DtMtlParameterDbFileData::getVersion	(	const DtFilename &	parameterDbFile,
		int &	version
	)		[static]

Returns version number of parameter database file, if it exists.

DtRemoteConfigurationList * DtMtlParameterDbFileData::remoteConfigurationList

(

)

[inline]

Get/Set there remote configuration list The remote configuration list is created outside of DtMtlParameterDbFileData by DtMtlParameterDb. DtMtlParameterDb retains ownership of the pointer, and lends it to DtMtlParameterDbFileData for purposes of loading an MTL-based parameter DB file.

References pMyRemoteConfigurationList.

const DtRemoteConfigurationList * DtMtlParameterDbFileData::remoteConfigurationList

(

)

const [inline]

Get/Set there remote configuration list The remote configuration list is created outside of DtMtlParameterDbFileData by DtMtlParameterDb. DtMtlParameterDb retains ownership of the pointer, and lends it to DtMtlParameterDbFileData for purposes of loading an MTL-based parameter DB file.

References pMyRemoteConfigurationList.

virtual void DtMtlParameterDbFileData::setRemoteConfigurationList

(

DtRemoteConfigurationList *

pList

)

[virtual]

Get/Set there remote configuration list The remote configuration list is created outside of DtMtlParameterDbFileData by DtMtlParameterDb. DtMtlParameterDb retains ownership of the pointer, and lends it to DtMtlParameterDbFileData for purposes of loading an MTL-based parameter DB file.

---

Member Data Documentation

DtRwInt DtMtlParameterDbFileData::myVersion [protected]

DtMtlParameterDbFileEntryList DtMtlParameterDbFileData::myEntryList [protected]

DtRemoteConfigurationList* DtMtlParameterDbFileData::pMyRemoteConfigurationList [protected]

Referenced by remoteConfigurationList().

int DtMtlParameterDbFileData::theCurrentVersion [static, protected]

---

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

• include/vrfobjparam/mtlParamDbFileData.h