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)
DtRwVariableBindings &	operator= (const DtRwVariableBindings &orig)
virtual	~DtRwVariableBindings ()
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Reads in items, using the factory to read the correct types.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Writes out registry data, but includes the type strings when writing.
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 *)
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.
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)
	Looks for the specified name/type combination in the registry, and returns a pointer to that RW object if it is found.
virtual const DtReaderWriter *	findVariableBinding (const DtString &variableName) const
	Finds the variable with the given name regardless of type.
virtual DtReaderWriter *	findVariableBinding (const DtString &variableName)
	Finds the variable with the given name regardless of type.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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 DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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 (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()

Protected Member Functions
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.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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
	)

virtual DtRwVariableBindings::~DtRwVariableBindings ( )

virtual

Member Function Documentation

DtRwVariableBindings& DtRwVariableBindings::operator=

(

const DtRwVariableBindings &

orig

)

virtual void DtRwVariableBindings::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath = DtFilename::nullFilename(), const DtVariableBindingsList &  variableBindings = nullVariableReference()  )

virtual

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

Reimplemented from DtReaderWriter.

virtual void DtRwVariableBindings::writeSelf ( FILE *  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.

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

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

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

Finds the variable with the given name regardless of type.

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

virtual void DtRwVariableBindings::removeVariable ( const DtReaderWriter *  )

virtual

void DtRwVariableBindings::clearVariables

(

)

Removes and deletes all variable items.

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.

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.

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

virtual

Decodes the variable bindings from the specified buffer.

void DtRwVariableBindings::copyVariables ( const DtRwVariableBindings &  other )

protected

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

---

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

• include/vrfutil/rwVariableBindings.h