 |
VR-Forces 4.6 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.6 Class Documentation
|
Public Member Functions | |
| DtRwPropertyInt (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyInt (const DtString &name, const DtRwPropertyInt &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyInt (const DtRwPropertyInt &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyInt & | operator= (const DtRwPropertyInt &orig) |
| virtual | ~DtRwPropertyInt () |
 Public Member Functions inherited from DtRwPropertyWithThreshold< DtRwInt > | |
| DtRwPropertyWithThreshold (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyWithThreshold (const DtString &name, const DtRwPropertyWithThreshold &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyWithThreshold & | operator= (const DtRwPropertyWithThreshold &orig) |
| virtual | ~DtRwPropertyWithThreshold () |
| virtual char * | encode (char *) const |
| These methods are for network encoding/decoding for Hla encoding decoding reasons. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Returns true if an update occurred since the specified time and the current value is at least _Threshold percent away from the previous encoded value. | |
| virtual void | enableThresholding (bool enable) |
| Enables or disables thresholding of this property. Enabled by default. | |
| virtual void | setThreshold (double percentage) |
| Changes the threshold for when an update should be sent. | |
| virtual void | setMaxUpdateInterval (DtTime interval) |
| Changes the maximum time between updates if data has changed but has not crossed the threshold for an update. | |
| virtual void | setMaxUnchangedUpdateInterval (DtTime interval) |
| Changes the maximum time between updates if data has changed but has not crossed the threshold for an update, but seems to have settled on a new value. | |
| Public Member Functions inherited from DtRwProperty< DtRwInt > | |
| 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 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 hlaAlignment. | |
| virtual const char * | propertyType () const |
| Typically returns reader/writer type. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference()) |
| 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 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 DtRwInt | |
| DtRwInt () | |
| default constructor | |
| DtRwInt (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| real constructor | |
| DtRwInt (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwInt (const DtString &name, int value, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| real constructor from an int | |
| DtRwInt (const DtSymbolString &name, int value, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| real constructor from an int | |
| DtRwInt (int orig, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| copy constructor | |
| DtRwInt (const DtRwInt &orig, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwInt & | operator= (const DtRwInt &orig) |
| assign to int... assigns value only | |
| virtual | ~DtRwInt () |
| virtual | operator const int () const |
| additional operator overrides | |
| int | operator= (const int orig) |
| assign from int | |
| virtual int | operator- () const |
| virtual int | operator* (const int rhs) const |
| virtual int | operator/ (const int rhs) const |
| virtual int | operator+ (const int rhs) const |
| virtual int | operator- (const int rhs) const |
| virtual int | operator< (const int rhs) const |
| virtual int | operator> (const int rhs) const |
| virtual int | operator<= (const int rhs) const |
| virtual int | operator>= (const int rhs) const |
| virtual int | operator== (const int rhs) const |
| virtual int | operator!= (const int rhs) const |
| virtual int | operator*= (const int rhs) |
| virtual int | operator/= (const int rhs) |
| virtual int | operator+= (const int rhs) |
| virtual int | operator-= (const int rhs) |
| virtual int | operator% (const int rhs) |
| virtual int | operator%= (const int rhs) |
| virtual int | operator-- (int) |
| virtual int | operator-- () |
| virtual int | operator++ (int) |
| virtual int | operator++ () |
| virtual int | value () const |
| virtual void | setValue (int value) |
| 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 | prettyPrint () const |
| Routine to return a human readable form of this variable. | |
| virtual int | alignment () const |
| Return HLA network alignment. sizeof(int) | |
| 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()) |
| 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 | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| virtual void | writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| bool | isReadonly () const |
| virtual 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 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 DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| 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 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 | 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. | |
| Public Member Functions inherited from DtPropertyInterface | |
| virtual | ~DtPropertyInterface () |
| int | getSize () const |
| virtual bool | isSimilarProperty (const DtPropertyInterface *rhs) 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. | |
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 } |
| Static Public Member Functions inherited from DtRwPropertyWithThreshold< DtRwInt > | |
| static void | setDefaultThreshold (double percentage) |
| Changes the default threshold for cases when setThreshold() has not been called. | |
| static void | setDefaultMaxUpdateInterval (DtTime interval) |
| Changes the default max update interval for cases when setMaxUpdateInterval() has not been called. | |
| static void | setDefaultMaxUnchangedUpdateInterval (DtTime interval) |
| Changes the default max unchanged update interval for cases when setMaxUnchangedUpdateInterval() has not been called. | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| Protected Attributes inherited from DtRwPropertyWithThreshold< DtRwInt > | |
| bool | myThresholdingEnabled |
| Whether thresholding is currently enabled. | |
| DtRwInt | myLastEncodedValue |
| The value at the last time the value was encoded. | |
| DtTime | myLastEncodeTime |
| The time the value was last encoded. | |
| double | myThreshold |
| DtTime | myMaxUpdateInterval |
| DtTime | myMaxUnchangedUpdateInterval |
| Static Protected Attributes inherited from DtRwPropertyWithThreshold< DtRwInt > | |
| static double | myDefaultThreshold |
| static DtTime | myDefaultMaxUpdateInterval |
| static DtTime | myDefaultMaxUnchangedUpdateInterval |
| DtRwPropertyInt::DtRwPropertyInt | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertyInt::DtRwPropertyInt | ( | const DtString & | name, |
| const DtRwPropertyInt & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertyInt::DtRwPropertyInt | ( | const DtRwPropertyInt & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
|
virtual |
| DtRwPropertyInt& DtRwPropertyInt::operator= | ( | const DtRwPropertyInt & | orig | ) |