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 (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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.
virtual int	alignment () const
	Return HLA network alignment. sizeof(char)
virtual void	reset ()
	Resets value to initial clear state.
bool	operator== (const DtRwString &) const
bool	operator== (const DtString &) const
bool	operator!= (const DtString &rhs) const
bool	operator!= (const DtRwString &rhs) const
bool	operator== (const char *) const
bool	operator!= (const char *rhs) const
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 void	writeSelf (std::string &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 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 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	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
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 &)
	Restires 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.

Protected Member Functions
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Overridden to manage in-text variable substitution.
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 ()

Protected Attributes
DtString	myUnsubstitutedString
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.
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual const char *	xmlType () const
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.

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 )()
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 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

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  )

explicit

real constructor

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

explicit

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 DtRwAnimationModelString.

DtRwString& DtRwString::operator=

(

const char *

orig

)

Reimplemented in DtRwAnimationModelString.

DtRwString& DtRwString::operator=

(

const DtString &

orig

)

Reimplemented in DtRwAnimationModelString, and DtRwVrfObjectName.

DtRwString& DtRwString::operator=

(

const DtSymbolString &

orig

)

Reimplemented in DtRwAnimationModelString.

virtual void DtRwString::putData ( std::string &  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 DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Reimplemented in DtRwProperty< DtRwString >, and DtRwVrfObjectName.

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 DtRwAnimationModelString.

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.

virtual int DtRwString::alignment ( ) const

virtual

Return HLA network alignment. sizeof(char)

Reimplemented from DtReaderWriter.

virtual void DtRwString::reset ( )

virtual

Resets value to initial clear state.

Reimplemented from DtReaderWriter.

Reimplemented in DtRwProperty< DtRwString >.

virtual void DtRwString::putData ( DtEnvironmentSP  , DtEnvValueSP  parent  ) const

virtual

Routines to archive/dearchive from an XML Environment

Reimplemented from DtReaderWriter.

virtual void DtRwString::getData ( const DtEnvironmentSP  , const DtEnvValueSP  value, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(), const DtVariableBindingsList &  bindings = DtVariableBindingsList()  )

virtual

static const char* DtRwString::theXmlType ( )

static

The type that is used when archiving to an XML stream.

Reimplemented from DtReaderWriter.

Reimplemented in DtRwAnimationModelString.

Referenced by DtRwAnimationModelString::xmlType().

virtual const char* DtRwString::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

Reimplemented in DtRwAnimationModelString.

References DtReaderWriter::theXmlType().

bool DtRwString::operator==

(

const DtRwString &

)

const

bool DtRwString::operator==

(

const DtString &

)

const

bool DtRwString::operator!= ( const DtString &  rhs ) const

inline

bool DtRwString::operator!= ( const DtRwString &  rhs ) const

inline

bool DtRwString::operator==

(

const char *

)

const

bool DtRwString::operator!= ( const char *  rhs ) const

inline

virtual void DtRwString::bindLocalVariables ( const DtVariableBindingsList &  variableBindings )

protectedvirtual

Overridden to manage in-text variable substitution.

Member Data Documentation

DtString DtRwString::myUnsubstitutedString

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/rwString.h