Public Member Functions |
| virtual const char * | readerWriterType () const |
| | Used to supply a string type that this reader writer type is.
|
| virtual const char * | xmlType () const |
| DtRwPropertiesMap & | operator= (const DtRwPropertiesMap &) |
| virtual bool | isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const |
| | Returns true if the prototype and key are the same types.
|
| bool | operator== (const DtRwPropertiesMap &) const |
|
| | DtRwPropertiesMap (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwPropertiesMap (const DtString &name, const DtString &keyType, const DtPropertyInterface *prototype, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwPropertiesMap (const DtString &name, const DtRwPropertiesMap &orig, DtReaderWriterRegistry *parentRegistry=0) |
| virtual | ~DtRwPropertiesMap () |
|
Finds the item with the specified key.
Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.
propertiesMap.findItem("Some Resource"));
|
| virtual DtPropertyInterface * | findItem (const DtString &key) |
| virtual DtPropertyInterface * | findItem (int key) |
| |
|
| virtual DtPropertyInterface * | findItem (double key) |
| |
|
| virtual const DtPropertyInterface * | findItem (const DtString &key) const |
| |
|
| virtual const DtPropertyInterface * | findItem (int key) const |
| |
|
| virtual const DtPropertyInterface * | findItem (double key) const |
| |
|
| template<typename ValueType > |
| boost::optional< ValueType > | findItemValue (const DtString &key) const |
| | Finds the value of the item with the specified key.
|
| template<typename ValueType > |
| boost::optional< ValueType > | findItemValue (int key) const |
| | Finds the value of the item with the specified key.
|
| template<typename ValueType > |
| boost::optional< ValueType > | findItemValue (double key) const |
| | Finds the value of the item with the specified key.
|
|
Insertion functions for adding a new item to the map.
Will fail if the type of the key does not match the type of myKeyType or if the type of the item does not match the type of myPrototype. If an element with that key already exists, it will not be replaced. If the item is added, the map takes ownership of it. Returns a bool indicating whether the insertion took place.
bool wasAdded = propertiesMap.insert("Num Soldiers", newItem);
|
| virtual bool | insert (const DtString &key, DtPropertyInterface *item) |
| virtual bool | insert (int key, DtPropertyInterface *item) |
| virtual bool | insert (double key, DtPropertyInterface *item) |
|
Adds a new item to the map of the same type as myPrototype that has the specified key.
Returns this item so that it may be set by the caller. If the key is of the wrong type then
nothing is added and the returned pointer will be null. If an item with this key already
exists, then nothing is added and the returned pointer will be null.
@code
DtRwPropertiesStructure* newItem = static_cast<DtRwPropertiesStructure*>(propertiesMap.add("Some Resource")); newItem->findAndSetPropertyValue<int>("Count", 4);
|
| virtual DtPropertyInterface * | addItem (const DtString &key) |
| virtual DtPropertyInterface * | addItem (int key) |
| virtual DtPropertyInterface * | addItem (double key) |
|
Erases the item with the specified key.
Returns true if the item was found and erased. May also erase using an iterator to the item, as implemented in DtRwPropertiesList.
propertiesMap.erase("Num Soldiers");
|
| virtual bool | erase (const DtString &key) |
| virtual bool | erase (int key) |
| virtual bool | erase (double key) |
|
These operator[] overloads allow you to access a map item by common key types.
If the item does not exist, a new one will be added of the same type as the prototype. These allow you to index by common basic key types without necessarily converting the key to a DtPropertyInterface to call findItem. If the key is of the wrong type an uninitialized copy of the prototype will be returned that is not part of the map, so care must be taken.
boost::optional<int> val = propertiesMap["Num Soldiers"].propertyValue<int>();
if (val)
{
int newVal = *val + 1;
propertiesMap["Num Soldiers"].setPropertyValue<int>(4);
}
|
| DtPropertyInterface & | operator[] (const DtString &key) |
| const DtPropertyInterface & | operator[] (const DtString &key) const |
| DtPropertyInterface & | operator[] (double key) |
| const DtPropertyInterface & | operator[] (double key) const |
| DtPropertyInterface & | operator[] (int key) |
| const DtPropertyInterface & | operator[] (int key) const |
|
| virtual void | setKeyType (const DtString &) |
| | Sets/gets the key type.
|
| virtual const DtReaderWriter * | keyType () const |
|
| virtual bool | keyIsInt () const |
| | Returns the type of key.
|
| virtual bool | keyIsReal () const |
| virtual bool | keyIsString () const |
| virtual char * | encode (char *) const |
| | Encodes the variable bindings into the supplied buffer.
|
| virtual const char * | decode (const char *) |
| | Decodes the variable bindings from the specified buffer.
|
| virtual bool | isValidProperty (const DtPropertyInterface *) const |
| | Returns true if this is a valid property for the properties list.
|
| virtual int | count () const |
| | Returns the number of valid items in this list.
|
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| | Reads in items, using the factory to read the correct types.
|
| virtual void | writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| | Writes out registry data, but includes the type strings when writing.
|
| virtual void | writeData (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| virtual void | setPrototype (const DtPropertyInterface *) |
| | Sets the prototype for this list. Will be cloned and kept as part of this object.
|
| virtual const DtPropertyInterface * | prototype () const |
| | Returns the prototype for this list.
|
| virtual DtPropertyInterface * | clonePrototype (DtReaderWriterRegistry *parent=0) |
| | Returns a clone of the prototype that belongs to this list.
|
| DtRwPropertiesList & | operator= (const DtRwPropertiesList &) |
| virtual void | getSize (int &size) const |
| | Gets the size, in bytes, of this item.
|
| bool | operator== (const DtRwPropertiesList &) const |
| virtual bool | matchPrototype (const DtReaderWriter *) const |
| | DtRwPropertiesList (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwPropertiesList (const DtString &name, const DtPropertyInterface *prototype, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwPropertiesList (const DtString &name, const DtRwPropertiesList &orig, DtReaderWriterRegistry *parentRegistry=0) |
| virtual | ~DtRwPropertiesList () |
| virtual bool | addItem (DtPropertyInterface *item) |
| virtual DtPropertyInterface * | addItem () |
| | Adds a new item to the end of the list of the same type as myPrototype.
|
| virtual void | erase (DtPropertyInterface *item) |
| virtual void | erase (iterator pos) |
| | Erases the item at the specified iterator position.
|
| DtRwProperties & | operator= (const DtRwProperties &orig) |
| virtual | ~DtRwProperties () |
| virtual unsigned | size () const |
| | Returns the number of items in the list.
|
| virtual bool | addProperty (DtPropertyInterface *) |
| | Adds an existing property to this list. This class will then take ownership of the property.
|
| virtual DtPropertyInterface * | createProperty (DtlObjPtr args, DtReaderWriterRegistry *parentRegistry) |
| | Creates a property from the mtl stream.
|
| virtual void | copyVariables (const DtRwVariableBindings &other) |
| | Clones variables using the property factory.
|
| virtual bool | isReadonly () const |
| virtual int | hlaAlignment () const |
| | The required byte alignment of this property when encoding to HLA.
|
| virtual int | requiredPadding (const char *buf, const DtPropertyInterface *field) const |
| | The number of padding bytes required before writing the given field to the buffer for HLA encoding.
|
| virtual const char * | propertyType () const |
| | Typically returns reader/writer type.
|
| virtual DtString | stringRep (const DtString &root="") const |
| virtual bool | merge (const DtPropertyInterface &target, MergeFlags, const DtMergePath &path=DtMergePath(), const std::set< DtString > &ignore=std::set< DtString >()) |
| | Takes the contents of the supplied properties and merges with the following rules if replace is false: 1) If the same named property of the same type (and prototype and key) exists regardless of what the contents are in this property, it is replaced with the contents of the target 2) If a property in the target does not exist in source, it is not merged in 3) All other items are kept in the source.
|
| virtual DtRwProperties | createFromPercentages (const DtRwProperties &percentages, const DtRwProperties &baseValues, const DtString &base="Base-") |
| | This will take the supplied list of variable percentages and create a new state properties list that is the percentage of the "Base" value multiplied by the supplied percentage.
|
| virtual bool | findRootAndVariable (const DtString &varName, DtReaderWriter *&root, DtReaderWriter *&variable) const |
| | In this structure find the variable matching the name and the root that contains the variable.
|
| virtual DtSymbolString | propertyName () const |
| | The name of this property.
|
| virtual void | setPropertyName (const DtString &propertyName) |
| | Sets name of this property. Should generally only be called when initially created.
|
| virtual bool | wasUpdatedSince (DtTime t) const |
| | Returns true if an update occurred since the specified time.
|
| virtual void | clearVariables () |
| | Removes and deletes all variable items.
|
| virtual void | reset () |
| | Clears all variables.
|
| virtual void | invalidateCache () |
| | Invalidates the entire cache.
|
| virtual void | invalidateCacheForProperty (const DtString &propName) |
| | Invalidates the single cache entry for the given property name.
|
| virtual bool | setWritePrototypeHeader (bool) |
| virtual bool | writePrototypeHeader () const |
| | DtRwProperties (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwProperties (const DtString &name, const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwProperties (const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0) |
| virtual const_iterator | begin () const |
| virtual iterator | begin () |
| virtual const_iterator | end () const |
| virtual iterator | end () |
| virtual const DtPropertyInterface * | findPropertyInterface (const DtString &propertyName) const |
| virtual DtPropertyInterface * | findPropertyInterface (const DtString &propertyName) |
| virtual bool | removeProperty (const DtString &propertyName) |
| virtual bool | removeProperty (const DtPropertyInterface *property) |
| virtual const DtReaderWriter * | findPropertyRw (const DtString &propName) const |
| | Returns the ReaderWriter for the (first) property that matches the given property name.
|
| virtual DtReaderWriter * | findPropertyRw (const DtString &propName) |
| virtual DtReaderWriter * | readerWriter () |
| virtual const DtReaderWriter * | readerWriter () const |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual bool | isPublished () const |
| | Whether this property should be published.
|
| virtual void | setIsPublished (bool isPub) |
| virtual unsigned | disRecordType () const |
| | If this property is published, which DIS record type should it use.
|
| virtual void | setDisRecordType (unsigned recType) |
| virtual void | removeVariable (DtReaderWriter *) |
| virtual void | removeVariable (const DtReaderWriter *) |
| | DtRwVariableBindings (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwVariableBindings (const DtString &name, const DtRwVariableBindings &orig, DtReaderWriterRegistry *parentRegistry=0, bool copyVariables=true) |
| | DtRwVariableBindings (const DtRwVariableBindings &orig, DtReaderWriterRegistry *parentRegistry=0, bool copyVariables=true) |
| DtRwVariableBindings & | operator= (const DtRwVariableBindings &orig) |
| virtual | ~DtRwVariableBindings () |
| template<typename RW_Type > |
| const RW_Type * | findAndCastVariableBinding (const DtString &variableName) const |
| virtual DtReaderWriter * | addVariableBinding (const DtSymbolString &name, const char *type) |
| | Adds new variable binding to registry.
|
| virtual void | addVariable (DtReaderWriter *) |
| | Adds a newly created DtReaderWriter variable to the registry.
|
| virtual int | getSize () const |
| | Returns the size of this item, in bytes, iterating over all types.
|
| bool | operator== (const DtRwVariableBindings &) const |
| bool | operator!= (const DtRwVariableBindings &) const |
| virtual DtString | prettyPrint () const |
| | Routine to return a human readable form of the reader/writer variable.
|
| virtual void | setVariableSubstitutions (const std::map< DtString, DtString > &) |
virtual const std::map
< DtString, DtString > & | variableSubstitutions () const |
| virtual void | merge (const DtRwVariableBindings &) |
| | Will take the contents of the supplied variable bindings and merge in both the variables (ignoring ones that already exist) and the variable substitutions.
|
| virtual const DtReaderWriter * | findVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const |
| | Looks for the specified name/type combination in the registry, and returns a pointer to that RW object if it is found.
|
| virtual DtReaderWriter * | findVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) |
| virtual const DtReaderWriter * | findVariableBinding (const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const |
| | Finds the variable with the given name regardless of type.
|
| virtual DtReaderWriter * | findVariableBinding (const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) |
| | 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 | 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 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.
|
| 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.
|
| 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 | 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 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 | 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 | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| | Called when the item is a variable reference.
|
| virtual | ~DtPropertyInterface () |
| int | getSize () const |
| virtual bool | isPublishedArg (DtlObjPtr arg, unsigned &disVarRecType) const |
| | Tests whether the argument specified indicates this property should be published.
|
| template<typename ValueType > |
| boost::optional< ValueType > | propertyValue () const |
| template<typename ValueType > |
| bool | setPropertyValue (ValueType val) |
| | Sets the value of this property.
|
| template<typename SpecificPropType > |
| const SpecificPropType * | findProperty (const DtString &propertyName) const |
| template<typename SpecificPropType > |
| SpecificPropType * | findProperty (const DtString &propertyName) |
| template<typename ValueType > |
| boost::optional< ValueType > | findPropertyValue (const DtString &propertyName) const |
| template<typename ValueType > |
| bool | findAndSetPropertyValue (const DtString &propertyName, ValueType val) |
| | This is a convenience function that combines the functionality of findProperty and setPropertyValue to immediately set the value of the property with the given name, assuming it can be found within this property and its value can be converted from the specified type.
|
| template<typename SpecificPropType > |
| SpecificPropType * | addNewProperty (const DtString &propertyName) |
| | Adds a new property of the specified type and returns pointer to the new item.
|
Protected Member Functions |
| virtual bool | convertKeyToString (int key, DtString &str) const |
| | Convert the given int key to a DtString. If not possible, returns false.
|
| virtual bool | convertKeyToString (double key, DtString &str) const |
| | Convert the given double key to a DtString. If not possible, returns false.
|
| virtual bool | convertStringToKey (const DtString &str, int &key) const |
| | Convert the given DtString to an int key. If not possible, returns false.
|
| virtual bool | convertStringToKey (const DtString &str, double &key) const |
| | Convert the given DtString to a double key. If not possible, returns false.
|
| virtual DtPropertyInterface * | createPrototype (DtlObjPtr args) |
| | Get the key type before processing the rest of the items.
|
| virtual DtlObjPtr | variablesStart (DtlObjPtr args) const |
| virtual int | hlaAlignment (const DtPropertyInterface *field) const |
| | Need to add in padding for key.
|
| virtual void | getSize (const DtPropertyInterface *, int &size) const |
| | Returns the size, in bytes, of the readerWriter item plus the key.
|
| virtual void | createListEntry (DtPropertyInterface *iFace, DtlObjPtr variableItem, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual char * | encode (const DtPropertyInterface *, char *buf) const |
| virtual const char * | decode (DtPropertyInterface *iFace, const char *buf) |
| | Decodes the variable bindings from the specified buffer.
|
| virtual void | getData (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| | Gets data from the environment value.
|
| virtual void | putData (DtEnvironmentSP env, DtEnvValueSP value) const |
| | Override to add attributes of actual data.
|
| virtual void | postWriteItem (std::string &fp, DtReaderWriter *rw, int indentLevel) |
| virtual void | preWriteItem (std::string &fp, DtReaderWriter *rw, int indentLevel) |
| virtual DtPropertyInterface * | scratchItem () const |
| virtual void | writePrototype (const DtReaderWriter *, std::string &fp, int indentLevel, bool writeHeader=true) const |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| | Copies values from the specified DtReaderWriter.
|
| virtual DtlObjPtr | getData (DtlObjPtr variableList, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| | Override to allow a variable to be assigned to a property of derived type.
|
| virtual void | assignPrototypeToChildren () |
| virtual void | setPrototypeIntoTarget (const DtPropertyInterface *prototype, DtReaderWriter *target) |
| virtual bool | matchPrototype (const DtReaderWriter *prototype, const DtReaderWriter *match) const |
| virtual void | cloneAndAddProperty (const DtReaderWriter &rw) |
| | Clones the given RW and tries to add it to this list.
|
| virtual void | filterIgnoredProperties (DtReaderWriter *rw, const std::set< DtString > &ignore) |
| | Filters out all properties that are in the ignore list by removing them from the registry and deleting them.
|
| virtual void | getInterface (DtPropertyInterface *pFace, DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| | If this is called then this is rebuilding a structure for a prototype, so, only get the name...
|
| virtual void | putData (std::string &, int indentLevel=0) |
| | Deriving class overrides these to get/put class specific data.
|
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| | Create property based on type and add to registry.
|
| virtual bool | traverseAndModifyPercentage (DtRwProperties &results, const DtRwProperties &baseValues, const DtReaderWriter *percentage, const DtString &base) const |
| | Walks the percentage value, matching reader/writer names until the percentage is found.
|
| virtual void | writePrototypeHeader (std::string &fp, const DtReaderWriter *rw, int indentLevel) const |
| virtual void | writePropertyData (DtReaderWriter *rw, std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path) |
| | Writes out the reader/writer property value (including default value and variable name)
|
| virtual const DtReaderWriter * | internalFindVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const |
| | Actual find method such that the const and non-const versions can share the same code.
|
| virtual bool | keywordMatches (const DtSymbolString &lhs, const DtString &rhs, const std::map< DtString, DtString > &variableSubstitutions) const |
| | Check to see if there are any variable substitutions such that a variable named something has a map to another name and can match the right hand side.
|
Acts as a map for properties.
A map is a definition that has a key and a prototype, with values being the key and prototype pair. The key can only be a string (DtRwStringType), int (DtRwIntType, DtRwInt8Type, DtRwInt16Type, DtRwInt32Type), or real (DtRwRealType, DtRwReal32Type, DtRwReal64Type).
The map is defined in reader/writer as:
(DtRwStruct CombatRange
)
("Small" (100.0 20)) ("Medium" (200.0 40)) ("Large" (300.0 60))
)
For a single variable (not a structure) the map would look like:
("Row 1" (1.0 2.0 3.0 4.0))
)
As a subclass of DtRwProperties, DtRwPropertiesMap supports an STL-like iterator for iterating over its items. It also has convenience functions for adding, removing, and accessing items within the map by key. These include [] operators. Please also see DtRwPropertiesList for further convenience functions. The key type for a DtRwPropertiesMap must be a recognized simple property type (generally some type of integer, real, or string).