DtRwPropertiesStructure Class Reference

Properties list with a defined set of fields, akin to a C structure. More...

Inheritance diagram for DtRwPropertiesStructure:

Public Member Functions
	DtRwPropertiesStructure (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwPropertiesStructure (const DtString &name, 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.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual bool	isSimilarProperty (const DtPropertyInterface *rhs) const
	Returns true if the readerWriterType and all registry items have the same readerWriter type.
Public Member Functions inherited from DtRwProperties
	DtRwProperties (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwProperties (const DtString &name, const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
	DtRwProperties (const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
DtRwProperties &	operator= (const DtRwProperties &orig)
virtual	~DtRwProperties ()
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.
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.
virtual bool	isValidProperty (const DtPropertyInterface *) const
	Returns true if this is a valid property for the properties list.
virtual DtPropertyInterface *	createProperty (DtlObjPtr args, DtReaderWriterRegistry *parentRegistry)
	Creates a property from the mtl stream.
virtual char *	encode (char *) const
	Encodes the variable bindings into the supplied buffer.
virtual const char *	decode (const char *)
	Decodes the variable bindings from the specified buffer.
virtual void	getSize (int &size) const
	Returns the size of this item, iterating over all types.
virtual void	copyVariables (const DtRwVariableBindings &other)
	Clones variables using the property factory.
virtual bool	isReadonly () const
virtual int	hlaAlignment () const
	The required byte alignment of this property when encoding to HLA.
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.
virtual const char *	propertyType () const
	Typically returns reader/writer type.
virtual int	count () const
	Number of properties.
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.
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.
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.
virtual bool	wasUpdatedSince (DtTime t) const
	Returns true if an update occurred since the specified time.
virtual void	clearVariables ()
	Removes and deletes all variable items.
virtual void	reset ()
	Clears all variables.
virtual void	invalidateCache ()
	Invalidates the entire cache.
virtual void	invalidateCacheForProperty (const DtString &propName)
	Invalidates the single cache entry for the given property name.
virtual const DtReaderWriter *	findProperty (const DtString &propName) const
	Returns the ReaderWriter for the (first) property that matches the given property name.
virtual DtReaderWriter *	findProperty (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.
virtual void	setIsPublished (bool isPub)
virtual unsigned	disRecordType () const
	If this property is published, which DIS record type should it use.
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.
virtual void	addVariable (DtReaderWriter *)
	Adds a newly created DtReaderWriter variable to the registry.
virtual int	getSize () const
	Returns the size of this item, iterating over all types.
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.
virtual const DtReaderWriter *	findVariableBinding (const DtString &rwTypeString, const DtString &variableName) const
	Looks for the specified name/type combination in the registry, and returns a pointer to that RW object if it is found.
virtual DtReaderWriter *	findVariableBinding (const DtString &rwTypeString, const DtString &variableName)
virtual const DtReaderWriter *	findVariableBinding (const DtString &variableName) const
	Finds the variable with the given name regardless of type.
virtual DtReaderWriter *	findVariableBinding (const DtString &variableName)
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.
Public Member Functions inherited from DtPropertyInterface
virtual	~DtPropertyInterface ()
int	getSize () const
virtual bool	isPublishedArg (DtlObjPtr arg, unsigned &disVarRecType) const
	Tests whether the argument specified indicates this property should be published.

Static Public Member Functions
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
Static Public Member Functions inherited from DtRwProperties
static DtReaderWriterPropertyFactory *	propertyFactory ()
	Returns the factory used to create properties.
static void	cleanupPropertyFactory ()
static bool	rollUpInteger (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
	Adds integers.
static bool	rollUpReal (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
	Adds reals.
static bool	rollUpString (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
	Will not roll up if values are dissimilar.
static bool	rollUpBoolean (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
	Will not roll up if values are dissimilar.
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.
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 DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
virtual void	getData (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
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.
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...
virtual void	writeSelf (std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
	Writes out registry data, but includes the type strings when writing.
virtual void	putData (std::string &, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual int	hlaAlignment (const DtPropertyInterface *field) const
virtual void	getSize (const DtPropertyInterface *, int &size) const
	Returns the size of the readerWriter item.
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.
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.

Private Member Functions
	DtRwPropertiesStructure ()
	Not implemented.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Public Types inherited from DtPropertyInterface
enum	MergeFlags {   Replace = 0x00000001, MinimalSimilarityCheck = 0x00000002, RollUp = 0x00000004, AddMissing = 0x00000008,   KeepIsPublished = 0x00000010 }
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.
int	mySizeAtLastCheck
	Stores the number of items in the last at the last time it was discovered the size changed.
bool	myIsPublished
unsigned	myDisRecordType
Static Protected Attributes inherited from DtRwProperties
static DtReaderWriterPropertyFactory *	thePropertyFactory

Detailed Description

Properties list with a defined set of fields, akin to a C structure.

Constructor & Destructor Documentation

DtRwPropertiesStructure::DtRwPropertiesStructure ( )

private

Not implemented.

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

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

virtual DtRwPropertiesStructure::~DtRwPropertiesStructure ( )

virtual

Member Function Documentation

DtRwPropertiesStructure& DtRwPropertiesStructure::operator=

(

const DtRwPropertiesStructure &

orig

)

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.

Reimplemented from DtReaderWriter.

virtual const char* DtRwPropertiesStructure::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual bool DtRwPropertiesStructure::isSimilarProperty ( const DtPropertyInterface *  rhs ) 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  env, const DtEnvValueSP  root, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  varBindings  )

protectedvirtual

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

protectedvirtual

Override to add attributes of actual data.

Reimplemented from DtReaderWriter.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfutil/rwPropertiesStructure.h