VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtRwPropertiesMap Class Reference

Acts as a map for properties. A map is a definition that has a key and a prototype, with values being the key and prototype pair. The key can only be a string (DtRwStringType), int (DtRwIntType, DtRwInt8Type, DtRwInt16Type, DtRwInt32Type), or real (DtRwRealType, DtRwReal32Type, DtRwReal64Type).

The map is defined in reader/writer as:

(DtRwMap CombatList DtRwString
(DtRwStruct CombatRange
(DtRwReal Range)
(DtRwInt Number)
)
("Small" (100.0 20)) ("Medium" (200.0 40)) ("Large" (300.0 60))
)
For a single variable (not a structure) the map would look like:
(DtRwMap Hit-List DtRwString
(DtRwList Columns DtRwReal)
("Row 1" (1.0 2.0 3.0 4.0))
)

As a subclass of DtRwProperties, DtRwPropertiesMap supports an STL-like iterator for iterating over its items. It also has convenience functions for adding, removing, and accessing items within the map by key. These include [] operators. Please also see DtRwPropertiesList for further convenience functions. The key type for a DtRwPropertiesMap must be a recognized simple property type (generally some type of integer, real, or string).

Inheritance diagram for DtRwPropertiesMap:
Inheritance graph
[legend]

Classes

struct  Key
 

Public Member Functions

virtual const char * readerWriterType () const override
 
virtual const char * xmlType () const override
 
DtRwPropertiesMap & operator= (const DtRwPropertiesMap &)
 
virtual Key keyOfItem (const DtPropertyInterface *item) const
 
virtual std::set< Key > allKeys () const
 
virtual bool isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const override
 
virtual int hlaAlignment () const override
 
bool operator== (const DtRwPropertiesMap &) const
 
Constructors
 DtRwPropertiesMap (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesMap (const DtString &name, const DtString &keyType, const DtPropertyInterface *prototype, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesMap (const DtString &name, const DtRwPropertiesMap &orig, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtRwPropertiesMap () override
 
Find Functions
virtual DtPropertyInterface * findItem (const DtString &key)
 
virtual DtPropertyInterface * findItem (int key)
 
virtual DtPropertyInterface * findItem (double key)
 
virtual DtPropertyInterface * findItem (const Key &key)
 
virtual const DtPropertyInterface * findItem (const DtString &key) const
 
virtual const DtPropertyInterface * findItem (int key) const
 
virtual const DtPropertyInterface * findItem (double key) const
 
virtual const DtPropertyInterface * findItem (const Key &key) const
 
template<typename ValueType >
boost::optional< ValueType > findItemValue (const DtString &key) const
 
template<typename ValueType >
boost::optional< ValueType > findItemValue (int key) const
 
template<typename ValueType >
boost::optional< ValueType > findItemValue (double key) const
 
template<typename ValueType >
boost::optional< ValueType > findItemValue (const Key &key) const
 
Insertion Functions
virtual bool insert (const DtString &key, DtPropertyInterface *item)
 
virtual bool insert (int key, DtPropertyInterface *item)
 
virtual bool insert (double key, DtPropertyInterface *item)
 
virtual bool insert (const Key &key, DtPropertyInterface *item)
 
Addition Functions
virtual DtPropertyInterface * addItem (const DtString &key)
 
virtual DtPropertyInterface * addItem (int key)
 
virtual DtPropertyInterface * addItem (double key)
 
virtual DtPropertyInterface * addItem (const Key &key)
 
Erase Functions
virtual bool erase (const DtString &key)
 
virtual bool erase (int key)
 
virtual bool erase (double key)
 
virtual bool erase (const Key &key)
 
operator[] overloads for common key types

These operator[] overloads allow you to access a map item by common key types. If the item does not exist, a new one will be added of the same type as the prototype. These allow you to index by common basic key types without necessarily converting the key to a DtPropertyInterface to call findItem. If the key is of the wrong type an uninitialized copy of the prototype will be returned that is not part of the map, so care must be taken.

boost::optional<int> val = propertiesMap["Num Soldiers"].propertyValue<int>();
if (val)
{
int newVal = *val + 1;
propertiesMap["Num Soldiers"].setPropertyValue<int>(4);
}
DtPropertyInterface & operator[] (const DtString &key)
 
const DtPropertyInterface & operator[] (const DtString &key) const
 
DtPropertyInterface & operator[] (double key)
 
const DtPropertyInterface & operator[] (double key) const
 
DtPropertyInterface & operator[] (int key)
 
const DtPropertyInterface & operator[] (int key) const
 
DtPropertyInterface & operator[] (const Key &key)
 
const DtPropertyInterface & operator[] (const Key &key) const
 
virtual void setKeyType (const DtString &)
 
virtual const DtReaderWriter * keyType () const
 
virtual bool keyIsInt () const
 
virtual bool keyIsReal () const
 
virtual bool keyIsString () const
 
- Public Member Functions inherited from DtRwPropertiesList
virtual char * encode (char *) const override
 
virtual const char * decode (const char *) override
 
virtual void getSize (int &size) const override
 
virtual bool isValidProperty (const DtPropertyInterface *) const override
 
virtual int count () const override
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) override
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) override
 
virtual void writeData (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) override
 
virtual void setPrototype (const DtPropertyInterface *)
 
virtual const DtPropertyInterface * prototype () const
 
virtual DtPropertyInterface * clonePrototype (DtReaderWriterRegistry *parent=0)
 
DtRwPropertiesList & operator= (const DtRwPropertiesList &)
 
bool operator== (const DtRwPropertiesList &) const
 
virtual bool matchPrototype (const DtReaderWriter *) const
 
 DtRwPropertiesList (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesList (const DtString &name, const DtPropertyInterface *prototype, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesList (const DtString &name, const DtRwPropertiesList &orig, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtRwPropertiesList () override
 
virtual bool addItem (DtPropertyInterface *item)
 
virtual DtPropertyInterface * addItem ()
 
virtual void erase (DtPropertyInterface *item)
 
virtual void erase (iterator pos)
 
- Public Member Functions inherited from DtRwProperties
DtRwProperties & operator= (const DtRwProperties &orig)
 
virtual ~DtRwProperties () override
 
virtual unsigned size () const
 
virtual bool addProperty (DtPropertyInterface *) override
 
virtual bool addPropertyAtIndex (DtPropertyInterface *, unsigned index)
 
virtual void copy (const DtPropertyInterface &rhs) override
 
virtual DtPropertyInterface * createProperty (DtlObjPtr args, DtReaderWriterRegistry *parentRegistry)
 
virtual void copyVariables (const DtRwVariableBindings &other) override
 
virtual bool isReadonly () const
 
virtual const char * propertyType () const override
 
virtual DtString stringRep (const DtString &root="") const override
 
virtual bool merge (const DtPropertyInterface &target, MergeFlags, const DtMergePath &path=DtMergePath(), const std::set< DtString > &ignore=std::set< DtString >()) override
 
virtual DtRwProperties createFromPercentages (const DtRwProperties &percentages, const DtRwProperties &baseValues, const DtString &base="Base-")
 
virtual bool findRootAndVariable (const DtString &varName, DtReaderWriter *&root, DtReaderWriter *&variable) const
 
virtual DtSymbolString propertyName () const override
 
virtual void setPropertyName (const DtString &propertyName) override
 
virtual bool isUpdateNeeded (DtTime t) const override
 
virtual bool hasReceivedUpdateSince (DtTime t) const override
 
virtual DtTime updateClockTime () const override
 
virtual void clearVariables () override
 
virtual void reset () override
 
virtual void invalidateCache ()
 
virtual void invalidateCacheForProperty (const DtString &propName)
 
virtual bool setWritePrototypeHeader (bool)
 
virtual bool writePrototypeHeader () const
 
virtual void setKeepPublishingSettings (bool keep) override
 
virtual bool keepPublishingSettings () const override
 
 DtRwProperties (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwProperties (const DtString &name, const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwProperties (const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
 
virtual const_iterator begin () const
 
virtual iterator begin ()
 
virtual const_iterator end () const
 
virtual iterator end ()
 
virtual const DtPropertyInterface * findPropertyInterface (const DtString &propertyName) const override
 
virtual DtPropertyInterface * findPropertyInterface (const DtString &propertyName) override
 
virtual bool removeProperty (const DtString &propertyName) override
 
virtual bool removeProperty (const DtPropertyInterface *property) override
 
virtual const DtReaderWriter * findPropertyRw (const DtString &propName) const
 
virtual DtReaderWriter * findPropertyRw (const DtString &propName)
 
virtual DtReaderWriter * readerWriter () override
 
virtual const DtReaderWriter * readerWriter () const override
 
virtual DtPropertyInterface * property () override
 
virtual const DtPropertyInterface * property () const override
 
virtual bool isPublished () const override
 
virtual void setIsPublished (bool isPub) override
 
virtual unsigned disRecordType () const override
 
virtual void setDisRecordType (unsigned recType) override
 
virtual void removeVariable (DtReaderWriter *) override
 
virtual void removeVariable (const DtReaderWriter *) override
 
- 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)
 
DtRwVariableBindings & operator= (const DtRwVariableBindings &orig)
 
virtual ~DtRwVariableBindings () override
 
template<typename RW_Type >
const RW_Type * findAndCastVariableBinding (const DtString &variableName) const
 
virtual DtReaderWriter * addVariableBinding (const DtSymbolString &name, const char *type)
 
virtual void addVariable (DtReaderWriter *)
 
virtual int getSize () const
 
bool operator== (const DtRwVariableBindings &) const
 
bool operator!= (const DtRwVariableBindings &) const
 
virtual DtString prettyPrint () const override
 
virtual void setVariableSubstitutions (const std::map< DtString, DtString > &)
 
virtual const std::map
< DtString, DtString > & 		variableSubstitutions () const
 
virtual void merge (const DtRwVariableBindings &)
 
virtual const DtReaderWriter * findVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const
 
virtual DtReaderWriter * findVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >())
 
virtual const DtReaderWriter * findVariableBinding (const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const
 
virtual DtReaderWriter * findVariableBinding (const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >())
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriter & operator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs) const
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContainer & aliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType > 		unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriter * defaultRWValue () const
 
virtual DtReaderWriter * defaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistry & registry () const
 
DtReaderWriterRegistry & registry ()
 
virtual DtString toXml () const
 
virtual DtRwVariableBindings * generateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 
- Public Member Functions inherited from DtPropertyInterface
virtual ~DtPropertyInterface ()
 
virtual bool isPublishedArg (DtlObjPtr arg, unsigned &disVarRecType)
 
virtual void copyPublishingSettings (const DtPropertyInterface &prop)
 
virtual void processPublicationArgs (DtlObjPtr arg)
 
virtual void processPublicationArg (DtlObjPtr arg)
 
template<typename ValueType >
boost::optional< ValueType > propertyValue () const
 
template<typename ValueType >
bool setPropertyValue (ValueType val)
 
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)
 
template<typename SpecificPropType >
SpecificPropType * addNewProperty (const DtString &propertyName)
 
int getSize () const
 

Static Public Member Functions

static const char * theXmlType ()
 
- Static Public Member Functions inherited from DtRwPropertiesList
static const char * theXmlType ()
 
- Static Public Member Functions inherited from DtRwProperties
static
DtReaderWriterPropertyFactory * 		propertyFactory ()
 
static void cleanupPropertyFactory ()
 
static const DtRwProperties & emptyProperties ()
 
static bool rollUpInteger (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
 
static bool rollUpReal (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
 
static bool rollUpString (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
 
static bool rollUpBoolean (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
 
- Static Public Member Functions inherited from DtRwVariableBindings
static DtRwVariableBindings * createBinding (const std::list< DtReaderWriter::DtVariableNameType > &)
 
- 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 char * theXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
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)
 
static DtReaderWriter * createFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWriter * createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Member Functions

virtual bool convertKeyToString (int key, DtString &str) const
 
virtual bool convertKeyToString (double key, DtString &str) const
 
virtual bool convertStringToKey (const DtString &str, int &key) const
 
virtual bool convertStringToKey (const DtString &str, double &key) const
 
virtual DtPropertyInterface * createPrototype (DtlObjPtr args) override
 
virtual DtlObjPtr variablesStart (DtlObjPtr args) const override
 
virtual void createListEntry (DtPropertyInterface *iFace, DtlObjPtr variableItem, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual void getSize (const DtPropertyInterface *, int &size) const override
 
virtual char * encode (const DtPropertyInterface *, char *buf) const override
 
virtual const char * decode (DtPropertyInterface *iFace, const char *buf) override
 
virtual int requiredPadding (const char *buf, const DtPropertyInterface *field) const override
 
virtual void writePrototype (const DtReaderWriter *rw, std::string &fp, int indentLevel, bool writeHeader) const override
 
virtual void getData (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) override
 
virtual void putData (DtEnvironmentSP env, DtEnvValueSP value) const override
 
virtual void postWriteItem (std::string &fp, DtReaderWriter *rw, int indentLevel) override
 
virtual void preWriteItem (std::string &fp, DtReaderWriter *rw, int indentLevel) override
 
virtual DtPropertyInterface * scratchItem () const
 
virtual const DtPropertyInterface * findPropertyInterfaceByStringKey (const DtString &keyStr) const
 
virtual DtPropertyInterface * findPropertyInterfaceByStringKey (const DtString &keyStr)
 
- Protected Member Functions inherited from DtRwPropertiesList
virtual void bindToRwAsVariable (const DtReaderWriter *rw) override
 
virtual DtlObjPtr getData (DtlObjPtr variableList, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual void assignPrototypeToChildren ()
 
virtual void setPrototypeIntoTarget (const DtPropertyInterface *prototype, DtReaderWriter *target)
 
virtual bool matchPrototype (const DtReaderWriter *prototype, const DtReaderWriter *match) const
 
virtual void cloneAndAddProperty (const DtReaderWriter &rw) override
 
- Protected Member Functions inherited from DtRwProperties
virtual void filterIgnoredProperties (DtReaderWriter *rw, const std::set< DtString > &ignore)
 
virtual void getInterface (DtPropertyInterface *pFace, DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void putData (std::string &, int indentLevel=0) override
 
virtual int hlaAlignment (const DtPropertyInterface *field) const
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) override
 
virtual bool traverseAndModifyPercentage (DtRwProperties &results, const DtRwProperties &baseValues, const DtReaderWriter *percentage, const DtString &base) const
 
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)
 
virtual void writePublishInformation (std::string &fp, int indentLevel) override
 
virtual void getSortedProperties (const DtRwVariableBindings &varBindings, std::vector< const DtReaderWriter * > &propertyList) const
 
virtual void getSortedProperties (DtRwVariableBindings &varBindings, std::vector< DtReaderWriter * > &propertyList)
 
virtual bool isDebugEnabled () const override
 
virtual void setDebugEnabled (bool en) override
 
- Protected Member Functions inherited from DtRwVariableBindings
virtual const DtReaderWriter * internalFindVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const
 
virtual bool keywordMatches (const DtSymbolString &lhs, const DtString &rhs, const std::map< DtString, DtString > &variableSubstitutions) const
 

Protected Attributes

DtPropertyInterface * myKeyType
 
DtPropertyInterface * myScratchItem
 
- Protected Attributes inherited from DtRwPropertiesList
DtPropertyInterface * myPrototype
 
DtRwPropertyInt myCount
 
- Protected Attributes inherited from DtRwProperties
std::multimap< DtString,
DtReaderWriter * > 		myRwPropertyCache
 
tbb::spin_mutex * myCacheMutex
 
DtClock myClock
 
DtTime myLastTimeSizeChanged
 
int mySizeAtLastCheck
 
unsigned myDisRecordType
 
bool myIsPublished
 
bool myWritePrototypeHeader
 
bool myDebugEnabled
 
bool myKeepPublishingSettingsOnCopy
 
DtPropertyInterface * myPreviousParentProp
 
DtString myPreviousParentPropFullName
 
- Protected Attributes inherited from DtRwVariableBindings
std::map< DtString, DtString > myVariableSubstitutions
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistry * myParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWriter * myDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

Private Member Functions

 DtRwPropertiesMap ()
 

Additional Inherited Members

- Public Types inherited from DtRwProperties
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,
  KeepPublishedSettings = 0x00000010
}
 
- Static Protected Attributes inherited from DtRwProperties
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 DtReaderWriterFactory * theFactory
 
static
DtReaderWriterFactoryCreatorFcn 		theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtRwPropertiesMap::DtRwPropertiesMap ( )
private

Not implemented.

DtRwPropertiesMap::DtRwPropertiesMap ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwPropertiesMap::DtRwPropertiesMap ( const DtString &  name,
const DtString &  keyType,
const DtPropertyInterface *  prototype,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwPropertiesMap::DtRwPropertiesMap ( const DtString &  name,
const DtRwPropertiesMap &  orig,
DtReaderWriterRegistry *  parentRegistry = 0 
)
virtual DtRwPropertiesMap::~DtRwPropertiesMap ( )
overridevirtual

Member Function Documentation

virtual DtPropertyInterface* DtRwPropertiesMap::findItem ( const DtString &  key)
virtual

Finds the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.

DtRwPropertiesStructure* item = static_cast<DtRwPropertiesStructure*>(
propertiesMap.findItem("Some Resource"));
boost::optional<int> resourceCount = item->findPropertyValue<int>("Count");
virtual DtPropertyInterface* DtRwPropertiesMap::findItem ( int  key)
virtual

Finds the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.

DtRwPropertiesStructure* item = static_cast<DtRwPropertiesStructure*>(
propertiesMap.findItem("Some Resource"));
boost::optional<int> resourceCount = item->findPropertyValue<int>("Count");
virtual DtPropertyInterface* DtRwPropertiesMap::findItem ( double  key)
virtual

Finds the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.

DtRwPropertiesStructure* item = static_cast<DtRwPropertiesStructure*>(
propertiesMap.findItem("Some Resource"));
boost::optional<int> resourceCount = item->findPropertyValue<int>("Count");
virtual DtPropertyInterface* DtRwPropertiesMap::findItem ( const Key &  key)
virtual

Finds the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.

DtRwPropertiesStructure* item = static_cast<DtRwPropertiesStructure*>(
propertiesMap.findItem("Some Resource"));
boost::optional<int> resourceCount = item->findPropertyValue<int>("Count");
virtual const DtPropertyInterface* DtRwPropertiesMap::findItem ( const DtString &  key) const
virtual

Finds the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.

DtRwPropertiesStructure* item = static_cast<DtRwPropertiesStructure*>(
propertiesMap.findItem("Some Resource"));
boost::optional<int> resourceCount = item->findPropertyValue<int>("Count");

This version returns a const pointer.

virtual const DtPropertyInterface* DtRwPropertiesMap::findItem ( int  key) const
virtual

Finds the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.

DtRwPropertiesStructure* item = static_cast<DtRwPropertiesStructure*>(
propertiesMap.findItem("Some Resource"));
boost::optional<int> resourceCount = item->findPropertyValue<int>("Count");
virtual const DtPropertyInterface* DtRwPropertiesMap::findItem ( double  key) const
virtual

Finds the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.

DtRwPropertiesStructure* item = static_cast<DtRwPropertiesStructure*>(
propertiesMap.findItem("Some Resource"));
boost::optional<int> resourceCount = item->findPropertyValue<int>("Count");
virtual const DtPropertyInterface* DtRwPropertiesMap::findItem ( const Key &  key) const
virtual

Finds the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a DtPropertyInterface pointer to this item. If the item cannot be found returns a null pointer.

DtRwPropertiesStructure* item = static_cast<DtRwPropertiesStructure*>(
propertiesMap.findItem("Some Resource"));
boost::optional<int> resourceCount = item->findPropertyValue<int>("Count");
template<typename ValueType >
boost::optional< ValueType > DtRwPropertiesMap::findItemValue ( const DtString &  key) const

Finds the value of the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a boost::optional to the value of this item. If the item is not found or the value cannot be converted to the specified type, the boost::optional will be false.

boost::optional<int> numSoldiers = propertiesMap.findItemValue<int>("Num Soldiers");

References keyIsString().

template<typename ValueType >
boost::optional< ValueType > DtRwPropertiesMap::findItemValue ( int  key) const

Finds the value of the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a boost::optional to the value of this item. If the item is not found or the value cannot be converted to the specified type, the boost::optional will be false.

boost::optional<int> numSoldiers = propertiesMap.findItemValue<int>("Num Soldiers");

References convertKeyToString().

template<typename ValueType >
boost::optional< ValueType > DtRwPropertiesMap::findItemValue ( double  key) const

Finds the value of the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a boost::optional to the value of this item. If the item is not found or the value cannot be converted to the specified type, the boost::optional will be false.

boost::optional<int> numSoldiers = propertiesMap.findItemValue<int>("Num Soldiers");

References convertKeyToString().

template<typename ValueType >
boost::optional< ValueType > DtRwPropertiesMap::findItemValue ( const Key &  key) const

Finds the value of the item with the specified key. Will fail if the type of the key does not match the type of myKeyType. Returns a boost::optional to the value of this item. If the item is not found or the value cannot be converted to the specified type, the boost::optional will be false.

boost::optional<int> numSoldiers = propertiesMap.findItemValue<int>("Num Soldiers");

References DtRwPropertiesMap::Key::string().

virtual bool DtRwPropertiesMap::insert ( const DtString &  key,
DtPropertyInterface *  item 
)
virtual

Insertion functions for adding a new item to the map. Will fail if the type of the key does not match the type of myKeyType or if the type of the item does not match the type of myPrototype. If an element with that key already exists, it will not be replaced. If the item is added, the map takes ownership of it. Returns a bool indicating whether the insertion took place.

DtRwPropertyInt* newItem = new DtRwPropertyInt("", 4);
bool wasAdded = propertiesMap.insert("Num Soldiers", newItem);
virtual bool DtRwPropertiesMap::insert ( int  key,
DtPropertyInterface *  item 
)
virtual

Insertion functions for adding a new item to the map. Will fail if the type of the key does not match the type of myKeyType or if the type of the item does not match the type of myPrototype. If an element with that key already exists, it will not be replaced. If the item is added, the map takes ownership of it. Returns a bool indicating whether the insertion took place.

DtRwPropertyInt* newItem = new DtRwPropertyInt("", 4);
bool wasAdded = propertiesMap.insert("Num Soldiers", newItem);
virtual bool DtRwPropertiesMap::insert ( double  key,
DtPropertyInterface *  item 
)
virtual

Insertion functions for adding a new item to the map. Will fail if the type of the key does not match the type of myKeyType or if the type of the item does not match the type of myPrototype. If an element with that key already exists, it will not be replaced. If the item is added, the map takes ownership of it. Returns a bool indicating whether the insertion took place.

DtRwPropertyInt* newItem = new DtRwPropertyInt("", 4);
bool wasAdded = propertiesMap.insert("Num Soldiers", newItem);
virtual bool DtRwPropertiesMap::insert ( const Key &  key,
DtPropertyInterface *  item 
)
virtual

Insertion functions for adding a new item to the map. Will fail if the type of the key does not match the type of myKeyType or if the type of the item does not match the type of myPrototype. If an element with that key already exists, it will not be replaced. If the item is added, the map takes ownership of it. Returns a bool indicating whether the insertion took place.

DtRwPropertyInt* newItem = new DtRwPropertyInt("", 4);
bool wasAdded = propertiesMap.insert("Num Soldiers", newItem);
virtual DtPropertyInterface* DtRwPropertiesMap::addItem ( const DtString &  key)
virtual

Adds a new item to the map of the same type as myPrototype that has the specified key. Returns this item so that it may be set by the caller. If the key is of the wrong type then nothing is added and the returned pointer will be null. If an item with this key already exists, then nothing is added and the returned pointer will be null.

DtRwPropertiesStructure* newItem =
static_cast<DtRwPropertiesStructure*>(propertiesMap.add("Some Resource"));
newItem->findAndSetPropertyValue<int>("Count", 4);
virtual DtPropertyInterface* DtRwPropertiesMap::addItem ( int  key)
virtual

Adds a new item to the map of the same type as myPrototype that has the specified key. Returns this item so that it may be set by the caller. If the key is of the wrong type then nothing is added and the returned pointer will be null. If an item with this key already exists, then nothing is added and the returned pointer will be null.

DtRwPropertiesStructure* newItem =
static_cast<DtRwPropertiesStructure*>(propertiesMap.add("Some Resource"));
newItem->findAndSetPropertyValue<int>("Count", 4);
virtual DtPropertyInterface* DtRwPropertiesMap::addItem ( double  key)
virtual

Adds a new item to the map of the same type as myPrototype that has the specified key. Returns this item so that it may be set by the caller. If the key is of the wrong type then nothing is added and the returned pointer will be null. If an item with this key already exists, then nothing is added and the returned pointer will be null.

DtRwPropertiesStructure* newItem =
static_cast<DtRwPropertiesStructure*>(propertiesMap.add("Some Resource"));
newItem->findAndSetPropertyValue<int>("Count", 4);
virtual DtPropertyInterface* DtRwPropertiesMap::addItem ( const Key &  key)
virtual

Adds a new item to the map of the same type as myPrototype that has the specified key. Returns this item so that it may be set by the caller. If the key is of the wrong type then nothing is added and the returned pointer will be null. If an item with this key already exists, then nothing is added and the returned pointer will be null.

DtRwPropertiesStructure* newItem =
static_cast<DtRwPropertiesStructure*>(propertiesMap.add("Some Resource"));
newItem->findAndSetPropertyValue<int>("Count", 4);
virtual bool DtRwPropertiesMap::erase ( const DtString &  key)
virtual

Erases the item with the specified key. Returns true if the item was found and erased. May also erase using an iterator to the item, as implemented in DtRwPropertiesList.

propertiesMap.erase("Num Soldiers");
virtual bool DtRwPropertiesMap::erase ( int  key)
virtual

Erases the item with the specified key. Returns true if the item was found and erased. May also erase using an iterator to the item, as implemented in DtRwPropertiesList.

propertiesMap.erase("Num Soldiers");
virtual bool DtRwPropertiesMap::erase ( double  key)
virtual

Erases the item with the specified key. Returns true if the item was found and erased. May also erase using an iterator to the item, as implemented in DtRwPropertiesList.

propertiesMap.erase("Num Soldiers");
virtual bool DtRwPropertiesMap::erase ( const Key &  key)
virtual

Erases the item with the specified key. Returns true if the item was found and erased. May also erase using an iterator to the item, as implemented in DtRwPropertiesList.

propertiesMap.erase("Num Soldiers");
DtPropertyInterface& DtRwPropertiesMap::operator[] ( const DtString &  key)
const DtPropertyInterface& DtRwPropertiesMap::operator[] ( const DtString &  key) const
DtPropertyInterface& DtRwPropertiesMap::operator[] ( double  key)
const DtPropertyInterface& DtRwPropertiesMap::operator[] ( double  key) const
DtPropertyInterface& DtRwPropertiesMap::operator[] ( int  key)
const DtPropertyInterface& DtRwPropertiesMap::operator[] ( int  key) const
DtPropertyInterface& DtRwPropertiesMap::operator[] ( const Key &  key)
const DtPropertyInterface& DtRwPropertiesMap::operator[] ( const Key &  key) const
virtual const char* DtRwPropertiesMap::readerWriterType ( ) const
overridevirtual

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 DtRwPropertiesList.

static const char* DtRwPropertiesMap::theXmlType ( )
static

The type that is used when archiving to an XML stream.

virtual const char* DtRwPropertiesMap::xmlType ( ) const
inlineoverridevirtual

Reimplemented from DtRwPropertiesList.

References DtRwPropertiesList::theXmlType().

DtRwPropertiesMap& DtRwPropertiesMap::operator= ( const DtRwPropertiesMap &  )
virtual void DtRwPropertiesMap::setKeyType ( const DtString &  )
virtual

Sets/gets the key type.

virtual const DtReaderWriter* DtRwPropertiesMap::keyType ( ) const
virtual

Sets/gets the key type.

virtual bool DtRwPropertiesMap::keyIsInt ( ) const
virtual

Returns the type of key.

virtual bool DtRwPropertiesMap::keyIsReal ( ) const
virtual

Returns the type of key.

virtual bool DtRwPropertiesMap::keyIsString ( ) const
virtual

Returns the type of key.

Referenced by findItemValue().

virtual Key DtRwPropertiesMap::keyOfItem ( const DtPropertyInterface *  item) const
virtual

Returns the key of the specified item in this map. NOTE: Assumes item is in this table!

virtual std::set<Key> DtRwPropertiesMap::allKeys ( ) const
virtual

Returns the set of all keys in this table.

virtual bool DtRwPropertiesMap::isSimilarProperty ( const DtPropertyInterface *  rhs,
bool  strict = true 
) const
overridevirtual

Returns true if the prototype and key are the same types.

Reimplemented from DtRwPropertiesList.

virtual int DtRwPropertiesMap::hlaAlignment ( ) const
overridevirtual

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

Reimplemented from DtRwPropertiesList.

bool DtRwPropertiesMap::operator== ( const DtRwPropertiesMap &  ) const
virtual bool DtRwPropertiesMap::convertKeyToString ( int  key,
DtString &  str 
) const
protectedvirtual

Convert the given int key to a DtString. If not possible, returns false.

Referenced by findItemValue().

virtual bool DtRwPropertiesMap::convertKeyToString ( double  key,
DtString &  str 
) const
protectedvirtual

Convert the given double key to a DtString. If not possible, returns false.

virtual bool DtRwPropertiesMap::convertStringToKey ( const DtString &  str,
int &  key 
) const
protectedvirtual

Convert the given DtString to an int key. If not possible, returns false.

virtual bool DtRwPropertiesMap::convertStringToKey ( const DtString &  str,
double &  key 
) const
protectedvirtual

Convert the given DtString to a double key. If not possible, returns false.

virtual DtPropertyInterface* DtRwPropertiesMap::createPrototype ( DtlObjPtr  args)
overrideprotectedvirtual

Get the key type before processing the rest of the items.

Reimplemented from DtRwPropertiesList.

virtual DtlObjPtr DtRwPropertiesMap::variablesStart ( DtlObjPtr  args) const
overrideprotectedvirtual

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesMap::createListEntry ( DtPropertyInterface *  iFace,
DtlObjPtr  variableItem,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
overrideprotectedvirtual

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesMap::getSize ( const DtPropertyInterface *  ,
int &  size 
) const
overrideprotectedvirtual

Returns the size, in bytes, of the given item from the map plus the key.

Reimplemented from DtRwProperties.

virtual char* DtRwPropertiesMap::encode ( const DtPropertyInterface *  ,
char *  buf 
) const
overrideprotectedvirtual

Encodes the given item from the map, including the key.

Reimplemented from DtRwProperties.

virtual const char* DtRwPropertiesMap::decode ( DtPropertyInterface *  iFace,
const char *  buf 
)
overrideprotectedvirtual

Decodes the given item from the map, including the key.

Reimplemented from DtRwPropertiesList.

virtual int DtRwPropertiesMap::requiredPadding ( const char *  buf,
const DtPropertyInterface *  field 
) const
overrideprotectedvirtual

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

Reimplemented from DtRwProperties.

virtual void DtRwPropertiesMap::writePrototype ( const DtReaderWriter *  rw,
std::string &  fp,
int  indentLevel,
bool  writeHeader 
) const
overrideprotectedvirtual

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesMap::getData ( const DtEnvironmentSP  ,
const DtEnvValueSP  ,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  bindings 
)
overrideprotectedvirtual

Gets data from the environment value.

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesMap::putData ( DtEnvironmentSP  ,
DtEnvValueSP  value 
) const
overrideprotectedvirtual

Override to add attributes of actual data.

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesMap::postWriteItem ( std::string &  fp,
DtReaderWriter *  rw,
int  indentLevel 
)
overrideprotectedvirtual

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesMap::preWriteItem ( std::string &  fp,
DtReaderWriter *  rw,
int  indentLevel 
)
overrideprotectedvirtual

Reimplemented from DtRwPropertiesList.

virtual DtPropertyInterface* DtRwPropertiesMap::scratchItem ( ) const
protectedvirtual
virtual const DtPropertyInterface* DtRwPropertiesMap::findPropertyInterfaceByStringKey ( const DtString &  keyStr) const
protectedvirtual

Finds an item's property interface by its string key. Differs from findPropertyInterface in that it allows a '.' in the string, which findPropertyInterface assumes to be a delimiter indicating the name of a new field within a property.

virtual DtPropertyInterface* DtRwPropertiesMap::findPropertyInterfaceByStringKey ( const DtString &  keyStr)
protectedvirtual

Finds an item's property interface by its string key. Differs from findPropertyInterface in that it allows a '.' in the string, which findPropertyInterface assumes to be a delimiter indicating the name of a new field within a property.

Member Data Documentation

DtPropertyInterface* DtRwPropertiesMap::myKeyType
mutableprotected
DtPropertyInterface* DtRwPropertiesMap::myScratchItem
mutableprotected
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)