Script variables is a container of variables by script id that can be referenced in existing scripts. More...

Inheritance diagram for DtRwScriptVariablesList:

Public Member Functions
	DtRwScriptVariablesList (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtRwScriptVariablesList (const DtString &name, const DtRwScriptVariablesList &orig, DtReaderWriterRegistry *parentRegistry=0)

	DtRwScriptVariablesList (const DtRwScriptVariablesList &orig, DtReaderWriterRegistry *parentRegistry=0)

DtRwScriptVariablesList &	operator= (const DtRwScriptVariablesList &orig)

virtual	~DtRwScriptVariablesList ()

virtual const char *	xmlType () const

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual void	setVariable (const DtString &scriptId, DtPropertyInterface *variable)

virtual DtReaderWriter *	variable (const DtString &scriptId, const DtString &variableName)

virtual DtReaderWriter *	variable (const DtString &scriptId, const DtString &variableName) const

virtual DtRwProperties *	variablesFor (const DtString &) const

virtual DtRwScriptVariables *	scriptVariables (const DtString &scriptId) const

virtual void	setScriptVariables (const DtString &scriptId, const DtRwProperties &)

Public Member Functions inherited from DtRwTemplatedListPtr< DtRwScriptVariables, true >
	DtRwTemplatedListPtr ()
	default constructor More...

	DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor More...

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

	DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor. More...

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

	DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	... and make sure the default constructor is overridden: More...

DtRwTemplatedListPtr &	operator= (const DtRwTemplatedListPtr &orig)

virtual	~DtRwTemplatedListPtr ()

DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	This method must be overridden by a subclass. More...

virtual DtListItem *	add (DtRwScriptVariables *data)
	Define this function to hide the DtRwList version, and accept only the specific DtReaderWriter subclass that this list is handling. More...

void	removeAll ()
	Removes all entries from the list. More...

void *	remove (DtListItem *item)

void *	remove (DtRwScriptVariables *item)

virtual std::set< DtString >	supportedXmlTypes () const
	Returns list of supported types. Default is the templated object xml type. More...

void	removeAndDeleteAll ()
	Removes and deletes all entries in the list. More...

bool	operator== (const DtRwTemplatedListPtr &) const
	Equivalence operators. More...

bool	operator!= (const DtRwTemplatedListPtr &) const

virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

DtListItem *	find (boost::function< bool(const DtRwScriptVariables &)> predFcn) const
	Finds the first item in the list for which predFcn returns true. More...

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

void	copyList (const DtRwTemplatedListPtr &orig)

Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor More...

	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor More...

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

virtual	~DtRwList ()

const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied. More...

virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list. More...

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object. More...

virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list. More...

virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list. More...

virtual void *	remove (DtReaderWriter data, DtListItem item)
	Remove an element from the list. More...

virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)
	Add element to the list just before the indicated item. More...

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)
	Add element to the list just after the indicated item. More...

virtual void	reset ()
	Calls removeAndDeleteAll. More...

bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare. More...

bool	operator!= (const DtRwList &rhs) const

virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor. More...

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

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item. More...

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item. More...

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)

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

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

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

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

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

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

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

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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

bool	isReadonly () const

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

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

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

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

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

Static Public Member Functions inherited from DtRwTemplatedListPtr< DtRwScriptVariables, true >
static const char *	theXmlType ()

static const char *	ListReaderWriterType ()

Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

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 ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Private Member Functions
	DtRwScriptVariablesList ()
	Not implemented. More...

Additional Inherited Members
Public Types inherited from DtRwTemplatedListPtr< DtRwScriptVariables, true >
typedef DtIteratorBase < DtRwScriptVariables >	iterator

typedef DtIteratorBase< const DtRwScriptVariables >	const_iterator

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 DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)
	Add element to the list just before the indicated item. More...

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)
	Add element to the list just after the indicated item. More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes inherited from DtRwTemplatedListPtr< DtRwScriptVariables, true >
DtString	myXmlType

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

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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

Script variables is a container of variables by script id that can be referenced in existing scripts.

To retrieve a value, call the lua system:getAttribute function as follows: vrf:getScriptAttribute("Rain-Modifier-By-Intensity")

Constructor & Destructor Documentation

DtRwScriptVariablesList::DtRwScriptVariablesList ( )

private

Not implemented.

DtRwScriptVariablesList::DtRwScriptVariablesList	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtRwScriptVariablesList::DtRwScriptVariablesList	(	const DtString &	name,
		const DtRwScriptVariablesList &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtRwScriptVariablesList::DtRwScriptVariablesList	(	const DtRwScriptVariablesList &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtRwScriptVariablesList::~DtRwScriptVariablesList ( )

virtual

Member Function Documentation

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

static const char* DtRwScriptVariablesList::theXmlType ( )

static

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

virtual const char* DtRwScriptVariablesList::xmlType ( ) const

inlinevirtual

Reimplemented from DtRwTemplatedListPtr< DtRwScriptVariables, true >.

References DtRwTemplatedListPtr< T, T_autoDelete >::theXmlType().

virtual const char* DtRwScriptVariablesList::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 DtRwList.

virtual void DtRwScriptVariablesList::setVariable	(	const DtString &	scriptId,
		DtPropertyInterface *	variable
	)

virtual

virtual DtReaderWriter* DtRwScriptVariablesList::variable	(	const DtString &	scriptId,
		const DtString &	variableName
	)

virtual

virtual DtReaderWriter* DtRwScriptVariablesList::variable	(	const DtString &	scriptId,
		const DtString &	variableName
	)		const

virtual

virtual DtRwProperties* DtRwScriptVariablesList::variablesFor ( const DtString & ) const

virtual

virtual DtRwScriptVariables* DtRwScriptVariablesList::scriptVariables ( const DtString & scriptId ) const

virtual

virtual void DtRwScriptVariablesList::setScriptVariables	(	const DtString &	scriptId,
		const DtRwProperties &
	)

virtual

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfutil/rwScriptVariables.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation