A version of DtRwList that contains a homogeneous list of a templated RW type. More...

Inheritance diagram for DtRwTemplatedListPtr< T, T_autoDelete >:

Public Types
typedef DtIteratorBase< T >	iterator
typedef DtIteratorBase< const T >	const_iterator

Public Member Functions
	DtRwTemplatedListPtr ()
	default constructor
	DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwTemplatedListPtr (const DtSymbolString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	... and make sure the default constructor is overridden:
DtRwTemplatedListPtr &	operator= (const DtRwTemplatedListPtr &orig)
virtual	~DtRwTemplatedListPtr ()
DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	This method must be overridden by a subclass.
virtual DtListItem *	add (T *data)
	Define this function to hide the DtRwList version, and accept only the specific DtReaderWriter subclass that this list is handling.
void	removeAll ()
	Removes all entries from the list.
void *	remove (DtListItem *item)
void *	remove (T *item)
void	removeAndDeleteAll ()
	Removes and deletes all entries in the list.
bool	operator== (const DtRwTemplatedListPtr &) const
	Equivalence operators.
bool	operator!= (const DtRwTemplatedListPtr &) const
void	setAutoDelete (bool b)
	Set to true to automatically delete all items in the list upon list deletion.
bool	autoDelete () const
const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
void	copyList (const DtRwTemplatedListPtr &orig)
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 *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object.
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 void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
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.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
bool	operator!= (const DtRwList &rhs) const
	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
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static const char *	ListReaderWriterType ()

Protected Attributes
bool	myAutoDelete

Additional Inherited Members
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.
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

Detailed Description

template<typename T, bool T_autoDelete = false>
class DtRwTemplatedListPtr< T, T_autoDelete >

A version of DtRwList that contains a homogeneous list of a templated RW type.

The templated type specified must be a subclass of DtReaderWriter. The T_autoDelete template parameter indicates whether or not this list takes ownership of the items added to it. If true, the items will be deleted when removed from the list, or the list is destroyed.

Member Typedef Documentation

template<typename T, bool T_autoDelete = false>

typedef DtIteratorBase<T> DtRwTemplatedListPtr< T, T_autoDelete >::iterator

template<typename T, bool T_autoDelete = false>

typedef DtIteratorBase<const T> DtRwTemplatedListPtr< T, T_autoDelete >::const_iterator

Constructor & Destructor Documentation

template<typename T , bool T_autoDelete>

DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr ( )

default constructor

template<typename T , bool T_autoDelete>

DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

real constructor

template<typename T , bool T_autoDelete>

DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

template<typename T , bool T_autoDelete>

DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr	(	const DtString &	name,
		const DtRwTemplatedListPtr< T, T_autoDelete > &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Invokes DtReaderWriter copy constructor.

Elements are copied using their standard copy constructor.

References DtRwTemplatedListPtr< T, T_autoDelete >::copyList().

template<typename T , bool T_autoDelete>

DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr	(	const DtSymbolString &	name,
		const DtRwTemplatedListPtr< T, T_autoDelete > &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

References DtRwTemplatedListPtr< T, T_autoDelete >::copyList().

template<typename T , bool T_autoDelete>

DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr	(	const DtRwTemplatedListPtr< T, T_autoDelete > &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

... and make sure the default constructor is overridden:

References DtRwTemplatedListPtr< T, T_autoDelete >::copyList().

template<typename T , bool T_autoDelete>

DtRwTemplatedListPtr< T, T_autoDelete >::~DtRwTemplatedListPtr ( )

virtual

Member Function Documentation

template<typename T , bool T_autoDelete>

DtRwTemplatedListPtr< T, T_autoDelete > & DtRwTemplatedListPtr< T, T_autoDelete >::operator= ( const DtRwTemplatedListPtr< T, T_autoDelete > & orig )

References DtRwTemplatedListPtr< T, T_autoDelete >::myAutoDelete, and DtRwList::operator=().

template<typename T , bool T_autoDelete>

DtlObjPtr DtRwTemplatedListPtr< T, T_autoDelete >::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)

virtual

This method must be overridden by a subclass.

  Within this method, new instances of the DtReaderWriter subclass
  that is being handled by this list must be created, and then retrieved
  from the mtl stream, using the getSelf member of that item.
  \par
  Here is some sample code that could be used to implement a 
  override of this class:  (This is used in the DtRwIntegerList::getData() method)
  @code

DtlObjPtr nameObj = DtcCar(args); DtRwInt* value = new DtRwInt(nameObj->pname()); value->getSelf(args, searchPath, variableBindings); this->add(value); return DtcCdr(DtcCdr(args));

Implements DtRwList.

template<typename T, bool T_autoDelete = false>

virtual DtListItem* DtRwTemplatedListPtr< T, T_autoDelete >::add ( T * data )

inlinevirtual

Define this function to hide the DtRwList version, and accept only the specific DtReaderWriter subclass that this list is handling.

Referenced by DtRwTemplatedListPtr< DtReservedSlot >::add(), DtLoadPoint::addPoint(), and DtReservedSlot::addReservedBy().

template<typename T , bool T_autoDelete>

void DtRwTemplatedListPtr< T, T_autoDelete >::removeAll ( )

virtual

Removes all entries from the list.

If autoDelete is true, also deletes all items.

Reimplemented from DtRwList.

References DtRwList::removeAll().

template<typename T , bool T_autoDelete>

void * DtRwTemplatedListPtr< T, T_autoDelete >::remove ( DtListItem * item )

References DtRwList::remove().

template<typename T, bool T_autoDelete>

void * DtRwTemplatedListPtr< T, T_autoDelete >::remove ( T * item )

template<typename T , bool T_autoDelete>

void DtRwTemplatedListPtr< T, T_autoDelete >::removeAndDeleteAll ( )

Removes and deletes all entries in the list.

References DtIteratorBase< T >::first(), DtIteratorBase< T >::next(), and DtRwList::removeAll().

Referenced by DtBufferSerialize::decode().

template<typename T , bool T_autoDelete>

bool DtRwTemplatedListPtr< T, T_autoDelete >::operator== ( const DtRwTemplatedListPtr< T, T_autoDelete > & rhs ) const

Equivalence operators.

template<typename T , bool T_autoDelete>

bool DtRwTemplatedListPtr< T, T_autoDelete >::operator!= ( const DtRwTemplatedListPtr< T, T_autoDelete > & rhs ) const

template<typename T, bool T_autoDelete = false>

void DtRwTemplatedListPtr< T, T_autoDelete >::setAutoDelete ( bool b )

inline

Set to true to automatically delete all items in the list upon list deletion.

If you remove an item from the list before list deletion you must delete it yourself

template<typename T, bool T_autoDelete = false>

bool DtRwTemplatedListPtr< T, T_autoDelete >::autoDelete ( ) const

inline

template<typename T , bool T_autoDelete>

const char * DtRwTemplatedListPtr< T, T_autoDelete >::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 DtRwList.

Reimplemented in DtRwSensorSignatureList.

template<typename T , bool T_autoDelete>

const char * DtRwTemplatedListPtr< T, T_autoDelete >::ListReaderWriterType ( )

static

template<typename T , bool T_autoDelete>

void DtRwTemplatedListPtr< T, T_autoDelete >::copyList ( const DtRwTemplatedListPtr< T, T_autoDelete > & orig )

References DtIteratorBase< T >::first(), and DtIteratorBase< T >::next().

Referenced by DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr().

Member Data Documentation

template<typename T, bool T_autoDelete = false>

bool DtRwTemplatedListPtr< T, T_autoDelete >::myAutoDelete

protected

Referenced by DtRwTemplatedListPtr< DtReservedSlot >::autoDelete(), DtRwTemplatedListPtr< T, T_autoDelete >::operator=(), and DtRwTemplatedListPtr< DtReservedSlot >::setAutoDelete().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename T, bool T_autoDelete = false> class DtRwTemplatedListPtr< T, T_autoDelete >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T, bool T_autoDelete = false>
class DtRwTemplatedListPtr< T, T_autoDelete >