DtRwVariableBindings Class Reference

ReaderWriter object that maintains a list of reader-writer variable bindings. More...

Inheritance diagram for DtRwVariableBindings:

Public Member Functions
	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 ()
virtual void	getSelf (DtlObjPtr args, const std::vector< DtFilename > &searchPaths=std::vector< DtFilename >(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Reads in items, using the factory to read the correct types.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Writes out registry data, but includes the type strings when writing.
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 void	removeVariable (DtReaderWriter *)
virtual void	removeVariable (const DtReaderWriter *)
virtual void	clearVariables ()
	Removes and deletes all variable items.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual int	getSize () const
	Returns the size of this item, iterating over all types.
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.
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	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
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.
virtual const char *	xmlType () const
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	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
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 void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
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 DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
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	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
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.

Static Public Member Functions
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 char *	theXmlType ()
	The type that is used when archiving to an XML stream.
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	copyVariables (const DtRwVariableBindings &other)
	Copies all variable items from another bindings list and adds them to the local one.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Private Member Functions
	DtRwVariableBindings ()
	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 )()
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.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.
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

Detailed Description

ReaderWriter object that maintains a list of reader-writer variable bindings.

It keeps a list of names and reader-writer types that are associated with the name. This object differs from most other RW objects in that it writes out the RW type string for the object along with its name and type, and dynamically types the objects being read in based on the type string in the file. It uses the static DtReaderWriter::factory to do this.

Constructor & Destructor Documentation

DtRwVariableBindings::DtRwVariableBindings ( )

private

Not implemented.

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

DtRwVariableBindings::DtRwVariableBindings	(	const DtString &	name,
		const DtRwVariableBindings &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0,
		bool	copyVariables = true
	)

DtRwVariableBindings::DtRwVariableBindings	(	const DtRwVariableBindings &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0,
		bool	copyVariables = true
	)

virtual DtRwVariableBindings::~DtRwVariableBindings ( )

virtual

Member Function Documentation

DtRwVariableBindings& DtRwVariableBindings::operator=

(

const DtRwVariableBindings &

orig

)

virtual void DtRwVariableBindings::getSelf ( DtlObjPtr  args, const std::vector< DtFilename > &  searchPaths = std::vector< DtFilename >(), const DtVariableBindingsList &  variableBindings = nullVariableReference()  )

virtual

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

Reimplemented in DtRwPropertiesList, and DtRwProperties.

virtual void DtRwVariableBindings::writeSelf ( std::string &  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtFilename::nullFilename()  )

virtual

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

Reimplemented from DtReaderWriter.

Reimplemented in DtRwProperties, DtRwPropertiesList, and DtRwPropertiesMap.

virtual const DtReaderWriter* DtRwVariableBindings::findVariableBinding ( const DtString &  rwTypeString, const DtString &  variableName  ) const

virtual

Looks for the specified name/type combination in the registry, and returns a pointer to that RW object if it is found.

virtual DtReaderWriter* DtRwVariableBindings::findVariableBinding ( const DtString &  rwTypeString, const DtString &  variableName  )

virtual

virtual const DtReaderWriter* DtRwVariableBindings::findVariableBinding ( const DtString &  variableName ) const

virtual

Finds the variable with the given name regardless of type.

virtual DtReaderWriter* DtRwVariableBindings::findVariableBinding ( const DtString &  variableName )

virtual

template<typename RW_Type >

const RW_Type* DtRwVariableBindings::findAndCastVariableBinding ( const DtString &  variableName ) const

inline

static DtRwVariableBindings* DtRwVariableBindings::createBinding ( const std::list< DtReaderWriter::DtVariableNameType > &  )

static

Creates a new instance of this class and creates all elements found in the list and adds it to this variables registry.

Calls addVariableBinding() to add new variable

virtual DtReaderWriter* DtRwVariableBindings::addVariableBinding ( const DtSymbolString &  name, const char *  type  )

virtual

Adds new variable binding to registry.

The new DtReaderWriter item is created using the DtReaderWriter::factory() by passing the type parameter. The item is added to this variable binding structure, and returned.

virtual void DtRwVariableBindings::addVariable ( DtReaderWriter *  )

virtual

Adds a newly created DtReaderWriter variable to the registry.

This class will then take ownership of the variable

virtual void DtRwVariableBindings::removeVariable ( DtReaderWriter *  )

virtual

Reimplemented in DtRwProperties.

virtual void DtRwVariableBindings::removeVariable ( const DtReaderWriter *  )

virtual

Reimplemented in DtRwProperties.

virtual void DtRwVariableBindings::clearVariables ( )

virtual

Removes and deletes all variable items.

Reimplemented in DtRwProperties.

virtual const char* DtRwVariableBindings::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 DtReaderWriter.

Reimplemented in DtRwProperties, DtRwPropertiesList, DtRwPropertiesMap, and DtRwPropertiesStructure.

virtual int DtRwVariableBindings::getSize ( ) const

virtual

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

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

virtual

Encodes the variable bindings into the supplied buffer.

Reimplemented in DtRwProperties, and DtRwPropertiesList.

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

virtual

Decodes the variable bindings from the specified buffer.

Reimplemented in DtRwProperties, and DtRwPropertiesList.

bool DtRwVariableBindings::operator==

(

const DtRwVariableBindings &

)

const

bool DtRwVariableBindings::operator!=

(

const DtRwVariableBindings &

)

const

virtual DtString DtRwVariableBindings::prettyPrint ( ) const

virtual

Routine to return a human readable form of the reader/writer variable.

Not all reader/writer classes implement this feature. Default is to return an empty string

Reimplemented from DtReaderWriter.

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

protectedvirtual

Copies all variable items from another bindings list and adds them to the local one.

Reimplemented in DtRwProperties.

---

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

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