A structure composed of distinct fields, each of which is itself a property. More...

Inheritance diagram for DtRwPropertiesStructure:

Public Member Functions
	DtRwPropertiesStructure ()

	DtRwPropertiesStructure (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtRwPropertiesStructure (const DtString &name, const DtRwPropertiesStructure &orig, DtReaderWriterRegistry *parentRegistry=0)

	DtRwPropertiesStructure (const DtRwPropertiesStructure &orig, DtReaderWriterRegistry *parentRegistry=0)

DtRwPropertiesStructure &	operator= (const DtRwPropertiesStructure &orig)

virtual	~DtRwPropertiesStructure ()

virtual void	putSelf (std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
	Top level call to write itself to file. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual void	copyVariables (const DtRwVariableBindings &other)
	Copies the values from the other structure. More...

virtual bool	isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const
	Returns true if the readerWriterType and all registry items have the same readerWriter type. More...

Generic field lookup functions
These functions return the DtPropertyInterface for the named field, assuming it is found within this structure. If this field cannot be found, a null pointer is returned. Because fields are themselves just properties, this is just a wrapper for DtRwProperties::findPropertyInterface.
const DtPropertyInterface *	findFieldPropertyInterface (const DtString &fieldName) const

DtPropertyInterface *	findFieldPropertyInterface (const DtString &fieldName)

Specific field type lookup functions
These functions return the specific property type for the named field, assuming it is found within this property and matches this type. If this field cannot be found or is of the wrong type, a null pointer is returned. Because fields are themselves just properties, this is just a wrapper for DtRwProperties::findProperty.
template<typename SpecificPropType >
const SpecificPropType *	findField (const DtString &fieldName) const

template<typename SpecificPropType >
SpecificPropType *	findField (const DtString &fieldName)

Convenience functions for finding and getting/setting field value
This is a convenience function that combines the functionality of findField and propertyValue to immediately return the value of the field with the given name, assuming it can be found within this property and its value can be converted to the specified type. If not, the boost::optional will be false. Because fields are themselves just properties, this is just a wrapper for DtRwProperties::findPropertyValue.
template<typename ValueType >
boost::optional< ValueType >	findFieldValue (const DtString &fieldName) const

template<typename ValueType >
bool	findAndSetFieldValue (const DtString &fieldName, ValueType val)
	This is a convenience function that combines the functionality of findField and setPropertyValue to immediately set the value of the field with the given name, assuming it can be found within this property and its value can be converted from the specified type. More...

Field addition functions
These functions can be used to add new properties as fields to a structure. Adds an existing property as a field to the structure. The structure will take ownership of the given property. Returns false if this operation was not possible. Because fields are themselves just properties, this is just a wrapper for DtRwPropertiesStructure::addProperty.
virtual bool	addField (DtPropertyInterface *field)

template<typename SpecificPropType >
SpecificPropType *	addNewField (const DtString &fieldName)
	Adds a new property of the specified type as a field to the structure and returns pointer to the new item. More...

Field removal functions
These functions can be used to remove fields from a structure. Returns true if successful. Because fields are themselves just properties, this is just a wrapper for DtRwPropertiesStructure::removeProperty.
virtual bool	removeField (const DtString &propertyName)

virtual bool	removeField (const DtPropertyInterface *property)

Overloads for operator[]
These operator[] overloads allow you to access a fields by their name. If the field does not exist, an uninitialized property will be returned that is not part of the structure, so care must be taken. Should only be used for known fields, not to add new ones. boost::optional<DtString> vehicleType = vehicleProperty["Vehicle Type"].propertyValue<DtString>(); vehicleProperty["Fuel Amount"].setPropertyValue<double>(12.5);
DtPropertyInterface &	operator[] (const DtString &fieldName)

const DtPropertyInterface &	operator[] (const DtString &fieldName) const

Public Member Functions inherited from DtRwProperties
DtRwProperties &	operator= (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 bool	isValidProperty (const DtPropertyInterface *) const
	Returns true if this is a valid property for the properties list. More...

virtual DtPropertyInterface *	createProperty (DtlObjPtr args, DtReaderWriterRegistry *parentRegistry)
	Creates a property from the mtl stream. More...

virtual char *	encode (char *) const
	Encodes the variable bindings into the supplied buffer. More...

virtual const char *	decode (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 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 char *	propertyType () 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...

	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

virtual DtPropertyInterface *	findPropertyInterface (const DtString &propertyName)

virtual bool	removeProperty (const DtString &propertyName)

virtual bool	removeProperty (const DtPropertyInterface *property)

virtual const DtReaderWriter *	findPropertyRw (const DtString &propName) const
	Returns the ReaderWriter for the (first) property that matches the given property name. More...

virtual DtReaderWriter *	findPropertyRw (const DtString &propName)

virtual DtReaderWriter *	readerWriter ()

virtual const DtReaderWriter *	readerWriter () const

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual bool	isPublished () const
	Whether this property should be published. 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)

DtRwVariableBindings &	operator= (const DtRwVariableBindings &orig)

virtual	~DtRwVariableBindings ()

template<typename RW_Type >
const RW_Type *	findAndCastVariableBinding (const DtString &variableName) const

virtual DtReaderWriter *	addVariableBinding (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 DtReaderWriter *	findVariableBinding (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 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
	Finds the variable with the given name regardless of type. More...

virtual DtReaderWriter *	findVariableBinding (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 DtReaderWriter &	operator= (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	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 aliasContainer &	aliases () 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...

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 DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () 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	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	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	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 const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

Static Public Member Functions inherited from DtRwProperties
static DtReaderWriterPropertyFactory *	propertyFactory ()
	Returns the factory used to create properties. Types are by RW types. More...

static void	cleanupPropertyFactory ()

static const DtRwProperties &	emptyProperties ()

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 DtRwVariableBindings *	createBinding (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 char *	theXmlType ()
	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 DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (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	getData (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Gets data from the environment value. More...

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

Protected Member Functions inherited from DtRwProperties
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 char *	encode (const DtPropertyInterface , char buf) const

virtual const char *	decode (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 DtReaderWriter *	internalFindVariableBinding (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
DtPropertyInterface *	myScratchItem

Protected Attributes inherited from DtRwProperties
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

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

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, KeepIsPublished = 0x00000010 }
	Determines how two lists of properties will be merged by the merge function. More...

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

Detailed Description

A structure composed of distinct fields, each of which is itself a property.

The DtRwPropertiesStructure is composed of multiple component properties that function as fields to a structure, similar to a structure in C++. Each field is itself a property. This class provides functions to easily find and access the fields within the property.

Constructor & Destructor Documentation

DtRwPropertiesStructure::DtRwPropertiesStructure ( )

DtRwPropertiesStructure::DtRwPropertiesStructure	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtRwPropertiesStructure::DtRwPropertiesStructure	(	const DtString &	name,
		const DtRwPropertiesStructure &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtRwPropertiesStructure::DtRwPropertiesStructure	(	const DtRwPropertiesStructure &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtRwPropertiesStructure::~DtRwPropertiesStructure ( )

virtual

Member Function Documentation

DtRwPropertiesStructure& DtRwPropertiesStructure::operator= ( const DtRwPropertiesStructure & orig )

const DtPropertyInterface* DtRwPropertiesStructure::findFieldPropertyInterface ( const DtString & fieldName ) const

inline

References DtRwProperties::findPropertyInterface().

DtPropertyInterface* DtRwPropertiesStructure::findFieldPropertyInterface ( const DtString & fieldName )

inline

References DtRwProperties::findPropertyInterface().

template<typename SpecificPropType >

const SpecificPropType* DtRwPropertiesStructure::findField ( const DtString & fieldName ) const

inline

template<typename SpecificPropType >

SpecificPropType* DtRwPropertiesStructure::findField ( const DtString & fieldName )

inline

template<typename ValueType >

boost::optional<ValueType> DtRwPropertiesStructure::findFieldValue ( const DtString & fieldName ) const

inline

template<typename ValueType >

bool DtRwPropertiesStructure::findAndSetFieldValue	(	const DtString &	fieldName,
		ValueType	val
	)

inline

This is a convenience function that combines the functionality of findField and setPropertyValue to immediately set the value of the field with the given name, assuming it can be found within this property and its value can be converted from the specified type.

If successful, returns true, otherwise returns false. Because fields are themselves just properties, this is just a wrapper for DtRwProperties::findPropertyValue.

virtual bool DtRwPropertiesStructure::addField ( DtPropertyInterface * field )

inlinevirtual

References DtRwProperties::addProperty().

template<typename SpecificPropType >

SpecificPropType* DtRwPropertiesStructure::addNewField ( const DtString & fieldName )

inline

Adds a new property of the specified type as a field to the structure and returns pointer to the new item.

Returns a null pointer if a field with that name already existed. Because fields are themselves just properties, this is just a wrapper for DtRwPropertiesStructure::addNewProperty.

virtual bool DtRwPropertiesStructure::removeField ( const DtString & propertyName )

inlinevirtual

References DtRwProperties::removeProperty().

virtual bool DtRwPropertiesStructure::removeField ( const DtPropertyInterface * property )

inlinevirtual

References DtRwProperties::removeProperty().

DtPropertyInterface& DtRwPropertiesStructure::operator[] ( const DtString & fieldName )

const DtPropertyInterface& DtRwPropertiesStructure::operator[] ( const DtString & fieldName ) const

virtual void DtRwPropertiesStructure::putSelf	(	std::string &	fp,
		int	indentLevel,
		bool	writeUnspecified,
		const DtFilename &	path
	)

virtual

Top level call to write itself to file.

If write unspecified is true, will write entries that are unspecified, in the format (name <use-default>). Path is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the path is specified with a non-NULL string, then the path prepended to the filename before writing the entry to file.

Reimplemented from DtReaderWriter.

virtual const char* DtRwPropertiesStructure::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 DtRwProperties.

static const char* DtRwPropertiesStructure::theXmlType ( )

static

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

virtual const char* DtRwPropertiesStructure::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual void DtRwPropertiesStructure::copyVariables ( const DtRwVariableBindings & other )

virtual

Copies the values from the other structure.

Reimplemented from DtRwProperties.

virtual bool DtRwPropertiesStructure::isSimilarProperty	(	const DtPropertyInterface *	rhs,
		bool	strict = `true`
	)		const

virtual

Returns true if the readerWriterType and all registry items have the same readerWriter type.

Reimplemented from DtPropertyInterface.

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

protectedvirtual

Gets data from the environment value.

Reimplemented from DtReaderWriter.

virtual void DtRwPropertiesStructure::putData	(	DtEnvironmentSP	,
		DtEnvValueSP	value
	)		const

protectedvirtual

Override to add attributes of actual data.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtPropertyInterface* DtRwPropertiesStructure::myScratchItem

mutableprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/readerWriter/rwPropertiesStructure.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation