DtRwAnimationModelString Class Reference

Simple wrapper class that will be used by Lua to indicate to create an animated model. More...

Inheritance diagram for DtRwAnimationModelString:

Public Member Functions
	DtRwAnimationModelString ()
	default constructor
	DtRwAnimationModelString (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtRwAnimationModelString (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwAnimationModelString (const DtString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor from char *
	DtRwAnimationModelString (const DtSymbolString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwAnimationModelString (const DtString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwAnimationModelString (const DtSymbolString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwAnimationModelString (const DtString &name, const DtRwAnimationModelString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwAnimationModelString (const DtSymbolString &name, const DtRwAnimationModelString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwAnimationModelString (const DtRwAnimationModelString &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
virtual const char *	xmlType () const
DtRwAnimationModelString &	operator= (const DtRwAnimationModelString &orig)
	Assign to DtRwAnimationModelString. Assigns value only.
DtRwAnimationModelString &	operator= (const DtRwString &orig)
	Assign to DtString. Assigns value only.
DtRwAnimationModelString &	operator= (const char *orig)
DtRwAnimationModelString &	operator= (const DtString &orig)
DtRwAnimationModelString &	operator= (const DtSymbolString &orig)
virtual	~DtRwAnimationModelString ()
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
Public Member Functions inherited from DtRwString
	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
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 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
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())
	Gets data from the environment value.
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	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	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 DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
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	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 const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
Static Public Member Functions inherited from DtRwString

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 Member Functions inherited from DtRwString
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.
Protected Attributes inherited from DtRwString
DtString	myUnsubstitutedString
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
static DtOutputStream *	theOutputStream

Detailed Description

Simple wrapper class that will be used by Lua to indicate to create an animated model.

Constructor & Destructor Documentation

DtRwAnimationModelString::DtRwAnimationModelString

(

)

default constructor

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

real constructor

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

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

real constructor from char *

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

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

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

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

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

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

copy constructor

virtual DtRwAnimationModelString::~DtRwAnimationModelString ( )

virtual

Member Function Documentation

static const char* DtRwAnimationModelString::theXmlType ( )

static

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

Reimplemented from DtRwString.

virtual const char* DtRwAnimationModelString::xmlType ( ) const

inlinevirtual

Reimplemented from DtRwString.

References DtRwString::theXmlType().

DtRwAnimationModelString& DtRwAnimationModelString::operator=

(

const DtRwAnimationModelString &

orig

)

Assign to DtRwAnimationModelString. Assigns value only.

DtRwAnimationModelString& DtRwAnimationModelString::operator=

(

const DtRwString &

orig

)

Assign to DtString. Assigns value only.

Reimplemented from DtRwString.

DtRwAnimationModelString& DtRwAnimationModelString::operator=

(

const char *

orig

)

Reimplemented from DtRwString.

DtRwAnimationModelString& DtRwAnimationModelString::operator=

(

const DtString &

orig

)

Reimplemented from DtRwString.

DtRwAnimationModelString& DtRwAnimationModelString::operator=

(

const DtSymbolString &

orig

)

Reimplemented from DtRwString.

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

---

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

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