DtRwString Class Reference

Description: Readable, Writable DtString Variable substitutions are done on this object when it is read in from the file. More...

Inheritance diagram for DtRwString:

Public Member Functions
	DtRwString ()
	default constructor
	DtRwString (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtRwString (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwString (const DtString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor from char *
	DtRwString (const DtSymbolString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwString (const DtString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwString (const DtSymbolString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwString (const DtString &name, const DtRwString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwString (const DtSymbolString &name, const DtRwString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwString (const DtRwString &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtRwString &	operator= (const DtRwString &orig)
	Assign to DtString. Assigns value only.
DtRwString &	operator= (const char *orig)
DtRwString &	operator= (const DtString &orig)
DtRwString &	operator= (const DtSymbolString &orig)
virtual	~DtRwString ()
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.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	unsubstitutedString () const
virtual void	setUnsubstitutedString (const DtString &)
	Sets the unsubstitude string value.
virtual bool	containsVariableSubstitutions () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of this variable.
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 void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
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 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.

Protected Attributes
DtString	myUnsubstitutedString
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.

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
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 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.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

Description: Readable, Writable DtString Variable substitutions are done on this object when it is read in from the file.

Variables are specified as $(<variable-name>). The unsubstituted version of the string is accessable using unsubstitutedString().

Constructor & Destructor Documentation

DtRwString::DtRwString

(

)

default constructor

DtRwString::DtRwString	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

real constructor

DtRwString::DtRwString	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwString::DtRwString	(	const DtString &	name,
		const char *	fromChars,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

real constructor from char *

DtRwString::DtRwString	(	const DtSymbolString &	name,
		const char *	fromChars,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwString::DtRwString	(	const DtString &	name,
		const DtString &	fromString,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwString::DtRwString	(	const DtSymbolString &	name,
		const DtString &	fromString,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwString::DtRwString	(	const DtString &	name,
		const DtRwString &	fromString,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwString::DtRwString	(	const DtSymbolString &	name,
		const DtRwString &	fromString,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwString::DtRwString	(	const DtRwString &	orig,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

copy constructor

virtual DtRwString::~DtRwString ( )

virtual

Member Function Documentation

DtRwString& DtRwString::operator=

(

const DtRwString &

orig

)

Assign to DtString. Assigns value only.

Reimplemented in DtRwObjectName.

DtRwString& DtRwString::operator=

(

const char *

orig

)

Reimplemented in DtRwObjectName.

DtRwString& DtRwString::operator=

(

const DtString &

orig

)

Reimplemented in DtRwObjectName.

DtRwString& DtRwString::operator=

(

const DtSymbolString &

orig

)

Reimplemented in DtRwObjectName.

virtual void DtRwString::putData ( FILE *  fp, int  indentLevel = 0  )

virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwString::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual const char* DtRwString::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 DtRwObjectName.

virtual DtString DtRwString::unsubstitutedString ( ) const

virtual

Returns

The string value that was read in from the RW file before any variable substitutions were made.

virtual void DtRwString::setUnsubstitutedString ( const DtString &  )

virtual

Sets the unsubstitude string value.

Should not be called unless this is really an unsubstitude string

virtual bool DtRwString::containsVariableSubstitutions ( ) const

virtual

Returns

True only if there were variables substituted in this string when it was read from the file. If this is false, unsubstitutedString() returns the same as the normal string value of this object.

virtual DtString DtRwString::prettyPrint ( ) const

virtual

Routine to return a human readable form of this variable.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtString DtRwString::myUnsubstitutedString

protected

---

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

• include/vrfutil/rwString.h