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

Inheritance diagram for DtMtlParameterDbFileData:

[legend]

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, bool typeIsMatchType, 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.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static bool	getVersion (const DtFilename &parameterDbFile, int &version)
	Returns version number of parameter database file, if it exists.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Attributes
DtRwInt	myVersion
DtMtlParameterDbFileEntryList	myEntryList
DtRemoteConfigurationList *	pMyRemoteConfigurationList
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Static Protected Attributes
static int	theCurrentVersion
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.

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,
		bool	typeIsMatchType,
		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

staticprotected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/mtlParameterDbFileData.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation