DtSensorContactInfoList Class Reference

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

Inheritance diagram for DtSensorContactInfoList:

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 std::set< DtString >	contactNames () const
	Returns a set of all the contact names in the list.
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.
bool	operator== (const DtSensorContactInfoList &) const
	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.
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
bool	operator!= (const DtRwList &rhs) const
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
	Add element to the list just after the indicated item.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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 Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtNoArgumentCallbackList	myModifiedCallbackList

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

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 std::set<DtString> DtSensorContactInfoList::contactNames ( ) const

virtual

Returns a set of all the contact names in the list.

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.

bool DtSensorContactInfoList::operator==

(

const DtSensorContactInfoList &

)

const

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  )

protectedvirtual

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

Implements DtRwList.

virtual const char* DtSensorContactInfoList::readerWriterType ( ) const

protectedvirtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/sensorContactInfoList.h