DtRwTemplatedListPtr< T > Class Template Reference

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

Inheritance diagram for DtRwTemplatedListPtr< T >:

List of all members.

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.
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)
Protected Attributes
bool	myAutoDelete

---

Detailed Description

template<typename T>
class DtRwTemplatedListPtr< T >

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

The templated type specified must be a subclass of DtReaderWriter.

---

Member Typedef Documentation

template<typename T>

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

template<typename T>

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

---

Constructor & Destructor Documentation

template<typename T >

DtRwTemplatedListPtr< T >::DtRwTemplatedListPtr

(

)

default constructor

template<typename T >

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

real constructor

template<typename T >

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

template<typename T >

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

Invokes DtReaderWriter copy constructor.

Elements are copied using their standard copy constructor.

References DtRwTemplatedListPtr< T >::copyList().

template<typename T >

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

References DtRwTemplatedListPtr< T >::copyList().

template<typename T >

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

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

References DtRwTemplatedListPtr< T >::copyList().

template<typename T >

DtRwTemplatedListPtr< T >::~DtRwTemplatedListPtr

(

)

[virtual]

---

Member Function Documentation

template<typename T >

DtRwTemplatedListPtr< T > & DtRwTemplatedListPtr< T >::operator=

(

const DtRwTemplatedListPtr< T > &

orig

)

References DtRwTemplatedListPtr< T >::myAutoDelete.

template<typename T >

DtlObjPtr DtRwTemplatedListPtr< T >::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.

Here is some sample code that could be used to implement a override of this class: (This is used in the DtRwIntegerList::getData() method)

 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 >

void DtRwTemplatedListPtr< T >::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 >

void * DtRwTemplatedListPtr< T >::remove

(

DtListItem *

item

)

References DtRwList::remove().

template<typename T>

void * DtRwTemplatedListPtr< T >::remove

(

T *

item

)

template<typename T >

void DtRwTemplatedListPtr< T >::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 DtRwTemplatedListPtr< T >::operator==

(

const DtRwTemplatedListPtr< T > &

rhs

)

const

Equivalence operators.

template<typename T >

bool DtRwTemplatedListPtr< T >::operator!=

(

const DtRwTemplatedListPtr< T > &

rhs

)

const

template<typename T>

void DtRwTemplatedListPtr< T >::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 DtRwTemplatedListPtr< T >::autoDelete

(

)

const [inline]

template<typename T >

const char * DtRwTemplatedListPtr< T >::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 >

void DtRwTemplatedListPtr< T >::copyList

(

const DtRwTemplatedListPtr< T > &

orig

)

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

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

---

Member Data Documentation

template<typename T>

bool DtRwTemplatedListPtr< T >::myAutoDelete [protected]

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

---

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

• include/vrfutil/rwTemplatedList.h