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

Inheritance diagram for DtRwString:

[legend]

Public Member Functions
	DtRwString ()

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

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

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

	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)

DtRwString &	operator= (const DtRwString &orig)

virtual DtRwString &	operator= (const char *orig) override

virtual DtRwString &	operator= (const DtString &orig) override

DtRwString &	operator= (const DtSymbolString &orig)

virtual	~DtRwString () override

virtual void	putData (std::string &fp, int indentLevel=0) override

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

virtual const char *	readerWriterType () const override

virtual DtString	unsubstitutedString () const

virtual void	setUnsubstitutedString (const DtString &)

virtual bool	containsVariableSubstitutions () const

virtual DtString	prettyPrint () const override

virtual int	alignment () const override

virtual void	reset () override

bool	operator== (const DtRwString &) const

bool	operator== (const DtString &) const

bool	operator!= (const DtString &rhs) const

bool	operator!= (const DtRwString &rhs) const

virtual bool	operator== (const char *) const override

virtual bool	operator!= (const char *rhs) const override

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

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

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

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

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings) override

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

bool	myInvalid

bool	myChangedFlag

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const override

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

virtual const char *	xmlType () const override

static const char *	theXmlType ()

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 char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

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

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

overridevirtual

Member Function Documentation

DtRwString& DtRwString::operator= ( const DtRwString & orig )

Assign to DtString. Assigns value only.

virtual DtRwString& DtRwString::operator= ( const char * orig )

overridevirtual

Reimplemented in DtRwAnimationModelString.

virtual DtRwString& DtRwString::operator= ( const DtString & orig )

overridevirtual

Reimplemented in DtRwAnimationModelString, and DtRwVrfObjectName.

DtRwString& DtRwString::operator= ( const DtSymbolString & orig )

virtual void DtRwString::putData	(	std::string &	fp,
		int	indentLevel = `0`
	)

overridevirtual

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
	)

overridevirtual

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

Reimplemented from DtReaderWriter.

Reimplemented in DtRwProperty< DtRwString >, and DtRwVrfObjectName.

virtual const char* DtRwString::readerWriterType ( ) const

overridevirtual

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 DtRwPropertySizedString, and 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.

Referenced by DtSimulationModelSet::setAmmunitionParametersFile(), DtSimulationModelSet::setDetonationParametersFile(), DtSimulationModelSet::setdetonationTerrainDeformParametersFile(), and DtSimulationModelSet::setEnumerationsFile().

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

overridevirtual

Routine to return a human readable form of this variable.

Reimplemented from DtReaderWriter.

virtual int DtRwString::alignment ( ) const

overridevirtual

Return HLA network alignment. sizeof(char)

Reimplemented from DtReaderWriter.

virtual void DtRwString::reset ( )

overridevirtual

Resets value to initial clear state.

Reimplemented from DtReaderWriter.

Reimplemented in DtRwProperty< DtRwString >.

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

overridevirtual

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

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

static const char* DtRwString::theXmlType ( )

static

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

Referenced by DtRwAnimationModelString::xmlType(), and DtRwPropertySizedString::xmlType().

virtual const char* DtRwString::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

Reimplemented in DtRwPropertySizedString, and 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

virtual bool DtRwString::operator== ( const char * ) const

overridevirtual

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

inlineoverridevirtual

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

overrideprotectedvirtual

Checks to see if this RW object is a variable reference that can be bound using the provided bindings. If so, it binds it. Does not check any children objects of this object.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtString DtRwString::myUnsubstitutedString

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/readerWriter/rwString.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation