 |
VR-Forces 4.5 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces 4.5 Class Documentation
|
Public Member Functions | |
| DtRwPropertyBoolean (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyBoolean (const DtString &name, const DtRwPropertyBoolean &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyBoolean (const DtRwPropertyBoolean &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtRwPropertyBoolean & | operator= (const DtRwPropertyBoolean &orig) |
| virtual | ~DtRwPropertyBoolean () |
 Public Member Functions inherited from DtRwProperty< DtRwBoolean > | |
| 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 hlaAlignment. | |
| virtual const char * | propertyType () const |
| Typically returns reader/writer type. | |
| 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 |
| Public Member Functions inherited from DtRwBoolean | |
| DtRwBoolean (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwBoolean (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwBoolean (const char *name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwBoolean (bool value, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) | |
| Constructor from bool. | |
| DtRwBoolean (const DtString &name, const DtRwBoolean &orig, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| copy constructor | |
| DtRwBoolean (const DtRwBoolean &orig, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwBoolean & | operator= (const DtRwBoolean &orig) |
| Assign to bool. Assigns value only. | |
| virtual | ~DtRwBoolean () |
| virtual | operator const bool () const |
| Additional operator overrides. | |
| bool | operator= (const bool orig) |
| Assign from bool. | |
| virtual int | operator== (const bool rhs) const |
| virtual int | operator!= (const bool rhs) const |
| virtual int | operator&& (const bool rhs) const |
| virtual int | operator|| (const bool rhs) const |
| virtual int | operator! () const |
| virtual bool | value () const |
| virtual void | setValue (bool 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 the reader/writer variable. | |
| virtual int | alignment () const |
| Return HLA network alignment. sizeof(DtU8) | |
| bool | debugTest () |
| Not currently used, but worth hanging onto as an example. | |
| 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 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 &) |
| 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. | |
| 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. | |
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 } |
| Static Public Member Functions inherited from DtRwBoolean | |
| static bool | getBoolAttribute (DtEnvironmentSP env, const DtString &attributeName, DtEnvValueSP root, bool defaultIfMissing=true) |
| static bool | ToBool (const DtString &str, bool defaultIfMissing=true) |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| Protected Attributes inherited from DtRwProperty< DtRwBoolean > | |
| DtClock | myClock |
| DtTime | myUpdateTime |
| 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 |
| DtRwPropertyBoolean::DtRwPropertyBoolean | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertyBoolean::DtRwPropertyBoolean | ( | const DtString & | name, |
| const DtRwPropertyBoolean & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtRwPropertyBoolean::DtRwPropertyBoolean | ( | const DtRwPropertyBoolean & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
|
virtual |
| DtRwPropertyBoolean& DtRwPropertyBoolean::operator= | ( | const DtRwPropertyBoolean & | orig | ) |