Class which holds a list of string key and string value pairs. More...

Inheritance diagram for DtRwKeyValueList:

Public Member Functions
	DtRwKeyValueList ()
	default constructor
	DtRwKeyValueList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	constructor
	DtRwKeyValueList (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtRwKeyValueList ()
	destructor
	DtRwKeyValueList (const DtRwKeyValueList &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtRwKeyValueList &	operator= (const DtRwKeyValueList &orig)
	assignment operator
virtual void	add (const DtString &key, const DtString &value)
	Adds a key value pair to the list.
virtual void	remove (const DtString &key)
	Removes a key value pair from the list, based on the provided key.
virtual void	clear ()
	Clears the entire list. Same as emptyList()
virtual bool	contains (const DtString &key) const
virtual DtString	find (const DtString &key) const
virtual std::map< DtString, DtString >	convertToMap () const
virtual void	setFromMap (const std::map< DtString, DtString > sourceMap)
	Clears the contents of this list, and sets new contents from the values in the std::map.
virtual const char *	xmlType () const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
virtual bool	isUserEditable () const
	Returns whether a user can add custom items to this list through the GUI.
Public Member Functions inherited from DtRwStringList
	DtRwStringList ()
	default constructor
	DtRwStringList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	constructor
	DtRwStringList (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtRwStringList ()
	destructor
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Constructs a DtRwString item, and then retrieves it from the stream.
	DtRwStringList (const DtRwStringList &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtRwStringList &	operator= (const DtRwStringList &orig)
	assignment operator
virtual void	emptyList ()
virtual DtRwString *	add (const DtString &)
	Adds a new entry and returns the new string.
virtual DtRwString *	add (DtRwString *)
	Adds new string and returns the pointer passed in.
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	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.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
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.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter data, DtListItem item)
	Remove an element from the list.
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.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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.
virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual void	removeAndDeleteAll ()
	Removes and deletes all items in the list.
virtual void	reset ()
	Calls removeAndDeleteAll.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
bool	operator!= (const DtRwList &rhs) const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	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.
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.
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())
virtual std::set< DtString >	supportedXmlTypes () const
	Returns the list of xml types supported by this list. Default is all.
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 int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
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 &)
	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	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.

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

Protected Attributes
bool	myIsUserEditable
	Attribute which indicates that a user can add their own items to this list.

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 DtRwStringList
void	emptyListInternal ()
	Non-virtual because used by constructor/destructor.
void	copyList (const DtRwStringList &orig)
	Non-virtual because used by constructor/destructor.
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

Class which holds a list of string key and string value pairs.

This class is a DtReaderWriter, and also has associated DtBufferSerialize methods available.

Constructor & Destructor Documentation

DtRwKeyValueList::DtRwKeyValueList ( )

default constructor

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

constructor

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

virtual DtRwKeyValueList::~DtRwKeyValueList ( )

virtual

destructor

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

copy constructor

Member Function Documentation

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

assignment operator

virtual void DtRwKeyValueList::add	(	const DtString &	key,
		const DtString &	value
	)

virtual

Adds a key value pair to the list.

If a previous value with this key exists, it is removed.

virtual void DtRwKeyValueList::remove ( const DtString & key )

virtual

Removes a key value pair from the list, based on the provided key.

virtual void DtRwKeyValueList::clear ( )

virtual

Clears the entire list. Same as emptyList()

virtual bool DtRwKeyValueList::contains ( const DtString & key ) const

virtual

Returns: True if this key exists in the list.

virtual DtString DtRwKeyValueList::find ( const DtString & key ) const

virtual

Returns: The value associated with this key in the list. If this key doesn't exists, a null string is returned.

virtual std::map<DtString, DtString> DtRwKeyValueList::convertToMap ( ) const

virtual

Returns: The current contents of this list as a std::map.

Note: This is returned by value, so all data is copied, and may incur processing overhead.

virtual void DtRwKeyValueList::setFromMap ( const std::map< DtString, DtString > sourceMap )

virtual

Clears the contents of this list, and sets new contents from the values in the std::map.

All values are copied from the map.

static const char* DtRwKeyValueList::theXmlType ( )

static

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

Reimplemented from DtRwStringList.

virtual const char* DtRwKeyValueList::xmlType ( ) const

inlinevirtual

Reimplemented from DtRwStringList.

References DtRwStringList::theXmlType().

virtual const char* DtRwKeyValueList::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 DtRwStringList.

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

virtual

Reimplemented from DtRwList.

virtual bool DtRwKeyValueList::isUserEditable ( ) const

virtual

Returns whether a user can add custom items to this list through the GUI.

Member Data Documentation

bool DtRwKeyValueList::myIsUserEditable

protected

Attribute which indicates that a user can add their own items to this list.

This attribute is only used in particular circumstances when the key value list is used to populate certain GUI widgets.

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation