DtCommModelDescriptorList Class Reference

List of DtCommModelDescriptor subclasses that can be read from a RW type file. More...

Inheritance diagram for DtCommModelDescriptorList:

List of all members.

Public Member Functions
	DtCommModelDescriptorList (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtCommModelDescriptorList (const DtCommModelDescriptorList &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtCommModelDescriptorList &	operator= (const DtCommModelDescriptorList &orig)
	Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.
virtual	~DtCommModelDescriptorList ()
	destructor
virtual DtCommModelDescriptorList *	clone (DtReaderWriterRegistry *parentRegistry=0)
virtual void	addCommModelDescriptor (const DtCommModelDescriptor &descriptor)
	Clones the descriptor and adds it to the list.
virtual const DtCommModelDescriptor *	lookupCommModelDescriptor (const DtString &name) const
	Searches the list for a descriptor of the specified name, and returns a pointer to it if it exists.
Protected Member Functions
	DtCommModelDescriptorList ()
void	emptyList ()
	Removes all descriptors from the list, and destroys them.
void	copyList (const DtCommModelDescriptorList &orig)
virtual void	addCommModelDescriptor (DtCommModelDescriptor *descriptor)
	Adds this descriptor to the list.
virtual DtListItem *	lookupCommModelDescriptorItem (const DtString &name) const
	Looks up the descriptor and returns the list item that points to it.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	This method must be overridden by a subclass.

---

Detailed Description

List of DtCommModelDescriptor subclasses that can be read from a RW type file.

This class owns all descriptors contained on the list and deletes them when the list is destroyed.

---

Constructor & Destructor Documentation

DtCommModelDescriptorList::DtCommModelDescriptorList

(

)

[protected]

DtCommModelDescriptorList::DtCommModelDescriptorList	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtCommModelDescriptorList::DtCommModelDescriptorList	(	const DtCommModelDescriptorList &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtCommModelDescriptorList::~DtCommModelDescriptorList

(

)

[virtual]

destructor

---

Member Function Documentation

DtCommModelDescriptorList& DtCommModelDescriptorList::operator=

(

const DtCommModelDescriptorList &

orig

)

Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.

virtual DtCommModelDescriptorList* DtCommModelDescriptorList::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

[virtual]

virtual void DtCommModelDescriptorList::addCommModelDescriptor

(

const DtCommModelDescriptor &

descriptor

)

[virtual]

Clones the descriptor and adds it to the list.

Note:

Any existing descriptor with the same name will be replaced.

virtual const DtCommModelDescriptor* DtCommModelDescriptorList::lookupCommModelDescriptor

(

const DtString &

name

)

const [virtual]

Searches the list for a descriptor of the specified name, and returns a pointer to it if it exists.

void DtCommModelDescriptorList::emptyList

(

)

[protected]

Removes all descriptors from the list, and destroys them.

void DtCommModelDescriptorList::copyList

(

const DtCommModelDescriptorList &

orig

)

[protected]

virtual void DtCommModelDescriptorList::addCommModelDescriptor

(

DtCommModelDescriptor *

descriptor

)

[protected, virtual]

Adds this descriptor to the list.

Does not clone the descriptor.

Note:

Any existing descriptor with the same name will be replaced.

virtual DtListItem* DtCommModelDescriptorList::lookupCommModelDescriptorItem

(

const DtString &

name

)

const [protected, virtual]

Looks up the descriptor and returns the list item that points to it.

virtual DtlObjPtr DtCommModelDescriptorList::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[protected, 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.

---

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

• include/vrfobjparam/commModelDescriptorList.h