DtSimReportList Class Reference

a RW List which holds arbitrary subtypes of DtSimReport. More...

Inheritance diagram for DtSimReportList:

List of all members.

Public Member Functions
	DtSimReportList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtSimReportList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSimReportList (const DtString &name, const DtSimReportList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtSimReportList (const DtSymbolString &name, const DtSimReportList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtSimReportList ()
	Elements are not deleted.
virtual const DtSimReportList &	operator= (const DtSimReportList &orig)
	Calls down to DtReaderWriter::operator=().
virtual DtListItem *	add (DtSimReport *report)
	Adds this item to the list.
virtual DtListItem *	addToEnd (DtSimReport *report)
	Adds this item to the end of the list.
virtual DtListItem *	addToStart (DtSimReport *report)
	Adds this item to the start of the list.
virtual DtSimReport *	remove (DtSimReport *report, DtListItem *item)
	Removes the specified item from the list, and does not delete it.
virtual void	removeAndDelete (DtListItem *data)
	Removes and deletes the item specified.
virtual void	removeAndDeleteAll ()
	Removes and deletes all elements.
Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs simReports using the factory when reading from a file.

---

Detailed Description

a RW List which holds arbitrary subtypes of DtSimReport.

This list used the report factory stored in the static factory member of DtSimReport to store sim reports. The factory is used to create the reports on load using the name as the type string key to the factory. This list does not keep ownership of the reports, and does not delete them, except in the explicit removeAndDelete() calls.

---

Constructor & Destructor Documentation

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

real constructor

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

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

Invokes DtReaderWriter copy constructor.

Elements are not copied.

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

virtual DtSimReportList::~DtSimReportList

(

)

[virtual]

Elements are not deleted.

---

Member Function Documentation

virtual const DtSimReportList& DtSimReportList::operator=

(

const DtSimReportList &

orig

)

[virtual]

Calls down to DtReaderWriter::operator=().

List elements are not copied.

virtual DtListItem* DtSimReportList::add

(

DtSimReport *

report

)

[virtual]

Adds this item to the list.

virtual DtListItem* DtSimReportList::addToEnd

(

DtSimReport *

report

)

[virtual]

Adds this item to the end of the list.

virtual DtListItem* DtSimReportList::addToStart

(

DtSimReport *

report

)

[virtual]

Adds this item to the start of the list.

virtual DtSimReport* DtSimReportList::remove	(	DtSimReport *	report,
		DtListItem *	item
	)		[virtual]

Removes the specified item from the list, and does not delete it.

The data is returned.

virtual void DtSimReportList::removeAndDelete

(

DtListItem *

data

)

[virtual]

Removes and deletes the item specified.

virtual void DtSimReportList::removeAndDeleteAll

(

)

[virtual]

Removes and deletes all elements.

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

Constructs simReports using the factory when reading from a file.

Implements DtRwList.

---

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

• include/vrftasks/simReportList.h