VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtSensorContactInfoList Class Reference

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.

Related Examples
Inheritance diagram for DtSensorContactInfoList:
Inheritance graph
[legend]

Public Member Functions

 DtSensorContactInfoList ()
 
 DtSensorContactInfoList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtSensorContactInfoList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtSensorContactInfoList ()
 
DtSensorContactInfoList & operator= (const DtSensorContactInfoList &orig)
 
virtual void clear ()
 
virtual void removeAndDelete (DtRwSensorContactInfo *contactInfo)
 
virtual DtRwSensorContactInfo * findContactInfoByContact (const DtUUID &contact) const
 
virtual std::set< DtUUID > contacts () const
 
virtual DtRwSensorContactInfo * createSensorContactInfo ()
 
virtual void listModified ()
 
bool operator== (const DtSensorContactInfoList &) const
 
virtual const char * xmlType () const
 
 DtSensorContactInfoList (const DtString &name, const DtSensorContactInfoList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtSensorContactInfoList (const DtSymbolString &name, const DtSensorContactInfoList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual DtSensorContactInfoList * clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual DtSensorContactInfoList * clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual void addModifiedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType fcn, void *usr)
 
virtual void removeModifiedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType fcn, void *usr)
 
- Public Member Functions inherited from DtRwList
 DtRwList ()
 
 DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRwList ()
 
const DtRwList & operator= (const DtRwList &orig)
 
virtual DtListItem * add (DtReaderWriter *data)
 
virtual DtListItem * addWithAlternateName (DtReaderWriter *data, const DtString &name)
 
virtual DtListItem * addToStart (DtReaderWriter *data)
 
virtual DtListItem * addToEnd (DtReaderWriter *data)
 
virtual void * remove (DtReaderWriter *data, DtListItem *item)
 
virtual DtlObjPtr getLocalData (DtlObjPtr args)
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual DtListItem * addBefore (DtReaderWriter *data, DtReaderWriter *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtReaderWriter *after)
 
virtual void removeAll ()
 
virtual void removeAndDeleteAll ()
 
virtual void reset ()
 
bool operator== (const DtRwList &rhs) const
 
bool operator!= (const DtRwList &rhs) const
 
virtual void populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
virtual void populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
 DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtString &before)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtSymbolString &before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtString &after)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtSymbolString &after)
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual std::set< DtString > supportedXmlTypes () const
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriter & operator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContainer & aliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual DtString prettyPrint () const
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType > 		unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriter * defaultRWValue () const
 
virtual DtReaderWriter * defaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistry & registry () const
 
DtReaderWriterRegistry & registry ()
 
virtual DtPropertyInterface * property ()
 
virtual const DtPropertyInterface * property () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindings * generateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Static Public Member Functions

static const char * theXmlType ()
 
- Static Public Member Functions inherited from DtRwList
static const char * theXmlType ()
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList & 		nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const char * theXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactory * factory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWriter * createFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWriter * createFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWriter * createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Member Functions

void copyList (const DtSensorContactInfoList &orig)
 
void emptyList ()
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual const char * readerWriterType () const
 
- Protected Member Functions inherited from DtRwList
virtual DtListItem * addBefore (DtReaderWriter *data, DtListItem *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtListItem *after)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

DtNoArgumentCallbackList myModifiedCallbackList
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistry * myParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWriter * myDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

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::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString > 		DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- 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
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

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 
) const
virtual

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

virtual DtSensorContactInfoList* DtSensorContactInfoList::clone ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL 
) const
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::findContactInfoByContact ( const DtUUID &  contact) const
virtual

Finds the first contact info in the list with the specified contact, and returns a pointer to it. Returns NULL if not found. Was; findContactInfoByContactName.

virtual std::set<DtUUID> DtSensorContactInfoList::contacts ( ) const
virtual

Returns a set of all the contacts in the list Was: contactNames.

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
static const char* DtSensorContactInfoList::theXmlType ( )
static

The type that is used when archiving to an XML stream.

virtual const char* DtSensorContactInfoList::xmlType ( ) const
inlinevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwList.

References DtRwList::theXmlType().

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 DtReaderWriter::SearchPaths &  searchPaths,
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:
Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)