VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions
DtRwProperties Class Reference

A list of properties. More...

Inheritance diagram for DtRwProperties:
Inheritance graph
[legend]

Public Types

typedef DtPropertiesIterator iterator
 
typedef DtPropertiesConstIterator const_iterator
 
- 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...
 

Public Member Functions

DtRwPropertiesoperator= (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 bool addPropertyAtIndex (DtPropertyInterface *, unsigned index)
 Adds an existing property to this list at the given index. This class will then take ownership of the property. More...
 
virtual void copy (const DtPropertyInterface &rhs)
 Copies the given property into the current one as long as the types are the same. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Reads in items, using the factory to read the correct types. More...
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Override to allow a variable to be assigned to a property of derived type. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual bool isValidProperty (const DtPropertyInterface *) const
 Returns true if this is a valid property for the properties list. More...
 
virtual DtPropertyInterfacecreateProperty (DtlObjPtr args, DtReaderWriterRegistry *parentRegistry)
 Creates a property from the mtl stream. More...
 
virtual charencode (char *) const
 Encodes the variable bindings into the supplied buffer. More...
 
virtual const chardecode (const char *)
 Decodes the variable bindings from the specified buffer. More...
 
virtual void getSize (int &size) const
 Returns the size, in bytes, of this item, iterating over all types. 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 charpropertyType () const
 Typically returns reader/writer type. More...
 
virtual int count () const
 Number of properties. 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
 
virtual void cloneAndAddProperty (const DtReaderWriter &rw)
 Clones the given RW and tries to add it to this list. More...
 
Constructors
 DtRwProperties (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwProperties (const DtString &name, const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwProperties (const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
 
Iterator begin

Returns an iterator to the first property.

virtual const_iterator begin () const
 
virtual iterator begin ()
 
Iterator end

Returns an iterator to the item after the last property.

virtual const_iterator end () const
 
virtual iterator end ()
 
Generic property lookup functions

Implementation of the findPropertyInterface functions declared in DtPropertyInterface.

virtual const DtPropertyInterfacefindPropertyInterface (const DtString &propertyName) const
 
virtual DtPropertyInterfacefindPropertyInterface (const DtString &propertyName)
 
Property removal functions

Implementation of the removeProperty functions declared in DtPropertyInterface.

virtual bool removeProperty (const DtString &propertyName)
 
virtual bool removeProperty (const DtPropertyInterface *property)
 
virtual const DtReaderWriterfindPropertyRw (const DtString &propName) const
 Returns the ReaderWriter for the (first) property that matches the given property name. More...
 
virtual DtReaderWriterfindPropertyRw (const DtString &propName)
 
virtual DtReaderWriterreaderWriter ()
 
virtual const DtReaderWriterreaderWriter () const
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () 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)
 
DtRwVariableBindingsoperator= (const DtRwVariableBindings &orig)
 
virtual ~DtRwVariableBindings ()
 
template<typename RW_Type >
const RW_Type * findAndCastVariableBinding (const DtString &variableName) const
 
virtual DtReaderWriteraddVariableBinding (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 DtReaderWriterfindVariableBinding (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 DtReaderWriterfindVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >())
 
virtual const DtReaderWriterfindVariableBinding (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 DtReaderWriterfindVariableBinding (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 DtReaderWriteroperator= (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 aliasContaineraliases () 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...
 
virtual const charxmlType () const
 
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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
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 getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value. More...
 
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 isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const
 Returns true if the readerWriterType is the same. More...
 
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
DtReaderWriterPropertyFactory
propertyFactory ()
 Returns the factory used to create properties. Types are by RW types. More...
 
static void cleanupPropertyFactory ()
 
static const DtRwPropertiesemptyProperties ()
 
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 DtRwVariableBindingscreateBinding (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 chartheXmlType ()
 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 DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (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 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 writeSelf (std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
 Writes out registry data, but includes the type strings when writing. More...
 
virtual void writeData (std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
 
virtual void putData (std::string &, int indentLevel=0)
 Deriving class overrides these to get/put class specific data. More...
 
virtual int hlaAlignment (const DtPropertyInterface *field) const
 
virtual void getSize (const DtPropertyInterface *, int &size) const
 Returns the size of the readerWriter item. More...
 
virtual charencode (const DtPropertyInterface *, char *buf) const
 
virtual const chardecode (DtPropertyInterface *iFace, const char *buf)
 
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...
 
virtual void getSortedProperties (const DtRwVariableBindings &varBindings, std::vector< const DtReaderWriter * > &propertyList) const
 Returns a vector of properties, sorted by name, that are present in the given DtRwVariableBindings. More...
 
virtual void getSortedProperties (DtRwVariableBindings &varBindings, std::vector< DtReaderWriter * > &propertyList)
 
virtual bool isDebugEnabled () const
 Enables debug output. More...
 
virtual void setDebugEnabled (bool en)
 
- Protected Member Functions inherited from DtRwVariableBindings
virtual const DtReaderWriterinternalFindVariableBinding (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...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 

Protected Attributes

std::multimap< DtString,
DtReaderWriter * > 
myRwPropertyCache
 
tbb::spin_mutex * myCacheMutex
 
DtClock myClock
 
DtTime myLastTimeSizeChanged
 Stores the last time at which it was discovered that the size of the list changed. More...
 
int mySizeAtLastCheck
 Stores the number of items in the last at the last time it was discovered the size changed. More...
 
unsigned myDisRecordType
 
bool myIsPublished
 
bool myWritePrototypeHeader
 
bool myDebugEnabled
 
DtPropertyInterfacemyPreviousParentProp
 
DtString myPreviousParentPropFullName
 
- Protected Attributes inherited from DtRwVariableBindings
std::map< DtString, DtStringmyVariableSubstitutions
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 

Static Protected Attributes

static
DtReaderWriterPropertyFactory
thePropertyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Private Member Functions

 DtRwProperties ()
 Not implemented. More...
 

Detailed Description

A list of properties.

A DtPropertyInterface object that is a specialized version of DtRwVariableBindings for a list of properties or a list of fields within a single property. Provides custom iterators for easy traversal using STL syntax.

* DtRwProperties::iterator iter = properties.begin();
* for (; iter != properties.end(); iter++)
* {
* // Do something
* }
*

These cannot be serialized the same way DtRwVariableBindings as they must follow HLA attribute encoding rules.

Member Typedef Documentation

Constructor & Destructor Documentation

DtRwProperties::DtRwProperties ( )
private

Not implemented.

DtRwProperties::DtRwProperties ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)
DtRwProperties::DtRwProperties ( const DtString name,
const DtRwProperties orig,
DtReaderWriterRegistry parentRegistry = 0 
)
DtRwProperties::DtRwProperties ( const DtRwProperties orig,
DtReaderWriterRegistry parentRegistry = 0 
)
virtual DtRwProperties::~DtRwProperties ( )
virtual

Member Function Documentation

DtRwProperties& DtRwProperties::operator= ( const DtRwProperties orig)
virtual const_iterator DtRwProperties::begin ( ) const
virtual
virtual iterator DtRwProperties::begin ( )
virtual
virtual const_iterator DtRwProperties::end ( ) const
virtual
virtual iterator DtRwProperties::end ( )
virtual
virtual unsigned DtRwProperties::size ( ) const
virtual

Returns the number of items in the list.

virtual const DtPropertyInterface* DtRwProperties::findPropertyInterface ( const DtString propertyName) const
virtual
virtual DtPropertyInterface* DtRwProperties::findPropertyInterface ( const DtString propertyName)
virtual

Reimplemented from DtPropertyInterface.

virtual bool DtRwProperties::addProperty ( DtPropertyInterface )
virtual

Adds an existing property to this list. This class will then take ownership of the property.

Reimplemented from DtPropertyInterface.

Referenced by DtRwPropertiesStructure::addField().

virtual bool DtRwProperties::addPropertyAtIndex ( DtPropertyInterface ,
unsigned  index 
)
virtual

Adds an existing property to this list at the given index. This class will then take ownership of the property.

virtual bool DtRwProperties::removeProperty ( const DtString propertyName)
virtual

Reimplemented from DtPropertyInterface.

Referenced by DtRwPropertiesStructure::removeField().

virtual bool DtRwProperties::removeProperty ( const DtPropertyInterface property)
virtual

Reimplemented from DtPropertyInterface.

virtual void DtRwProperties::copy ( const DtPropertyInterface rhs)
virtual

Copies the given property into the current one as long as the types are the same.

All children of this list are copied. If children of the same name and type exist in both lists, the values of the rhs children are copied into this list. If rhs has additional children, they are added. If rhs is missing children, they are removed.

Implements DtPropertyInterface.

virtual void DtRwProperties::getSelf ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths = SearchPaths(),
const DtVariableBindingsList variableBindings = nullVariableReference() 
)
virtual

Reads in items, using the factory to read the correct types.

Reimplemented from DtRwVariableBindings.

Reimplemented in DtRwPropertiesList.

virtual DtlObjPtr DtRwProperties::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths = SearchPaths(),
const DtVariableBindingsList variableBindings = nullVariableReference() 
)
virtual

Override to allow a variable to be assigned to a property of derived type.

Implements DtPropertyInterface.

Reimplemented in DtRwPropertiesList.

virtual const char* DtRwProperties::readerWriterType ( ) const
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 DtRwVariableBindings.

Reimplemented in DtRwPropertiesMap, DtRwPropertiesStructure, DtRwPropertiesList, and DtRwPropertiesFixedArray.

virtual bool DtRwProperties::isValidProperty ( const DtPropertyInterface ) const
virtual

Returns true if this is a valid property for the properties list.

Reimplemented in DtRwPropertiesList.

virtual DtPropertyInterface* DtRwProperties::createProperty ( DtlObjPtr  args,
DtReaderWriterRegistry parentRegistry 
)
virtual

Creates a property from the mtl stream.

virtual char* DtRwProperties::encode ( char ) const
virtual

Encodes the variable bindings into the supplied buffer.

Implements DtPropertyInterface.

Reimplemented in DtRwPropertiesList, and DtRwPropertiesFixedArray.

virtual const char* DtRwProperties::decode ( const char )
virtual

Decodes the variable bindings from the specified buffer.

Implements DtPropertyInterface.

Reimplemented in DtRwPropertiesList, and DtRwPropertiesFixedArray.

virtual void DtRwProperties::getSize ( int size) const
virtual

Returns the size, in bytes, of this item, iterating over all types.

Implements DtPropertyInterface.

Reimplemented in DtRwPropertiesList, and DtRwPropertiesFixedArray.

static DtReaderWriterPropertyFactory* DtRwProperties::propertyFactory ( )
static

Returns the factory used to create properties. Types are by RW types.

Referenced by DtUiTableWidgetItem::data().

static void DtRwProperties::cleanupPropertyFactory ( )
static
virtual void DtRwProperties::copyVariables ( const DtRwVariableBindings other)
virtual

Clones variables using the property factory.

Reimplemented from DtRwVariableBindings.

Reimplemented in DtRwPropertiesStructure.

virtual bool DtRwProperties::isReadonly ( ) const
virtual
virtual int DtRwProperties::hlaAlignment ( ) const
virtual

The required byte alignment of this property when encoding to HLA.

Implements DtPropertyInterface.

virtual int DtRwProperties::requiredPadding ( const char buf,
const DtPropertyInterface field 
) const
virtual

The number of padding bytes required before writing the given field to the buffer for HLA encoding.

virtual const char* DtRwProperties::propertyType ( ) const
virtual

Typically returns reader/writer type.

Implements DtPropertyInterface.

virtual int DtRwProperties::count ( ) const
virtual

Number of properties.

Reimplemented in DtRwPropertiesList.

virtual const DtReaderWriter* DtRwProperties::findPropertyRw ( const DtString propName) const
virtual

Returns the ReaderWriter for the (first) property that matches the given property name.

virtual DtReaderWriter* DtRwProperties::findPropertyRw ( const DtString propName)
virtual
virtual DtString DtRwProperties::stringRep ( const DtString root = "") const
virtual

Implements DtPropertyInterface.

virtual bool DtRwProperties::merge ( const DtPropertyInterface target,
MergeFlags  ,
const DtMergePath path = DtMergePath(),
const std::set< DtString > &  ignore = std::set< DtString >() 
)
virtual

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.

If replace is true, any matching items are replaced by their target. This will add/remove properties

This is a non-recursive function. It only looks at top level property items

If the ignore list is set ignores merging readerWriterTypes that are in the ignore set

Implements DtPropertyInterface.

virtual DtRwProperties DtRwProperties::createFromPercentages ( const DtRwProperties percentages,
const DtRwProperties baseValues,
const DtString base = "Base-" 
)
virtual

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.

Note that the percentages can be a flat list of variables that will be looked at in the baseValues. This class is used as the template for storage of the resultant values

virtual bool DtRwProperties::findRootAndVariable ( const DtString varName,
DtReaderWriter *&  root,
DtReaderWriter *&  variable 
) const
virtual

In this structure find the variable matching the name and the root that contains the variable.

Note that both might be the same. Returns true if found

virtual DtReaderWriter* DtRwProperties::readerWriter ( )
virtual

Returns a ReaderWriter pointer of the property.

Implements DtPropertyInterface.

virtual const DtReaderWriter* DtRwProperties::readerWriter ( ) const
virtual

Implements DtPropertyInterface.

virtual DtPropertyInterface* DtRwProperties::property ( )
virtual

Returns a PropertyInterface pointer of the ReaderWriter.

Reimplemented from DtReaderWriter.

virtual const DtPropertyInterface* DtRwProperties::property ( ) const
virtual

Reimplemented from DtReaderWriter.

virtual DtSymbolString DtRwProperties::propertyName ( ) const
inlinevirtual

The name of this property.

Implements DtPropertyInterface.

References DtReaderWriter::name().

virtual void DtRwProperties::setPropertyName ( const DtString propertyName)
inlinevirtual

Sets name of this property. Should generally only be called when initially created.

Implements DtPropertyInterface.

References DtReaderWriter::setName().

virtual bool DtRwProperties::wasUpdatedSince ( DtTime  t) const
virtual

Returns true if an update occurred since the specified time.

Reimplemented from DtReaderWriter.

virtual bool DtRwProperties::isPublished ( ) const
virtual

Whether this property should be published.

Implements DtPropertyInterface.

virtual void DtRwProperties::setIsPublished ( bool  isPub)
virtual

Implements DtPropertyInterface.

virtual unsigned DtRwProperties::disRecordType ( ) const
virtual

If this property is published, which DIS record type should it use.

Default is 0, which indicates that the normal VRF generic attribute record type should be used.

Implements DtPropertyInterface.

virtual void DtRwProperties::setDisRecordType ( unsigned  recType)
virtual

Implements DtPropertyInterface.

virtual void DtRwProperties::clearVariables ( )
virtual

Removes and deletes all variable items.

Reimplemented from DtRwVariableBindings.

virtual void DtRwProperties::reset ( )
virtual

Clears all variables.

Implements DtPropertyInterface.

virtual void DtRwProperties::removeVariable ( DtReaderWriter )
virtual

Overridden to also remove the DtReaderWriter from myRwPropertyCache.

Reimplemented from DtRwVariableBindings.

virtual void DtRwProperties::removeVariable ( const DtReaderWriter )
virtual

Reimplemented from DtRwVariableBindings.

virtual void DtRwProperties::invalidateCache ( )
virtual

Invalidates the entire cache.

virtual void DtRwProperties::invalidateCacheForProperty ( const DtString propName)
virtual

Invalidates the single cache entry for the given property name.

static const DtRwProperties& DtRwProperties::emptyProperties ( )
static
static bool DtRwProperties::rollUpInteger ( const DtReaderWriter source,
DtReaderWriter destination,
const DtMergePath path 
)
static

Adds integers.

Roll Up rules. Returns true if roll up succeeds

static bool DtRwProperties::rollUpReal ( const DtReaderWriter source,
DtReaderWriter destination,
const DtMergePath path 
)
static

Adds reals.

static bool DtRwProperties::rollUpString ( const DtReaderWriter source,
DtReaderWriter destination,
const DtMergePath path 
)
static

Will not roll up if values are dissimilar.

static bool DtRwProperties::rollUpBoolean ( const DtReaderWriter source,
DtReaderWriter destination,
const DtMergePath path 
)
static

Will not roll up if values are dissimilar.

virtual bool DtRwProperties::setWritePrototypeHeader ( bool  )
virtual
virtual bool DtRwProperties::writePrototypeHeader ( ) const
virtual
virtual void DtRwProperties::cloneAndAddProperty ( const DtReaderWriter rw)
virtual

Clones the given RW and tries to add it to this list.

Reimplemented in DtRwPropertiesList.

virtual void DtRwProperties::filterIgnoredProperties ( DtReaderWriter rw,
const std::set< DtString > &  ignore 
)
protectedvirtual

Filters out all properties that are in the ignore list by removing them from the registry and deleting them.

virtual void DtRwProperties::getInterface ( DtPropertyInterface pFace,
DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths = SearchPaths(),
const DtVariableBindingsList variableBindings = nullVariableReference() 
)
protectedvirtual

If this is called then this is rebuilding a structure for a prototype, so, only get the name...

virtual void DtRwProperties::writeSelf ( std::string &  fp,
int  indentLevel,
bool  writeUnspecified,
const DtFilename &  path 
)
protectedvirtual

Writes out registry data, but includes the type strings when writing.

Reimplemented from DtRwVariableBindings.

Reimplemented in DtRwPropertiesList.

virtual void DtRwProperties::writeData ( std::string &  fp,
int  indentLevel,
bool  writeUnspecified,
const DtFilename &  path 
)
protectedvirtual

Reimplemented in DtRwPropertiesList.

virtual void DtRwProperties::putData ( std::string &  fp,
int  indentLevel = 0 
)
protectedvirtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual int DtRwProperties::hlaAlignment ( const DtPropertyInterface field) const
protectedvirtual
virtual void DtRwProperties::getSize ( const DtPropertyInterface ,
int size 
) const
protectedvirtual

Returns the size of the readerWriter item.

Reimplemented in DtRwPropertiesMap.

virtual char* DtRwProperties::encode ( const DtPropertyInterface ,
char buf 
) const
protectedvirtual

Reimplemented in DtRwPropertiesMap.

virtual const char* DtRwProperties::decode ( DtPropertyInterface iFace,
const char buf 
)
protectedvirtual

Reimplemented in DtRwPropertiesMap, and DtRwPropertiesList.

virtual void DtRwProperties::unrecognizedItem ( const DtEnvironmentSP  env,
const DtEnvValueSP  root,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList varBindings 
)
protectedvirtual

Create property based on type and add to registry.

Reimplemented from DtReaderWriter.

virtual bool DtRwProperties::traverseAndModifyPercentage ( DtRwProperties results,
const DtRwProperties baseValues,
const DtReaderWriter percentage,
const DtString base 
) const
protectedvirtual

Walks the percentage value, matching reader/writer names until the percentage is found.

virtual void DtRwProperties::writePrototypeHeader ( std::string &  fp,
const DtReaderWriter rw,
int  indentLevel 
) const
protectedvirtual
virtual void DtRwProperties::writePropertyData ( DtReaderWriter rw,
std::string &  fp,
int  indentLevel,
bool  writeUnspecified,
const DtFilename &  path 
)
protectedvirtual

Writes out the reader/writer property value (including default value and variable name)

virtual void DtRwProperties::getSortedProperties ( const DtRwVariableBindings varBindings,
std::vector< const DtReaderWriter * > &  propertyList 
) const
protectedvirtual

Returns a vector of properties, sorted by name, that are present in the given DtRwVariableBindings.

virtual void DtRwProperties::getSortedProperties ( DtRwVariableBindings varBindings,
std::vector< DtReaderWriter * > &  propertyList 
)
protectedvirtual
virtual bool DtRwProperties::isDebugEnabled ( ) const
protectedvirtual

Enables debug output.

Generally this should be left off.

Implements DtPropertyInterface.

virtual void DtRwProperties::setDebugEnabled ( bool  en)
protectedvirtual

Implements DtPropertyInterface.

Member Data Documentation

DtReaderWriterPropertyFactory* DtRwProperties::thePropertyFactory
staticprotected
std::multimap<DtString, DtReaderWriter*> DtRwProperties::myRwPropertyCache
mutableprotected
tbb::spin_mutex* DtRwProperties::myCacheMutex
mutableprotected
DtClock DtRwProperties::myClock
protected
DtTime DtRwProperties::myLastTimeSizeChanged
mutableprotected

Stores the last time at which it was discovered that the size of the list changed.

int DtRwProperties::mySizeAtLastCheck
mutableprotected

Stores the number of items in the last at the last time it was discovered the size changed.

unsigned DtRwProperties::myDisRecordType
protected
bool DtRwProperties::myIsPublished
protected
bool DtRwProperties::myWritePrototypeHeader
protected
bool DtRwProperties::myDebugEnabled
protected
DtPropertyInterface* DtRwProperties::myPreviousParentProp
mutableprotected
DtString DtRwProperties::myPreviousParentPropFullName
mutableprotected

The documentation for this class was generated from the following file:

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)