DtRwIntrusiveList Class Reference

class DtRwIntrusiveList: More...

Inheritance diagram for DtRwIntrusiveList:

Public Member Functions
	DtRwIntrusiveList ()
	default constructor
	DtRwIntrusiveList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwIntrusiveList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwIntrusiveList (const DtString &name, const DtRwIntrusiveList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor. Elements are not copied.
	DtRwIntrusiveList (const DtSymbolString &name, const DtRwIntrusiveList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwIntrusiveList ()
	destructor Note: for consistency with other list classes, this destructor will NOT delete the data objects contained by the list.
DtRwIntrusiveList &	operator= (const DtRwIntrusiveList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
DtRwListedObj *	firstObj () const
	Return first and last item on the list.
DtRwListedObj *	lastObj () const
DtListItem *	first () const
	Return first and last item on the list.
DtListItem *	last () const
unsigned	count () const
	Returns the number of elements in the list.
DtListItem *	add (DtRwListedObj *data)
	Add element to the end of the list.
DtListItem *	addToStart (DtRwListedObj *data)
	Add element to the beginning of the list.
DtListItem *	addToEnd (DtRwListedObj *data)
	Add element to the end of the list.
DtListItem *	addBefore (DtRwListedObj *data, DtRwListedObj *before)
	Add element to the list just before the indicated object.
DtListItem *	addAfter (DtRwListedObj *data, DtRwListedObj *after)
	Add element to the list just after the indicated object.
DtRwListedObj *	remove (DtRwListedObj *data)
	Remove an element from the list.
virtual DtRwListedObj *	remove (DtListItem *item)
	Remove an element from the list.
void	removeAndDelete (DtRwListedObj *data)
	Remove and delete an element from the list.
virtual void	removeAndDelete (DtListItem *item)
	Remove and delete an element from the list.
virtual void	removeAll ()
	Calls remove for all elements in the list.
virtual void	removeAllAndDelete ()
	Same as removeAll, except that this DOES delete the data in the list.
DtListItem *	itemLookup (DtRwListedObj *data) const
	Returns the DtListItem envelope object containing the indicated data element.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Reads the contents of the list, using the list-specific getData function below.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)=0
	This special version of getData needs to create the necessary list element object (one that's derived from DtRwListedObj), tell the element to getSelf, and then add the element to the DtRwIntrusiveList.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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 (std::string &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 (std::string &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.
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 *	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 (std::string &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)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
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 ()
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 ()
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.

Protected Member Functions
	DtRwIntrusiveList (const DtRwIntrusiveList &orig)
	C++ copy constructor Not implemented, do not call.
virtual DtListItem *	addToList (DtRwListedObj *data, DtRwListedObj *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.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtList	myList
	The actual DtList used to store the items.
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.

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 )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
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 &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	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 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
static bool	thePutIndent

Detailed Description

class DtRwIntrusiveList:

Instances of DtRwIntrusiveList are readable-writable versions of the VR-Link DtIntrusiveList class. Instead of expecting its objects to be derived from DtListedObj, this class expects them to be derived from DtRwListedObj.

In order to use this class, you will have to derive a more specific class from it that implements the special getData function to create the actual list items.

The save format for this class is something like: (list-name (list-elem-name ...element putSelf data...) (list-elem-name ...element putSelf data...) ... )

Constructor & Destructor Documentation

DtRwIntrusiveList::DtRwIntrusiveList

(

)

default constructor

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

real constructor

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

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

Invokes DtReaderWriter copy constructor. Elements are not copied.

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

virtual DtRwIntrusiveList::~DtRwIntrusiveList ( )

virtual

destructor Note: for consistency with other list classes, this destructor will NOT delete the data objects contained by the list.

If you wish to have the data deleted as well, call removeAllAndDelete() before deleting the entire list.

DtRwIntrusiveList::DtRwIntrusiveList ( const DtRwIntrusiveList &  orig )

protected

C++ copy constructor Not implemented, do not call.

Member Function Documentation

DtRwIntrusiveList& DtRwIntrusiveList::operator=

(

const DtRwIntrusiveList &

orig

)

Calls down to DtReaderWriter::operator=(). List elements are not copied.

DtRwListedObj * DtRwIntrusiveList::firstObj ( ) const

inline

Return first and last item on the list.

Inline Functions.

References myList.

Referenced by addToStart(), and DtSimBlock::firstStmt().

DtRwListedObj * DtRwIntrusiveList::lastObj ( ) const

inline

References myList.

Referenced by addToEnd(), and DtSimBlock::lastStmt().

DtListItem * DtRwIntrusiveList::first ( ) const

inline

Return first and last item on the list.

DtListItem is an envelope for your data. The data can be obtained using DtListItem::data().

References myList.

Referenced by addToStart().

DtListItem * DtRwIntrusiveList::last ( ) const

inline

References myList.

Referenced by addToEnd().

unsigned DtRwIntrusiveList::count ( ) const

inline

Returns the number of elements in the list.

References myList.

DtListItem * DtRwIntrusiveList::add ( DtRwListedObj *  data )

inline

Add element to the end of the list.

Returns the DtListItem envelope object that contains your new element.

References addToEnd().

DtListItem * DtRwIntrusiveList::addToStart ( DtRwListedObj *  data )

inline

Add element to the beginning of the list.

Returns the DtListItem envelope object that contains your new element.

References addBefore(), first(), firstObj(), and myList.

DtListItem * DtRwIntrusiveList::addToEnd ( DtRwListedObj *  data )

inline

Add element to the end of the list.

Returns the DtListItem envelope object that contains your new element.

References addToList(), last(), lastObj(), and myList.

Referenced by add().

DtListItem * DtRwIntrusiveList::addBefore ( DtRwListedObj *  data, DtRwListedObj *  before  )

inline

Add element to the list just before the indicated object.

Returns the DtListItem envelope object that contains your new element.

References addToList(), and DtRwListedObj::prev().

Referenced by addToStart().

DtListItem * DtRwIntrusiveList::addAfter ( DtRwListedObj *  data, DtRwListedObj *  after  )

inline

Add element to the list just after the indicated object.

Returns the DtListItem envelope object that contains your new element.

References addToList().

DtRwListedObj * DtRwIntrusiveList::remove ( DtRwListedObj *  data )

inline

Remove an element from the list.

Note: remove does not free memory of data associated with the item. It only frees the item. The data is returned to the caller for deletion if required.

References DtRwListedObj::myItem.

virtual DtRwListedObj* DtRwIntrusiveList::remove ( DtListItem *  item )

virtual

Remove an element from the list.

Item is the envelope containing the data element you would like to remove. Note: remove does not free memory of data associated with the item. It only frees the item. The data is returned to the caller for deletion if required.

void DtRwIntrusiveList::removeAndDelete ( DtRwListedObj *  data )

inline

Remove and delete an element from the list.

References DtRwListedObj::myItem.

virtual void DtRwIntrusiveList::removeAndDelete ( DtListItem *  item )

virtual

Remove and delete an element from the list.

Item is the envelope containing the data element you would like to remove.

virtual void DtRwIntrusiveList::removeAll ( )

virtual

Calls remove for all elements in the list.

It does NOT delete the data in the list. Merely removes the data from the list.

virtual void DtRwIntrusiveList::removeAllAndDelete ( )

virtual

Same as removeAll, except that this DOES delete the data in the list.

DtListItem * DtRwIntrusiveList::itemLookup ( DtRwListedObj *  data ) const

inline

Returns the DtListItem envelope object containing the indicated data element.

This function should never be necessary, it is included solely for completeness and consistency with DtIntrusiveList.

References myList.

virtual void DtRwIntrusiveList::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Reads the contents of the list, using the list-specific getData function below.

virtual DtlObjPtr DtRwIntrusiveList::getData ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

pure virtual

This special version of getData needs to create the necessary list element object (one that's derived from DtRwListedObj), tell the element to getSelf, and then add the element to the DtRwIntrusiveList.

The return value is ignored.

Implemented in DtSimBlock.

virtual DtlObjPtr DtRwIntrusiveList::getLocalData ( DtlObjPtr  args )

virtual

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 const char* DtRwIntrusiveList::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

virtual DtListItem* DtRwIntrusiveList::addToList ( DtRwListedObj *  data, DtRwListedObj *  after  )

protectedvirtual

Add element to the list just after the indicated item.

Returns the DtListItem envelope object that contains your new element.

Reimplemented in DtSimBlock.

Referenced by addAfter(), addBefore(), and addToEnd().

Member Data Documentation

DtList DtRwIntrusiveList::myList

protected

The actual DtList used to store the items.

Referenced by addToEnd(), addToStart(), count(), first(), firstObj(), itemLookup(), last(), and lastObj().

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/rwIntrusiveList.h