Class which holds a list of string key and string value pairs. This class is a DtReaderWriter, and also has associated DtBufferSerialize methods available.

Inheritance diagram for DtRwKeyValueList:

[legend]

Public Member Functions
	DtRwKeyValueList ()

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

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

virtual	~DtRwKeyValueList ()

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

DtRwKeyValueList &	operator= (const DtRwKeyValueList &orig)

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

virtual void	remove (const DtString &key)

virtual void	clear ()

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)

virtual const char *	xmlType () const

virtual const char *	readerWriterType () const

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

Public Member Functions inherited from DtRwStringList
	DtRwStringList ()

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

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

virtual	~DtRwStringList ()

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

	DtRwStringList (const DtRwStringList &orig, DtReaderWriterRegistry *const parentRegistry=NULL)

DtRwStringList &	operator= (const DtRwStringList &orig)

virtual void	emptyList ()

virtual DtRwString *	add (const DtString &)

virtual DtRwString *	add (DtRwString *)

virtual DtRwString *	removeInternal (const DtString &s)

virtual void	removeAndDelete (const DtString &s)

virtual DtString	prettyPrint () const

Public Member Functions inherited from DtRwList
	DtRwList ()

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

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

virtual	~DtRwList ()

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	add (DtReaderWriter *data)

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual void *	remove (DtReaderWriter data, DtListItem item)

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

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)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAll ()

virtual void	removeAndDeleteAll ()

virtual void	reset ()

bool	operator== (const DtRwList &rhs) const

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)

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

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

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

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

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

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)

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	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 int	alignment () 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	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

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

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	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static const char *	theXmlType ()

Static Public Member Functions inherited from DtRwStringList
static const char *	theXmlType ()

Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()

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)

Protected Attributes
bool	myIsUserEditable

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

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
virtual DtListItem *	getListItem (const DtString &s) const

void	emptyListInternal ()

void	copyList (const DtRwStringList &orig)

Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

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

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

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.

Reimplemented from DtRwStringList.

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.

virtual const char* DtRwKeyValueList::xmlType ( ) const

inlinevirtual

Routines to archive/dearchive from an XML Environment.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/rwKeyValueList.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation