 |
VR-Forces 4.7 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.7 Class Documentation
|
Public Member Functions | |
| DtRwPropertyString (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyString (const DtString &name, const DtString &value, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyString (const DtString &name, const DtRwPropertyString &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyString (const DtRwPropertyString &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyString & | operator= (const DtRwPropertyString &orig) |
| virtual | ~DtRwPropertyString () |
 Public Member Functions inherited from DtRwProperty< DtRwString > | |
| DtRwProperty (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwProperty (const DtString &name, const DtRwProperty &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwProperty & | operator= (const DtRwProperty &orig) |
| virtual | ~DtRwProperty () |
| virtual char * | encode (char *) const |
| These methods are for network encoding/decoding for HLA encoding decoding reasons. | |
| virtual const char * | decode (const char *) |
| Decodes the variable bindings from the specified buffer. | |
| virtual DtString | stringRep (const DtString &root="") const |
| virtual void | getSize (int &size) const |
| Returns the size of this item, iterating over all types. | |
| virtual int | hlaAlignment () const |
| Returns alignment necessary to encode this item in HLA. | |
| virtual const char * | propertyType () const |
| Typically returns reader/writer type. | |
| 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 void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Override to allow a variable to be assigned to a property of derived type. | |
| virtual bool | merge (const DtPropertyInterface &target, MergeFlags, const DtMergePath &path=DtMergePath(), const std::set< DtString > &ignore=std::set< DtString >()) |
| In this case replace does not matter – will replace value regardless. | |
| virtual void | recordUpdateTime () const |
| Stamps the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Returns true if an update occurred since the specified time. | |
| virtual void | reset () |
| Override to clear out variable value. | |
| 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) |
| Public Member Functions inherited from DtRwString | |
| DtRwString () | |
| default constructor | |
| DtRwString (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| real constructor | |
| DtRwString (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwString (const DtString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| real constructor from char * | |
| DtRwString (const DtSymbolString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwString (const DtString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwString (const DtSymbolString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwString (const DtString &name, const DtRwString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwString (const DtSymbolString &name, const DtRwString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwString (const DtRwString &orig, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| copy constructor | |
| DtRwString & | operator= (const DtRwString &orig) |
| Assign to DtString. Assigns value only. | |
| DtRwString & | operator= (const char *orig) |
| DtRwString & | operator= (const DtString &orig) |
| DtRwString & | operator= (const DtSymbolString &orig) |
| virtual | ~DtRwString () |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual DtString | unsubstitutedString () const |
| virtual void | setUnsubstitutedString (const DtString &) |
| Sets the unsubstitude string value. | |
| virtual bool | containsVariableSubstitutions () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of this variable. | |
| virtual int | alignment () const |
| Return HLA network alignment. sizeof(char) | |
| bool | operator== (const DtRwString &) const |
| bool | operator== (const DtString &) const |
| bool | operator!= (const DtString &rhs) const |
| bool | operator!= (const DtRwString &rhs) const |
| bool | operator== (const char *) const |
| bool | operator!= (const char *rhs) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. | |
| virtual const char * | xmlType () const |
| 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 | 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 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 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 | 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. | |
| Public Member Functions inherited from DtPropertyInterface | |
| virtual | ~DtPropertyInterface () |
| int | getSize () const |
| virtual bool | isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const |
| Returns true if the readerWriterType is the same. | |
| 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. | |
| virtual const DtPropertyInterface * | findPropertyInterface (const DtString &propertyName) const |
| virtual DtPropertyInterface * | findPropertyInterface (const DtString &propertyName) |
| 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. | |
| virtual bool | addProperty (DtPropertyInterface *property) |
| template<typename SpecificPropType > | |
| SpecificPropType * | addNewProperty (const DtString &propertyName) |
| Adds a new property of the specified type and returns pointer to the new item. | |
| virtual bool | removeProperty (const DtString &propertyName) |
| virtual bool | removeProperty (const DtPropertyInterface *property) |
Additional Inherited Members | |
| 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 Types inherited from DtPropertyInterface | |
| enum | MergeFlags { Replace = 0x00000001, MinimalSimilarityCheck = 0x00000002, RollUp = 0x00000004, AddMissing = 0x00000008, KeepIsPublished = 0x00000010 } |
| Determines how two lists of properties will be merged by the merge function. More... | |
| Static Public Member Functions inherited from DtRwString | |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. | |
| 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 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. | |
| Protected Member Functions inherited from DtRwString | |
| 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. | |
| Protected Attributes inherited from DtRwProperty< DtRwString > | |
| DtClock | myClock |
| DtTime | myUpdateTime |
| bool | myIsPublished |
| unsigned | myDisRecordType |
| 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 |
| DtRwPropertyString::DtRwPropertyString | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertyString::DtRwPropertyString | ( | const DtString & | name, |
| const DtString & | value, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertyString::DtRwPropertyString | ( | const DtString & | name, |
| const DtRwPropertyString & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertyString::DtRwPropertyString | ( | const DtRwPropertyString & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
|
virtual |
| DtRwPropertyString& DtRwPropertyString::operator= | ( | const DtRwPropertyString & | orig | ) |