![]() |
VR-Forces Developer's Guide
|

Public Types | |
| typedef DtRwTemplatedPair < KeyType, ValType > | RwPairType |
| typedef std::map< KeyType, ValType >::iterator | iterator |
| typedef std::map< KeyType, ValType >::const_iterator | const_iterator |
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 )() |
Public Member Functions | |
| DtRwTemplatedMapPtr () | |
| DtRwTemplatedMapPtr (const DtRwTemplatedMapPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwTemplatedMapPtr & | operator= (const DtRwTemplatedMapPtr &orig) |
| virtual | ~DtRwTemplatedMapPtr () |
| virtual void | removeAndDeleteAll () |
| DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual void | prePutSelf () |
| virtual void | postGetSelf () |
| virtual void | setFromMap (const std::map< KeyType, ValType > sourceMap) |
| virtual void | swap (DtRwTemplatedMapPtr &other) |
| virtual const std::map < KeyType, ValType > & | convertToMap () const |
| virtual void | clear () |
| virtual unsigned | size () const |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| const char * | readerWriterType () const |
| DtRwTemplatedMapPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, const DtString &keyName="key", const DtString &valueName="value", const DtString &elementName="item") | |
| DtRwTemplatedMapPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, const DtString &keyName="key", const DtString &valueName="value", const DtString &elementName="item") | |
| DtRwTemplatedMapPtr (const DtString &name, const DtRwTemplatedMapPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwTemplatedMapPtr (const DtSymbolString &name, const DtRwTemplatedMapPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual iterator | begin () |
| virtual const_iterator | begin () const |
| virtual iterator | end () |
| virtual const_iterator | end () const |
| std::pair< iterator, bool > | insert (const RwPairType &item) |
| std::pair< iterator, bool > | insert (const KeyType &key, const ValType &val) |
| void | erase (iterator pos) |
| void | erase (const KeyType &key) |
| virtual iterator | find (const KeyType &key) |
| virtual const_iterator | find (const KeyType &key) const |
| virtual iterator | lower_bound (const KeyType &key) |
| virtual const_iterator | lower_bound (const KeyType &key) const |
| virtual iterator | upper_bound (const KeyType &key) |
| virtual const_iterator | upper_bound (const KeyType &key) const |
| bool | operator== (const DtRwTemplatedMapPtr &) const |
| bool | operator!= (const DtRwTemplatedMapPtr &) const |
| virtual const DtString & | keyName () const |
| virtual void | setKeyName (const DtString &keyName) |
| virtual const DtString & | elementName () const |
| virtual void | setElementName (const DtString &e) |
| virtual const DtString & | valueName () const |
| virtual void | setValueName (const DtString &valName) |
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 | 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 | 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 &) |
| 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 const char * | ListReaderWriterType () |
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 Attributes | |
| DtString | myXmlType |
| std::map< KeyType, ValType > | myMap |
| DtString | myElementName |
| DtString | myKeyName |
| DtString | myValueName |
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 | |
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) |
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 |
| typedef DtRwTemplatedPair<KeyType, ValType> DtRwTemplatedMapPtr< KeyType, ValType >::RwPairType |
| typedef std::map<KeyType, ValType>::iterator DtRwTemplatedMapPtr< KeyType, ValType >::iterator |
| typedef std::map<KeyType, ValType>::const_iterator DtRwTemplatedMapPtr< KeyType, ValType >::const_iterator |
| DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr | ( | ) |
default constructor
| DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| const DtString & | keyName = "key", |
||
| const DtString & | valueName = "value", |
||
| const DtString & | elementName = "item" |
||
| ) |
real constructors
| DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| const DtString & | keyName = "key", |
||
| const DtString & | valueName = "value", |
||
| const DtString & | elementName = "item" |
||
| ) |
real constructors
| DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr | ( | const DtString & | name, |
| const DtRwTemplatedMapPtr< KeyType, ValType > & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Invokes DtReaderWriter copy constructor. Elements are copied using their standard copy constructor.
| DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr | ( | const DtSymbolString & | name, |
| const DtRwTemplatedMapPtr< KeyType, ValType > & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Invokes DtReaderWriter copy constructor. Elements are copied using their standard copy constructor.
| DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr | ( | const DtRwTemplatedMapPtr< KeyType, ValType > & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
... and make sure the default constructor is overridden:
|
virtual |
Destructor.
| DtRwTemplatedMapPtr& DtRwTemplatedMapPtr< KeyType, ValType >::operator= | ( | const DtRwTemplatedMapPtr< KeyType, ValType > & | orig | ) |
Assignment operator.
|
virtual |
Removes and deletes all entries in the rwlist.
Reimplemented from DtRwList.
|
virtual |
This method must be overridden by a subclass. Within this method, new instances of the DtReaderWriter subclass that is being handled by this list must be created, and then retrieved from the mtl stream, using the getSelf member of that item.
Implements DtRwList.
|
virtual |
Before putting self, update RwList to match our internal map.
Reimplemented from DtReaderWriter.
|
virtual |
After getting self, update internal map to match our RwList.
Reimplemented from DtReaderWriter.
Reimplemented in makVrf::DtArticulatedPartStateRepository::DtArtPartMap.
|
virtual |
Clears the contents of this map, and sets new contents from the values in the std::map.
|
virtual |
Swaps the contents of this map with the other map.
|
virtual |
The current contents of this map as a std::map.
|
inlinevirtual |
Clears all elements from the map.
|
inlinevirtual |
Returns the size of the map.
|
inlinevirtual |
Returns an iterator to the first element in the map.
|
inlinevirtual |
Returns an iterator to the first element in the map.
|
inlinevirtual |
Returns an iterator to the element following the last element in the map.
|
inlinevirtual |
Returns an iterator to the element following the last element in the map.
| std::pair<iterator, bool> DtRwTemplatedMapPtr< KeyType, ValType >::insert | ( | const RwPairType & | item | ) |
Insert a new item into the map.
| std::pair<iterator, bool> DtRwTemplatedMapPtr< KeyType, ValType >::insert | ( | const KeyType & | key, |
| const ValType & | val | ||
| ) |
Insert a new item into the map.
|
inline |
Removes an existing item from the map.
|
inline |
Removes an existing item from the map.
|
inlinevirtual |
Finds the element with the key equivalent to the key.
|
inlinevirtual |
Finds the element with the key equivalent to the key.
|
inlinevirtual |
Finds the first element that is not less than the key.
|
inlinevirtual |
Finds the first element that is not less than the key.
|
inlinevirtual |
Finds the first element that is greater than the key.
|
inlinevirtual |
Finds the first element that is greater than the key.
| bool DtRwTemplatedMapPtr< KeyType, ValType >::operator== | ( | const DtRwTemplatedMapPtr< KeyType, ValType > & | ) | const |
Equivalence operators.
| bool DtRwTemplatedMapPtr< KeyType, ValType >::operator!= | ( | const DtRwTemplatedMapPtr< KeyType, ValType > & | ) | const |
Equivalence operators.
|
inlinevirtual |
The RW name of the keys in this map.
Referenced by DtRwTemplatedMapPtr< DtRwString, DtRwInt >::setKeyName().
|
inlinevirtual |
The RW name of the keys in this map.
|
inlinevirtual |
Accessor/mutator for myElementName.
|
inlinevirtual |
Accessor/mutator for myElementName.
|
inlinevirtual |
The RW name of the values in this map.
|
inlinevirtual |
The RW name of the values in this map.
|
inlinestatic |
Referenced by DtRwTemplatedMapPtr< DtRwString, DtRwInt >::xmlType().
|
inlinevirtual |
Routines to archive/dearchive from an XML Environment.
Reimplemented from DtRwList.
Referenced by DtRwTemplatedMapPtr< DtRwString, DtRwInt >::theXmlType().
|
virtual |
Routine to return a human readable form of the reader/writer variable. Not all reader/writer classes implement this feature. Default is to return an empty string.
Reimplemented from DtReaderWriter.
|
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.
|
static |
|
protected |
|
protected |
Referenced by DtRwTemplatedMapPtr< DtRwString, DtRwInt >::begin(), DtRwTemplatedMapPtr< DtRwString, DtRwInt >::clear(), DtRwTemplatedMapPtr< DtRwString, DtRwInt >::end(), DtRwTemplatedMapPtr< DtRwString, DtRwInt >::erase(), DtRwTemplatedMapPtr< DtRwString, DtRwInt >::find(), DtRwTemplatedMapPtr< DtRwString, DtRwInt >::lower_bound(), DtRwTemplatedMapPtr< DtRwString, DtRwInt >::size(), and DtRwTemplatedMapPtr< DtRwString, DtRwInt >::upper_bound().
|
protected |
The name to write out for each element. By default this is "item" but, when reading this from a file, will be set to the first element name read.
Referenced by DtRwTemplatedMapPtr< DtRwString, DtRwInt >::elementName(), and DtRwTemplatedMapPtr< DtRwString, DtRwInt >::setElementName().
|
protected |
|
protected |