DtRwSpawnDataList Class Reference

Inheritance diagram for DtRwSpawnDataList:

List of all members.

Public Member Functions
	DtRwSpawnDataList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Actual constructor.
	DtRwSpawnDataList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwSpawnDataList (const DtRwSpawnDataList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
virtual DtRwSpawnDataList *	clone (DtReaderWriterRegistry *parentRegistry)
	Clone method; makes a new object, and copies the object calling this method.
virtual	~DtRwSpawnDataList ()
	destructor
DtRwSpawnDataList &	operator= (const DtRwSpawnDataList &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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
void	deleteList ()
	Removes all elements of this list and deletes them.
virtual DtRwSpawnData *	lookUpTemplateByName (const DtString &templateName) const
	Function to retrieve a template by name.
virtual bool	deleteTemplate (const DtString &templateName)
	Function to delete a template from the list, given the template name.
virtual DtString	stringRep ()
	Produces a string representation of the templates, suitable for printing.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Functions for reading a list of templates from an mtl file.
Protected Member Functions
	DtRwSpawnDataList ()
	Constructors etc.
void	copyList (const DtRwSpawnDataList &orig)
	A convenience function for the copy constructor and = op.

---

Constructor & Destructor Documentation

DtRwSpawnDataList::DtRwSpawnDataList

(

)

[protected]

Constructors etc.

default constructor

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

Actual constructor.

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

DtRwSpawnDataList::DtRwSpawnDataList	(	const DtRwSpawnDataList &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Copy constructor.

virtual DtRwSpawnDataList::~DtRwSpawnDataList

(

)

[virtual]

destructor

---

Member Function Documentation

virtual DtRwSpawnDataList* DtRwSpawnDataList::clone

(

DtReaderWriterRegistry *

parentRegistry

)

[virtual]

Clone method; makes a new object, and copies the object calling this method.

DtRwSpawnDataList& DtRwSpawnDataList::operator=

(

const DtRwSpawnDataList &

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 const char* DtRwSpawnDataList::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.

void DtRwSpawnDataList::copyList

(

const DtRwSpawnDataList &

orig

)

[protected]

A convenience function for the copy constructor and = op.

Copies by allocating new templates, and adds them to this list. Non-virtual because it is used from constructor/destructor.

void DtRwSpawnDataList::deleteList

(

)

Removes all elements of this list and deletes them.

Used by the copy constructor and destructor; also available for other modules to clear a list. Non-virtual because it is used from constructor/destructor.

virtual DtRwSpawnData* DtRwSpawnDataList::lookUpTemplateByName

(

const DtString &

templateName

)

const [virtual]

Function to retrieve a template by name.

virtual bool DtRwSpawnDataList::deleteTemplate

(

const DtString &

templateName

)

[virtual]

Function to delete a template from the list, given the template name.

Returns true if successful, false if the template was not found.

virtual DtString DtRwSpawnDataList::stringRep

(

)

[virtual]

Produces a string representation of the templates, suitable for printing.

Utility function, primarily for debugging.

virtual DtlObjPtr DtRwSpawnDataList::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

Functions for reading a list of templates from an mtl file.

Reads data for one spawn template and adds it to the list. Note that the getself defined in RwList walks the list of data in the mtl file calling this getdata on each item.

Implements DtRwList.

---

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

• include/vrfmsgs/rwSpawnDataList.h