 |
VR-Forces 4.8 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.8 Class Documentation
|
Acts as a fixed array for properties. More...
Public Member Functions | |
| virtual void | setFixedSize (unsigned s) |
| Sets the fixed size of the array, creating or deleting items as necessary using the prototype item of the list. More... | |
| virtual void | setFixedSize (unsigned s, const DtPropertyInterface *prototype) |
| Sets the fixed size of the array, creating or deleting items as necessary using the specified prototype item. More... | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. More... | |
| virtual const char * | xmlType () const |
| virtual char * | encode (char *) const |
| Encodes the variable bindings into the supplied buffer. More... | |
| virtual const char * | decode (const char *) |
| Decodes the variable bindings from the specified buffer. More... | |
| virtual void | getSize (int &size) const |
| Gets the size, in bytes, of this item. More... | |
| virtual bool | isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const |
| Returns true prototype is the same. More... | |
| bool | operator== (const DtRwPropertiesFixedArray &) const |
Constructors | |
| DtRwPropertiesFixedArray (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertiesFixedArray (const DtString &name, const DtString &keyType, const DtPropertyInterface *prototype, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertiesFixedArray (const DtString &name, const DtRwPropertiesFixedArray &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtRwPropertiesFixedArray () |
 Public Member Functions inherited from DtRwPropertiesList | |
| virtual bool | isValidProperty (const DtPropertyInterface *) const |
| Returns true if this is a valid property for the properties list. More... | |
| virtual int | count () const |
| Returns the number of valid items in this list. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| virtual const DtPropertyInterface * | prototype () const |
| Returns the prototype for this list. More... | |
| DtRwPropertiesList & | operator= (const DtRwPropertiesList &) |
| 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 () |
| Public Member Functions inherited from DtRwProperties | |
| DtRwProperties & | operator= (const DtRwProperties &orig) |
| virtual | ~DtRwProperties () |
| virtual unsigned | size () const |
| Returns the number of items in the list. More... | |
| virtual bool | addProperty (DtPropertyInterface *) |
| Adds an existing property to this list. This class will then take ownership of the property. More... | |
| virtual DtPropertyInterface * | createProperty (DtlObjPtr args, DtReaderWriterRegistry *parentRegistry) |
| Creates a property from the mtl stream. More... | |
| virtual void | copyVariables (const DtRwVariableBindings &other) |
| Clones variables using the property factory. More... | |
| virtual bool | isReadonly () const |
| virtual int | hlaAlignment () const |
| The required byte alignment of this property when encoding to HLA. More... | |
| 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. More... | |
| virtual const char * | propertyType () const |
| Typically returns reader/writer type. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| virtual DtSymbolString | propertyName () const |
| The name of this property. More... | |
| virtual void | setPropertyName (const DtString &propertyName) |
| Sets name of this property. Should generally only be called when initially created. More... | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Returns true if an update occurred since the specified time. More... | |
| virtual void | clearVariables () |
| Removes and deletes all variable items. More... | |
| virtual void | reset () |
| Clears all variables. More... | |
| virtual void | invalidateCache () |
| Invalidates the entire cache. More... | |
| virtual void | invalidateCacheForProperty (const DtString &propName) |
| Invalidates the single cache entry for the given property name. More... | |
| 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. More... | |
| 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. More... | |
| virtual void | setIsPublished (bool isPub) |
| virtual unsigned | disRecordType () const |
| If this property is published, which DIS record type should it use. More... | |
| virtual void | setDisRecordType (unsigned recType) |
| virtual void | removeVariable (DtReaderWriter *) |
| virtual void | removeVariable (const DtReaderWriter *) |
| Public Member Functions inherited from DtRwVariableBindings | |
| 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. More... | |
| virtual void | addVariable (DtReaderWriter *) |
| Adds a newly created DtReaderWriter variable to the registry. More... | |
| virtual int | getSize () const |
| Returns the size of this item, in bytes, iterating over all types. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| virtual DtReaderWriter * | findVariableBinding (const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor More... | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. More... | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor More... | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor More... | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator More... | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. More... | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor More... | |
| 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. More... | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. More... | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. More... | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. More... | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. More... | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. More... | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. More... | |
| 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. More... | |
| bool | isReadonly () const |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. More... | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. More... | |
| virtual void | setName (const DtString &) |
| Set the name of the object. More... | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. More... | |
| 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. More... | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. More... | |
| 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. More... | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. More... | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. More... | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More... | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. More... | |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. More... | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. More... | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. More... | |
| 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. More... | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More... | |
| 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. More... | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. More... | |
| 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. More... | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. More... | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. More... | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. More... | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. More... | |
| 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. More... | |
| Public Member Functions inherited from DtPropertyInterface | |
| virtual | ~DtPropertyInterface () |
| int | getSize () const |
| virtual bool | isPublishedArg (DtlObjPtr arg, unsigned &disVarRecType) const |
| Tests whether the argument specified indicates this property should be published. More... | |
| template<typename ValueType > | |
| boost::optional< ValueType > | propertyValue () const |
| template<typename ValueType > | |
| bool | setPropertyValue (ValueType val) |
| Sets the value of this property. More... | |
| 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. More... | |
| template<typename SpecificPropType > | |
| SpecificPropType * | addNewProperty (const DtString &propertyName) |
| Adds a new property of the specified type and returns pointer to the new item. More... | |
Static Public Member Functions | |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. More... | |
| Static Public Member Functions inherited from DtRwPropertiesList | |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. More... | |
| Static Public Member Functions inherited from DtRwProperties | |
| static DtReaderWriterPropertyFactory * | propertyFactory () |
| Returns the factory used to create properties. Types are by RW types. More... | |
| static void | cleanupPropertyFactory () |
| static const DtRwProperties & | emptyProperties () |
| static bool | rollUpInteger (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path) |
| Adds integers. More... | |
| static bool | rollUpReal (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path) |
| Adds reals. More... | |
| static bool | rollUpString (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path) |
| Will not roll up if values are dissimilar. More... | |
| static bool | rollUpBoolean (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path) |
| Will not roll up if values are dissimilar. More... | |
| Static Public Member Functions inherited from DtRwVariableBindings | |
| static DtRwVariableBindings * | createBinding (const std::list< DtReaderWriter::DtVariableNameType > &) |
| Creates a new instance of this class and creates all elements found in the list and adds it to this variables registry. More... | |
| 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. More... | |
| static const DtFilename & | appPath () |
| Gets the current working directory. More... | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. More... | |
| 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. More... | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. More... | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. More... | |
Protected Member Functions | |
| virtual DtPropertyInterface * | createPrototype (DtlObjPtr args) |
| Get the fixed size before processing the rest of the items. More... | |
| virtual DtlObjPtr | variablesStart (DtlObjPtr args) const |
| virtual int | hlaAlignment (const DtPropertyInterface *field) const |
| virtual DtPropertyInterface * | clonePrototype (DtReaderWriterRegistry *parent=0) |
| For most property lists, this function returns a clone of the prototype that belongs to the list. More... | |
| Protected Member Functions inherited from DtRwPropertiesList | |
| 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. More... | |
| virtual void | createListEntry (DtPropertyInterface *iFace, DtlObjPtr variableItem, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual const char * | decode (DtPropertyInterface *, const char *) |
| Decodes the variable bindings from the specified buffer. More... | |
| 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. More... | |
| virtual void | getData (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Gets data from the environment value. More... | |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. More... | |
| virtual void | assignPrototypeToChildren () |
| virtual void | setPrototypeIntoTarget (const DtPropertyInterface *prototype, DtReaderWriter *target) |
| virtual void | postWriteItem (std::string &fp, DtReaderWriter *rw, int indentLevel) |
| virtual void | preWriteItem (std::string &fp, DtReaderWriter *rw, int indentLevel) |
| 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. More... | |
| Protected Member Functions inherited from DtRwProperties | |
| 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. More... | |
| 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... More... | |
| virtual void | putData (std::string &, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. More... | |
| virtual void | getSize (const DtPropertyInterface *, int &size) const |
| Returns the size of the readerWriter item. More... | |
| virtual char * | encode (const DtPropertyInterface *, char *buf) const |
| 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. More... | |
| 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. More... | |
| 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) More... | |
| Protected Member Functions inherited from DtRwVariableBindings | |
| 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. More... | |
| 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. More... | |
Private Member Functions | |
| DtRwPropertiesFixedArray () | |
| Not implemented. More... | |
| virtual bool | addItem (DtPropertyInterface *item) |
| Items cannot be added to a fixed array. More... | |
| virtual DtPropertyInterface * | addItem () |
| Items cannot be added to a fixed array. More... | |
| virtual void | erase (DtPropertyInterface *item) |
| Items cannot be removed from a fixed array. More... | |
| virtual void | erase (iterator pos) |
| Items cannot be removed from a fixed array. More... | |
Acts as a fixed array for properties.
This is essentially the same as a DtRwPropertiesList, except that the number of entries is fixed and the size is not encoded on the network.
The fixed array is defined in reader/writer as (in this example the array has 4 entries):
As a subclass of DtRwProperties, DtRwPropertiesFixedArray supports an STL-like iterator for iterating over its items. Please also see DtRwPropertiesList for further convenience functions.
|
private |
Not implemented.
| DtRwPropertiesFixedArray::DtRwPropertiesFixedArray | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertiesFixedArray::DtRwPropertiesFixedArray | ( | const DtString & | name, |
| const DtString & | keyType, | ||
| const DtPropertyInterface * | prototype, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertiesFixedArray::DtRwPropertiesFixedArray | ( | const DtString & | name, |
| const DtRwPropertiesFixedArray & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
|
virtual |
|
virtual |
Sets the fixed size of the array, creating or deleting items as necessary using the prototype item of the list.
|
virtual |
Sets the fixed size of the array, creating or deleting items as necessary using the specified prototype item.
|
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 DtRwPropertiesList.
|
static |
The type that is used when archiving to an XML stream.
|
inlinevirtual |
Reimplemented from DtRwPropertiesList.
References DtRwPropertiesList::theXmlType().
Encodes the variable bindings into the supplied buffer.
Reimplemented from DtRwPropertiesList.
Decodes the variable bindings from the specified buffer.
Reimplemented from DtRwPropertiesList.
|
virtual |
Gets the size, in bytes, of this item.
Reimplemented from DtRwPropertiesList.
|
virtual |
Returns true prototype is the same.
Reimplemented from DtRwPropertiesList.
| bool DtRwPropertiesFixedArray::operator== | ( | const DtRwPropertiesFixedArray & | ) | const |
|
protectedvirtual |
Get the fixed size before processing the rest of the items.
Reimplemented from DtRwPropertiesList.
|
protectedvirtual |
Reimplemented from DtRwPropertiesList.
|
protectedvirtual |
Reimplemented from DtRwPropertiesList.
|
protectedvirtual |
For most property lists, this function returns a clone of the prototype that belongs to the list.
Because fixed arrays always have a fixed size, this simply returns the next unused item in the list, if there is one. This should not be used except in reading saved values from a file.
Reimplemented from DtRwPropertiesList.
|
inlineprivatevirtual |
Items cannot be added to a fixed array.
Reimplemented from DtRwPropertiesList.
|
inlineprivatevirtual |
Items cannot be added to a fixed array.
Reimplemented from DtRwPropertiesList.
|
inlineprivatevirtual |
Items cannot be removed from a fixed array.
Reimplemented from DtRwPropertiesList.
|
inlineprivatevirtual |
Items cannot be removed from a fixed array.
Reimplemented from DtRwPropertiesList.
|
protected |
The index to the next item to be loaded during reading.