DtVrfObjectParametersList Class Reference

Inheritance diagram for DtVrfObjectParametersList:

Public Member Functions
	DtVrfObjectParametersList (const DtString &writeName, DtReaderWriterRegistry *const parentRegistry=0)
	constructor
virtual	~DtVrfObjectParametersList ()
virtual void	addParameters (DtVrfObjectParameters *parameters)
virtual DtVrfObjectParameters *	lookupParameters (const DtObjectType &objectType, DtObjectType *matchingType) const
virtual void	removeParameters (const DtObjectType &objectType)
	Will only remove parameters if an exact match is found.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Overridden to provide backward compatibiltiy with parameter files from version 1.x.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a parameter block, and then reads relevant data from the mtl stream.
virtual void	inheritValuesFromAncestors ()
void	emptyList ()
	Used by the destructor.
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
	Add element to the list just after the indicated item.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
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	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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions
	DtVrfObjectParametersList ()
	default constructor
	DtVrfObjectParametersList (const DtVrfObjectParametersList &orig)
	copy constructor
const DtVrfObjectParametersList &	operator= (const DtVrfObjectParametersList &orig)
	assignment operator
virtual DtListItem *	lookupParameters (const DtObjectType &objectType) const
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtString	myNameFromStream
	For backward compatibility with version 1.x parameter files.

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::pair < DtSymbolString, DtString >	DtVariableNameType
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 DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Constructor & Destructor Documentation

DtVrfObjectParametersList::DtVrfObjectParametersList ( )

protected

default constructor

DtVrfObjectParametersList::DtVrfObjectParametersList	(	const DtString &	writeName,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

constructor

DtVrfObjectParametersList::DtVrfObjectParametersList ( const DtVrfObjectParametersList &  orig )

protected

copy constructor

virtual DtVrfObjectParametersList::~DtVrfObjectParametersList ( )

virtual

Member Function Documentation

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

protected

assignment operator

virtual void DtVrfObjectParametersList::addParameters ( DtVrfObjectParameters *  parameters )

virtual

virtual DtVrfObjectParameters* DtVrfObjectParametersList::lookupParameters ( const DtObjectType &  objectType, DtObjectType *  matchingType  ) const

virtual

virtual void DtVrfObjectParametersList::removeParameters ( const DtObjectType &  objectType )

virtual

Will only remove parameters if an exact match is found.

virtual void DtVrfObjectParametersList::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath = DtFilename::nullFilename(), const DtVariableBindingsList &  variableBindings = nullVariableReference()  )

virtual

Overridden to provide backward compatibiltiy with parameter files from version 1.x.

Reimplemented from DtRwList.

virtual DtlObjPtr DtVrfObjectParametersList::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

Constructs a parameter block, and then reads relevant data from the mtl stream.

Implements DtRwList.

virtual void DtVrfObjectParametersList::inheritValuesFromAncestors ( )

virtual

void DtVrfObjectParametersList::emptyList

(

)

Used by the destructor.

It DELETES all parameter entries in the parameter database. Not virtual because it is called by the destructor.

virtual DtListItem* DtVrfObjectParametersList::lookupParameters ( const DtObjectType &  objectType ) const

protectedvirtual

Member Data Documentation

DtString DtVrfObjectParametersList::myNameFromStream

protected

For backward compatibility with version 1.x parameter files.

Name of the object from the mtl stream.

---

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

• include/vrfobjparam/objParamList.h