Public Member Functions |
| | 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.
|
| | 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 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()) |
| 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) |
| 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) |
template<typename _RwType>
class DtRwPropertyWithThreshold< _RwType >
This class is similar to DtRwProperty, but allows you to specify a threshold at which the value should be considered different enough to require an update.
wasUpdatedSince() will return false until the threshold is met. The threshold is defined as a percentage of the current value.