DtSensorContactInfoList Class Reference

A reader-writer list of DtRwSensorContactInfo elements. More...

Inheritance diagram for DtSensorContactInfoList:

List of all members.

Public Member Functions
	DtSensorContactInfoList ()
	default constructor
	DtSensorContactInfoList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	readable/writable constructor
	DtSensorContactInfoList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtSensorContactInfoList ()
	destructor
DtSensorContactInfoList &	operator= (const DtSensorContactInfoList &orig)
	assignment operator This is a deep copy.
virtual void	clear ()
	calls the non-virtual emptyList().
virtual void	removeAndDelete (DtRwSensorContactInfo *contactInfo)
	If this contact info is on the list, removes it and deletes the contact info.
virtual DtRwSensorContactInfo *	findContactInfoByContactName (const DtString &contactName)
	Finds the first contact info in the list with the specified contact name, and returns a pointer to it.
virtual DtRwSensorContactInfo *	createSensorContactInfo ()
	Factory method which creates a DtRwSensorContactInfo or derivative.
virtual void	listModified ()
	Call this method after making changes to the contents of the list.
	DtSensorContactInfoList (const DtString &name, const DtSensorContactInfoList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor This is a deep copy, cloning all list items onto the new list.
	DtSensorContactInfoList (const DtSymbolString &name, const DtSensorContactInfoList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor This is a deep copy, cloning all list items onto the new list.
virtual DtSensorContactInfoList *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Complete clone of the list and all items on the list.
virtual DtSensorContactInfoList *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Complete clone of the list and all items on the list.
virtual void	addModifiedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType fcn, void *usr)
	Add/remove callbacks invoked when the list has changed, or any contents of the list have changed.
virtual void	removeModifiedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType fcn, void *usr)
	Add/remove callbacks invoked when the list has changed, or any contents of the list have changed.
Protected Member Functions
void	copyList (const DtSensorContactInfoList &orig)
	Used by constructors.
void	emptyList ()
	Removes and deletes all list elements.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a soil factor, and then reads relevant data from the stream.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
Protected Attributes
DtNoArgumentCallbackList	myModifiedCallbackList

---

Detailed Description

A reader-writer list of DtRwSensorContactInfo elements.

Use the DtRwList::add() and remove() methods to adding and removing elements. The list can be iterated though using DtList iteration methods. The list will delete all of its contents when destroyed, so use caution if holding pointers to any of the list elements.

If you need to monitor the change state of a list, use a DtSensorContactInfoListChangeMonitor.

---

Constructor & Destructor Documentation

DtSensorContactInfoList::DtSensorContactInfoList

(

)

default constructor

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

readable/writable constructor

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

virtual DtSensorContactInfoList::~DtSensorContactInfoList

(

)

[virtual]

destructor

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

copy constructor This is a deep copy, cloning all list items onto the new list.

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

copy constructor This is a deep copy, cloning all list items onto the new list.

---

Member Function Documentation

DtSensorContactInfoList& DtSensorContactInfoList::operator=

(

const DtSensorContactInfoList &

orig

)

assignment operator This is a deep copy.

All items on target list are deleted, and new items are cloned onto the list.

virtual DtSensorContactInfoList* DtSensorContactInfoList::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		[virtual]

Complete clone of the list and all items on the list.

virtual DtSensorContactInfoList* DtSensorContactInfoList::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		[virtual]

Complete clone of the list and all items on the list.

virtual void DtSensorContactInfoList::clear

(

)

[virtual]

calls the non-virtual emptyList().

virtual void DtSensorContactInfoList::removeAndDelete

(

DtRwSensorContactInfo *

contactInfo

)

[virtual]

If this contact info is on the list, removes it and deletes the contact info.

virtual DtRwSensorContactInfo* DtSensorContactInfoList::findContactInfoByContactName

(

const DtString &

contactName

)

[virtual]

Finds the first contact info in the list with the specified contact name, and returns a pointer to it.

Returns NULL if not found.

virtual DtRwSensorContactInfo* DtSensorContactInfoList::createSensorContactInfo

(

)

[virtual]

Factory method which creates a DtRwSensorContactInfo or derivative.

This class creates the base: DtRwSensorContactInfo. getData() uses this method when adding new items to the list that are read from the input file. All items on the list should be of the type created by this method. If you are adding custom data to your sensor contact information, create a derived version of DtRwSensorContactInfo, override this class and return your new sensor contact info from this method.

virtual void DtSensorContactInfoList::addModifiedCallback	(	DtNoArgumentCallbackList::DtCallbackFunctionType	fcn,
		void *	usr
	)		[virtual]

Add/remove callbacks invoked when the list has changed, or any contents of the list have changed.

Note:

If you want list modified notification in an asynchronous way, consider using a DtSensorContactInfoListChangeMonitor.

virtual void DtSensorContactInfoList::removeModifiedCallback	(	DtNoArgumentCallbackList::DtCallbackFunctionType	fcn,
		void *	usr
	)		[virtual]

Add/remove callbacks invoked when the list has changed, or any contents of the list have changed.

Note:

If you want list modified notification in an asynchronous way, consider using a DtSensorContactInfoListChangeMonitor.

virtual void DtSensorContactInfoList::listModified

(

)

[virtual]

Call this method after making changes to the contents of the list.

This will invoke the changed callbacks.

void DtSensorContactInfoList::copyList

(

const DtSensorContactInfoList &

orig

)

[protected]

Used by constructors.

void DtSensorContactInfoList::emptyList

(

)

[protected]

Removes and deletes all list elements.

Used by the destructor.

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

Constructs a soil factor, and then reads relevant data from the stream.

Implements DtRwList.

virtual const char* DtSensorContactInfoList::readerWriterType

(

)

const [protected, 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.

---

Member Data Documentation

DtNoArgumentCallbackList DtSensorContactInfoList::myModifiedCallbackList [protected]

---

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

• include/vrfutil/sensorContactInfoList.h