![]() |
VR-Forces 4.7 Class Documentation
|
DtRemoteConfigurationMapper. More...

Public Types | |
| typedef DtRemoteConfigurationMapEntry *(* | CreatorFcn )() |
| Factory function signature. | |
| typedef std::list< std::pair < DtObjectType, DtRemoteConfigurationMapEntry * > > | ObjTypeList |
| Object Type list. | |
| typedef ObjTypeList::iterator | ObjTypeIterator |
| typedef ObjTypeList::const_iterator | const_ObjTypeIterator |
| typedef std::map < DtEntityIdentifier, DtRemoteConfigurationMapEntry * > | EntIdMap |
| Entity Identifier list. | |
| typedef EntIdMap::iterator | EntIdIterator |
| typedef EntIdMap::const_iterator | const_EntIdIterator |
| typedef std::map< std::string, DtRemoteConfigurationMapEntry * > | MarkingTextMap |
| Marking Text list. | |
| typedef MarkingTextMap::iterator | MarkingTextIterator |
| typedef MarkingTextMap::const_iterator | const_MarkingTextIterator |
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 | |
| DtRemoteConfigurationMapper () | |
| CTOR. | |
| DtRemoteConfigurationMapper (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| CTOR. | |
| DtRemoteConfigurationMapper (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| CTOR. | |
| DtRemoteConfigurationMapper (const DtString &name, const DtRemoteConfigurationMapper &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Copy constructor. | |
| DtRemoteConfigurationMapper (const DtSymbolString &name, const DtRemoteConfigurationMapper &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Copy constructor. | |
| DtRemoteConfigurationMapper & | operator= (const DtRemoteConfigurationMapper &orig) |
| Assignment operator. | |
| virtual | ~DtRemoteConfigurationMapper () |
| Destructor. | |
| virtual bool | add (DtRemoteConfigurationMapEntry *pEntry) |
| Add an entry to the list. | |
| virtual void | clear () |
| empty the lists | |
| virtual unsigned | count () const |
| returns the total number of entries across the lists | |
| virtual void | copyLists (const DtRemoteConfigurationMapper &orig) |
| copy the lists | |
| DtRemoteConfigurationMapper::EntIdMap & | entityIdentifierMap () |
| Return entity identifier list. | |
| const DtRemoteConfigurationMapper::EntIdMap & | entityIdentifierMap () const |
| virtual DtRemoteConfigurationMapEntry * | find (const DtEntityIdentifier &id) |
| Search for exact match by entity identifier, return NULL if not found. | |
| virtual const DtRemoteConfigurationMapEntry * | find (const DtEntityIdentifier &id) const |
| virtual DtRemoteConfigurationMapEntry * | find (const DtObjectType &objType) |
| search for closest match by object type, return null if not found | |
| virtual const DtRemoteConfigurationMapEntry * | find (const DtObjectType &objType) const |
| virtual DtRemoteConfigurationMapEntry * | find (const char *pMarkingText) |
| Search for exact match (case sensitive) to marking text, return NULL if not found. | |
| virtual const DtRemoteConfigurationMapEntry * | find (const char *pMarkingText) const |
| DtRemoteConfigurationMapper::ObjTypeList & | objectTypeList () |
| Return object type list. | |
| const DtRemoteConfigurationMapper::ObjTypeList & | objectTypeList () const |
| DtRemoteConfigurationMapper::MarkingTextMap & | markingTextMap () |
| Return marking text list. | |
| const DtRemoteConfigurationMapper::MarkingTextMap & | markingTextMap () const |
| virtual bool | readFile (const DtFilename &fname, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Loads the file. | |
| virtual void | remove (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true) |
| Remove a node from the list (based on attach-by type), and optionally, delete the entry that was found. | |
| DtRemoteConfigurationMapper::CreatorFcn | creatorFcn () const |
| factory function to create entries | |
| void | setCreatorFcn (DtRemoteConfigurationMapper::CreatorFcn fcn) |
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) | |
| pseudo-copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| 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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| virtual void | writeSelf (std::string &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 void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. | |
| 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 const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| std::string | debugText () const |
| 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 bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. | |
| 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 | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| 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) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. | |
Protected Member Functions | |
| virtual bool | addByEntityId (DtRemoteConfigurationMapEntry *pEntry) |
| Add an entry to myEntityIdMap. | |
| virtual bool | addByObjectType (DtRemoteConfigurationMapEntry *pEntry) |
| Add an entry to myObjTypeList. | |
| virtual bool | addByMarkingText (DtRemoteConfigurationMapEntry *pEntry) |
| Add an entry to MarkingTextMap. | |
| virtual bool | addByOther (DtRemoteConfigurationMapEntry *pEntry) |
| Add an entry to a custom list. | |
| virtual const DtRemoteConfigurationMapEntry * | findBestMatch (const DtObjectType &objtype) const |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Override getData to parse out attachment entries. | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. | |
| virtual void | removeByEntityId (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true) |
| Remove an entry from myEntityIdMap. | |
| virtual void | removeByObjectType (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true) |
| Remove an entry from myObjTypeList. | |
| virtual void | removeByMarkingText (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true) |
| Remove an entry from MarkingTextMap. | |
| virtual void | removeByOther (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true) |
| Remove an entry from a custom list. | |
Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
Protected Attributes | |
| EntIdMap | myEntityIdMap |
| CreatorFcn | myEntryCreatorFcn |
| ObjTypeList | myObjTypeList |
| MarkingTextMap | myMarkingTextMap |
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 |
| Container for the aliases which represent alternative names for the object. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. | |
Additional Inherited Members | |
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 () |
| The type that is used when archiving to an XML stream. | |
| 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 void | cleanupFactory () |
| static DtReaderWriterFactory * | factory () |
| static void | setOutputStream (DtOutputStream *stream) |
| static DtOutputStream & | outputStream () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| Given a filename, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. | |
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 |
This is a container of DtRemoteConfigurationMapEntry.
| typedef std::list< std::pair<DtObjectType,DtRemoteConfigurationMapEntry*> > DtRemoteConfigurationMapper::ObjTypeList |
Object Type list.
| typedef ObjTypeList::iterator DtRemoteConfigurationMapper::ObjTypeIterator |
| typedef ObjTypeList::const_iterator DtRemoteConfigurationMapper::const_ObjTypeIterator |
| typedef std::map<DtEntityIdentifier,DtRemoteConfigurationMapEntry*> DtRemoteConfigurationMapper::EntIdMap |
Entity Identifier list.
| typedef EntIdMap::iterator DtRemoteConfigurationMapper::EntIdIterator |
| typedef EntIdMap::const_iterator DtRemoteConfigurationMapper::const_EntIdIterator |
| typedef std::map<std::string,DtRemoteConfigurationMapEntry*> DtRemoteConfigurationMapper::MarkingTextMap |
Marking Text list.
| typedef MarkingTextMap::iterator DtRemoteConfigurationMapper::MarkingTextIterator |
| typedef MarkingTextMap::const_iterator DtRemoteConfigurationMapper::const_MarkingTextIterator |
| typedef DtRemoteConfigurationMapEntry*(* DtRemoteConfigurationMapper::CreatorFcn)() |
Factory function signature.
| DtRemoteConfigurationMapper::DtRemoteConfigurationMapper | ( | ) |
CTOR.
| DtRemoteConfigurationMapper::DtRemoteConfigurationMapper | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| bool | readonly = false |
||
| ) |
CTOR.
| DtRemoteConfigurationMapper::DtRemoteConfigurationMapper | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| bool | readonly = false |
||
| ) |
CTOR.
| DtRemoteConfigurationMapper::DtRemoteConfigurationMapper | ( | const DtString & | name, |
| const DtRemoteConfigurationMapper & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Copy constructor.
| DtRemoteConfigurationMapper::DtRemoteConfigurationMapper | ( | const DtSymbolString & | name, |
| const DtRemoteConfigurationMapper & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Copy constructor.
|
virtual |
Destructor.
| DtRemoteConfigurationMapper& DtRemoteConfigurationMapper::operator= | ( | const DtRemoteConfigurationMapper & | orig | ) |
Assignment operator.
|
virtual |
Add an entry to the list.
Adds the entry to the list, based upon it's "attach by" type. Returns true if added, false if not. Addition will replace and delete prior entries that have an exact match to the attachment criterion. If attach by type is not understood, the entry will not be added, and false will be returned. If false is returned, it is up to the caller to delete pEntry.
|
virtual |
empty the lists
|
virtual |
returns the total number of entries across the lists
|
virtual |
copy the lists
|
inline |
Return entity identifier list.
References myEntityIdMap.
|
inline |
References myEntityIdMap.
|
virtual |
Search for exact match by entity identifier, return NULL if not found.
|
virtual |
|
virtual |
search for closest match by object type, return null if not found
|
virtual |
|
virtual |
Search for exact match (case sensitive) to marking text, return NULL if not found.
|
virtual |
|
inline |
Return object type list.
References myObjTypeList.
|
inline |
References myObjTypeList.
|
inline |
Return marking text list.
References myMarkingTextMap.
|
inline |
References myMarkingTextMap.
|
virtual |
Loads the file.
|
virtual |
Remove a node from the list (based on attach-by type), and optionally, delete the entry that was found.
Given pEntry, search the lists for a node, based on pEntry->attachByType(). If that node is found, remove it. If bDelete is true, the DtRemoteConfigurationMapEntry* stored with the node will be deleted. If that pointer is the same as pEntry, pEntry will the point to invalid memory.
|
inline |
factory function to create entries
References myEntryCreatorFcn.
|
inline |
References myEntryCreatorFcn.
|
protectedvirtual |
Add an entry to myEntityIdMap.
|
protectedvirtual |
Add an entry to myObjTypeList.
|
protectedvirtual |
Add an entry to MarkingTextMap.
|
protectedvirtual |
Add an entry to a custom list.
Add the entry to a custom list. This requires derivation of DtRemoteConfigurationMapper, and an override of addByOther() to understand how to add the entry. The base class deletes pEntry if true.
|
protectedvirtual |
|
protectedvirtual |
Override getData to parse out attachment entries.
Reimplemented from DtReaderWriter.
|
protectedvirtual |
Deriving class overrides these to get/put class specific data.
Reimplemented from DtReaderWriter.
|
protectedvirtual |
Remove an entry from myEntityIdMap.
|
protectedvirtual |
Remove an entry from myObjTypeList.
|
protectedvirtual |
Remove an entry from MarkingTextMap.
|
protectedvirtual |
Remove an entry from a custom list.
Remove the entry to a custom list. This requires derivation of DtRemoteConfigurationMapper, and an override of removeByOther() to understand how to remove the entry. The base class does nothing.
|
protected |
Referenced by entityIdentifierMap().
|
protected |
Referenced by creatorFcn(), and setCreatorFcn().
|
protected |
Referenced by objectTypeList().
|
protected |
Referenced by markingTextMap().