Public Member Functions |
| | DtRwPropertiesMap (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwPropertiesMap (const DtString &name, const DtRwPropertiesMap &orig, DtReaderWriterRegistry *parentRegistry=0) |
| virtual | ~DtRwPropertiesMap () |
| virtual const char * | readerWriterType () const |
| | Used to supply a string type that this reader writer type is.
|
| virtual const char * | xmlType () const |
| virtual void | writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| | Writes out registry data, but includes the type strings when writing.
|
| DtRwPropertiesMap & | operator= (const DtRwPropertiesMap &) |
| virtual bool | isSimilarProperty (const DtPropertyInterface *rhs) const |
| | Returns true if the prototype and key are the same types.
|
|
| virtual void | setKeyType (const DtString &) |
| | Sets/gets the key type.
|
| virtual const DtReaderWriter * | keyType () const |
| | Sets/gets the key type.
|
|
| virtual bool | keyIsInt () const |
| | Returns the type of key.
|
| virtual bool | keyIsReal () const |
| | Returns the type of key.
|
| virtual bool | keyIsString () const |
| | Returns the type of key.
|
| | DtRwPropertiesList (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwPropertiesList (const DtString &name, const DtRwPropertiesList &orig, DtReaderWriterRegistry *parentRegistry=0) |
| virtual | ~DtRwPropertiesList () |
| 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 | 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 |
| | Returns the size of this item, iterating over all types.
|
| | DtRwProperties (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwProperties (const DtString &name, const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0) |
| | DtRwProperties (const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0) |
| DtRwProperties & | operator= (const DtRwProperties &orig) |
| virtual | ~DtRwProperties () |
| 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 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 const DtReaderWriter * | findProperty (const DtString &propName) const |
| | Returns the ReaderWriter for the (first) property that matches the given property name.
|
| virtual DtReaderWriter * | findProperty (const DtString &propName) |
| | Returns the ReaderWriter for the (first) property that matches the given property name.
|
| virtual DtReaderWriter * | readerWriter () |
| virtual const DtReaderWriter * | readerWriter () const |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| 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 () |
| 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, 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 const DtReaderWriter * | findVariableBinding (const DtString &rwTypeString, const DtString &variableName) 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) |
| | Looks for the specified name/type combination in the registry, and returns a pointer to that RW object if it is found.
|
| virtual const DtReaderWriter * | findVariableBinding (const DtString &variableName) const |
| | Finds the variable with the given name regardless of type.
|
| virtual DtReaderWriter * | findVariableBinding (const DtString &variableName) |
| | Finds the variable with the given name regardless of type.
|
| | 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 (FILE *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 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 DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| | Deriving class overrides these to get/put class specific data.
|
| 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.
|
| 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 () |
| | The default value to use if the reader/writer object is a variable and that variable is not specified.
|
| 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 () |
| | Collection of child DtReaderWriter nodes owned by this object.
|
| virtual DtString | toXml () const |
| 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 &) |
| | Restires 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 | 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.
|
| virtual | ~DtPropertyInterface () |
| int | getSize () const |
Protected Member Functions |
| 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 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) |
| virtual void | putData (DtEnvironmentSP env, DtEnvValueSP value) const |
| | Override to add attributes of actual data.
|
| 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 | 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 (FILE *, 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.
|
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 of string, int or real. The map is defined in reader/writer as (DtRwMap CombatList DtRwString (DtRwStruct CombatRange (DtRwReal Range) (DtRwInt Number) ) ("Small" (100.0 20)) ("Medium" (200.0 40)) ("Large" (300.0 60)) )
For a single variable (not a structure) the map would look like: (DtRwMap Hit-List DtRwString (DtRwList Columns DtRwReal) ("Row 1" (1.0 2.0 3.0 4.0)) )
Public Member Functions inherited from DtRwPropertiesList