DtRwProperties Class Reference

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.

Inheritance diagram for DtRwProperties:

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 }

Public Member Functions
DtRwProperties &	operator= (const DtRwProperties &orig)
virtual	~DtRwProperties ()
virtual unsigned	size () const
virtual bool	addProperty (DtPropertyInterface *)
virtual bool	addPropertyAtIndex (DtPropertyInterface *, unsigned index)
virtual void	copy (const DtPropertyInterface &rhs)
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual const char *	readerWriterType () const
virtual bool	isValidProperty (const DtPropertyInterface *) const
virtual DtPropertyInterface *	createProperty (DtlObjPtr args, DtReaderWriterRegistry *parentRegistry)
virtual char *	encode (char *) const
virtual const char *	decode (const char *)
virtual void	getSize (int &size) const
virtual void	copyVariables (const DtRwVariableBindings &other)
virtual bool	isReadonly () const
virtual int	hlaAlignment () const
virtual int	requiredPadding (const char *buf, const DtPropertyInterface *field) const
virtual const char *	propertyType () const
virtual int	count () const
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 >())
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
virtual void	setPropertyName (const DtString &propertyName)
virtual bool	wasUpdatedSince (DtTime t) const
virtual void	clearVariables ()
virtual void	reset ()
virtual void	invalidateCache ()
virtual void	invalidateCacheForProperty (const DtString &propName)
virtual bool	setWritePrototypeHeader (bool)
virtual bool	writePrototypeHeader () const
virtual void	cloneAndAddProperty (const DtReaderWriter &rw)
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 DtPropertyInterface *	findPropertyInterface (const DtString &propertyName) const
virtual DtPropertyInterface *	findPropertyInterface (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 DtReaderWriter *	findPropertyRw (const DtString &propName) const
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
virtual void	setIsPublished (bool isPub)
virtual unsigned	disRecordType () const
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)
virtual void	addVariable (DtReaderWriter *)
virtual int	getSize () const
bool	operator== (const DtRwVariableBindings &) const
bool	operator!= (const DtRwVariableBindings &) const
virtual DtString	prettyPrint () const
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)
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 &)
virtual const char *	xmlType () const
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	putData (DtEnvironmentSP, DtEnvValueSP value) 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	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
Public Member Functions inherited from DtPropertyInterface
virtual	~DtPropertyInterface ()
virtual bool	isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const
virtual bool	isPublishedArg (DtlObjPtr arg, unsigned &disVarRecType) const
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 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 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	writeSelf (std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
virtual void	writeData (std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
virtual void	putData (std::string &, int indentLevel=0)
virtual int	hlaAlignment (const DtPropertyInterface *field) const
virtual void	getSize (const DtPropertyInterface *, int &size) const
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)
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	getSortedProperties (const DtRwVariableBindings &varBindings, std::vector< const DtReaderWriter * > &propertyList) const
virtual void	getSortedProperties (DtRwVariableBindings &varBindings, std::vector< DtReaderWriter * > &propertyList)
virtual bool	isDebugEnabled () const
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
virtual bool	keywordMatches (const DtSymbolString &lhs, const DtString &rhs, const std::map< DtString, DtString > &variableSubstitutions) const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
std::multimap< DtString, DtReaderWriter * >	myRwPropertyCache
tbb::spin_mutex *	myCacheMutex
DtClock	myClock
DtTime	myLastTimeSizeChanged
int	mySizeAtLastCheck
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
bool	myInvalid
bool	myChangedFlag

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 DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Private Member Functions
	DtRwProperties ()

Member Typedef Documentation

typedef DtPropertiesIterator DtRwProperties::iterator

typedef DtPropertiesConstIterator DtRwProperties::const_iterator

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

Reimplemented from DtPropertyInterface.

Referenced by DtRwPropertiesStructure::findFieldPropertyInterface().

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. Buffer must already be properly aligned to hlaAlignment().

Implements DtPropertyInterface.

Reimplemented in DtRwPropertiesList, and DtRwPropertiesFixedArray.

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

virtual

Decodes the variable bindings from the specified buffer. Buffer should already be properly aligned to hlaAlignment().

Implements DtPropertyInterface.

Reimplemented in DtRwPropertiesList, and DtRwPropertiesFixedArray.

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

virtual

Adds the network size of this item in bytes, iterating over all contained items. This does not include any upfront padding for alignment, but it does include any alignment within the property to align its fields.

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.

Reimplemented in DtRwPropertiesMap, and DtRwPropertiesList.

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.

Reimplemented in DtRwPropertiesMap.

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

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

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.

Referenced by makVrf::DtSetStatePropertyDialog::setupGui().

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

Returns a ReaderWriter pointer of the property.

Implements DtPropertyInterface.

virtual DtPropertyInterface* DtRwProperties::property ( )

virtual

Returns a PropertyInterface pointer of the ReaderWriter.

Reimplemented from DtReaderWriter.

virtual const DtPropertyInterface* DtRwProperties::property ( ) const

virtual

Returns a PropertyInterface pointer of the ReaderWriter.

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

Whether this property should be published.

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

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

Overridden to also remove the DtReaderWriter from myRwPropertyCache.

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

Referenced by DtExtAggregateStateRepository::parameterProperties(), DtControlObjectRepository::parameterProperties(), DtExtEntityStateRepository::parameterProperties(), DtExtAggregateStateRepository::stateProperties(), DtControlObjectRepository::stateProperties(), and DtExtEntityStateRepository::stateProperties().

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

static

Roll Up rules. Returns true if roll up succeeds.

Adds integers

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

Reimplemented in DtRwPropertiesFixedArray.

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

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

virtual bool DtRwProperties::isDebugEnabled ( ) const

protectedvirtual

Enables debug output. Generally this should be left off.

Implements DtPropertyInterface.

virtual void DtRwProperties::setDebugEnabled ( bool  en )

protectedvirtual

Enables debug output. Generally this should be left off.

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/readerWriter/rwProperties.h