Inheritance diagram for DtRwTemplatedMapPtr< KeyType, ValType >:

Public Types
typedef DtRwTemplatedPair < KeyType, ValType >	RwPairType

typedef std::map< KeyType, ValType >::iterator	iterator

typedef std::map< KeyType, ValType >::const_iterator	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 )()

Public Member Functions
	DtRwTemplatedMapPtr ()
	default constructor More...

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

DtRwTemplatedMapPtr &	operator= (const DtRwTemplatedMapPtr &orig)
	Assignment operator. More...

virtual	~DtRwTemplatedMapPtr ()
	Destructor. More...

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

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

virtual void	prePutSelf ()
	Before putting self, update RwList to match our internal map. More...

virtual void	postGetSelf ()
	After getting self, update internal map to match our RwList. More...

virtual void	setFromMap (const std::map< KeyType, ValType > sourceMap)
	Clears the contents of this map, and sets new contents from the values in the std::map. More...

virtual void	swap (DtRwTemplatedMapPtr &other)
	Swaps the contents of this map with the other map. More...

virtual const std::map < KeyType, ValType > &	convertToMap () const
	The current contents of this map as a std::map. More...

virtual void	clear ()
	Clears all elements from the map. More...

virtual unsigned	size () const
	Returns the size of the map. More...

virtual const char *	xmlType () const

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


	DtRwTemplatedMapPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, const DtString &keyName="key", const DtString &valueName="value", const DtString &elementName="item")
	real constructors More...

	DtRwTemplatedMapPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, const DtString &keyName="key", const DtString &valueName="value", const DtString &elementName="item")


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

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


virtual iterator	begin ()
	Returns an iterator to the first element in the map. More...

virtual const_iterator	begin () const


virtual iterator	end ()
	Returns an iterator to the element following the last element in the map. More...

virtual const_iterator	end () const


std::pair< iterator, bool >	insert (const RwPairType &item)
	Insert a new item into the map. More...

std::pair< iterator, bool >	insert (const KeyType &key, const ValType &val)


void	erase (iterator pos)
	Removes an existing item from the map. More...

void	erase (const KeyType &key)


virtual iterator	find (const KeyType &key)
	Finds the element with the key equivalent to the key. More...

virtual const_iterator	find (const KeyType &key) const


virtual iterator	lower_bound (const KeyType &key)
	Finds the first element that is not less than the key. More...

virtual const_iterator	lower_bound (const KeyType &key) const


virtual iterator	upper_bound (const KeyType &key)
	Finds the first element that is greater than the key. More...

virtual const_iterator	upper_bound (const KeyType &key) const


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

bool	operator!= (const DtRwTemplatedMapPtr &) const


virtual const DtString &	keyName () const
	The RW name of the keys in this map. More...

virtual void	setKeyName (const DtString &keyName)


virtual const DtString &	elementName () const
	Accessor/mutator for myElementName. More...

virtual void	setElementName (const DtString &e)


virtual const DtString &	valueName () const
	The RW name of the values in this map. More...

virtual void	setValueName (const DtString &valName)

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	removeAll ()
	Removes all the items in the list. 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	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

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

virtual std::set< DtString >	supportedXmlTypes () const
	Returns the list of xml types supported by this list. Default is all. 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	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 ()

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

Protected Attributes
DtString	myXmlType

std::map< KeyType, ValType >	myMap

DtString	myElementName
	The name to write out for each element. More...

DtString	myKeyName

DtString	myValueName

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

Additional Inherited Members
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...

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

Member Typedef Documentation

template<typename KeyType, typename ValType>

typedef DtRwTemplatedPair<KeyType, ValType> DtRwTemplatedMapPtr< KeyType, ValType >::RwPairType

template<typename KeyType, typename ValType>

typedef std::map<KeyType, ValType>::iterator DtRwTemplatedMapPtr< KeyType, ValType >::iterator

template<typename KeyType, typename ValType>

typedef std::map<KeyType, ValType>::const_iterator DtRwTemplatedMapPtr< KeyType, ValType >::const_iterator

Constructor & Destructor Documentation

template<typename KeyType, typename ValType>

DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr ( )

default constructor

template<typename KeyType, typename ValType>

DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		const DtString &	keyName = `"key"`,
		const DtString &	valueName = `"value"`,
		const DtString &	elementName = `"item"`
	)

real constructors

template<typename KeyType, typename ValType>

DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		const DtString &	keyName = `"key"`,
		const DtString &	valueName = `"value"`,
		const DtString &	elementName = `"item"`
	)

template<typename KeyType, typename ValType>

DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr	(	const DtString &	name,
		const DtRwTemplatedMapPtr< KeyType, ValType > &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Invokes DtReaderWriter copy constructor.

Elements are copied using their standard copy constructor.

template<typename KeyType, typename ValType>

DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr	(	const DtSymbolString &	name,
		const DtRwTemplatedMapPtr< KeyType, ValType > &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

template<typename KeyType, typename ValType>

DtRwTemplatedMapPtr< KeyType, ValType >::DtRwTemplatedMapPtr	(	const DtRwTemplatedMapPtr< KeyType, ValType > &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

... and make sure the default constructor is overridden:

template<typename KeyType, typename ValType>

virtual DtRwTemplatedMapPtr< KeyType, ValType >::~DtRwTemplatedMapPtr ( )

virtual

Destructor.

Member Function Documentation

template<typename KeyType, typename ValType>

DtRwTemplatedMapPtr& DtRwTemplatedMapPtr< KeyType, ValType >::operator= ( const DtRwTemplatedMapPtr< KeyType, ValType > & orig )

Assignment operator.

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::removeAndDeleteAll ( )

virtual

Removes and deletes all entries in the rwlist.

Reimplemented from DtRwList.

template<typename KeyType, typename ValType>

DtlObjPtr DtRwTemplatedMapPtr< KeyType, ValType >::getData	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

virtual

This method must be overridden by a subclass.

Within this method, new instances of the DtReaderWriter subclass that is being handled by this list must be created, and then retrieved from the mtl stream, using the getSelf member of that item.

: Here is some sample code that could be used to implement a override of this class: (This is used in the DtRwIntegerList::getData() method)
* DtlObjPtr nameObj = DtcCar(args);

* DtRwInt* value = new DtRwInt(nameObj->pname());

* value->getSelf(args, searchPaths, variableBindings);

* this->add(value);

* return DtcCdr(DtcCdr(args));

*

Implements DtRwList.

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::prePutSelf ( )

virtual

Before putting self, update RwList to match our internal map.

Reimplemented from DtReaderWriter.

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::postGetSelf ( )

virtual

After getting self, update internal map to match our RwList.

Reimplemented from DtReaderWriter.

Reimplemented in DtArticulatedPartStateRepository::DtArtPartMap.

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::setFromMap ( const std::map< KeyType, ValType > sourceMap )

virtual

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

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::swap ( DtRwTemplatedMapPtr< KeyType, ValType > & other )

virtual

Swaps the contents of this map with the other map.

template<typename KeyType, typename ValType>

virtual const std::map<KeyType, ValType>& DtRwTemplatedMapPtr< KeyType, ValType >::convertToMap ( ) const

virtual

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

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::clear ( )

inlinevirtual

Clears all elements from the map.

template<typename KeyType, typename ValType>

virtual unsigned DtRwTemplatedMapPtr< KeyType, ValType >::size ( ) const

inlinevirtual

Returns the size of the map.

template<typename KeyType, typename ValType>

virtual iterator DtRwTemplatedMapPtr< KeyType, ValType >::begin ( )

inlinevirtual

Returns an iterator to the first element in the map.

template<typename KeyType, typename ValType>

virtual const_iterator DtRwTemplatedMapPtr< KeyType, ValType >::begin ( ) const

inlinevirtual

template<typename KeyType, typename ValType>

virtual iterator DtRwTemplatedMapPtr< KeyType, ValType >::end ( )

inlinevirtual

Returns an iterator to the element following the last element in the map.

template<typename KeyType, typename ValType>

virtual const_iterator DtRwTemplatedMapPtr< KeyType, ValType >::end ( ) const

inlinevirtual

template<typename KeyType, typename ValType>

std::pair<iterator, bool> DtRwTemplatedMapPtr< KeyType, ValType >::insert ( const RwPairType & item )

Insert a new item into the map.

template<typename KeyType, typename ValType>

std::pair<iterator, bool> DtRwTemplatedMapPtr< KeyType, ValType >::insert	(	const KeyType &	key,
		const ValType &	val
	)

template<typename KeyType, typename ValType>

void DtRwTemplatedMapPtr< KeyType, ValType >::erase ( iterator pos )

inline

Removes an existing item from the map.

template<typename KeyType, typename ValType>

void DtRwTemplatedMapPtr< KeyType, ValType >::erase ( const KeyType & key )

inline

template<typename KeyType, typename ValType>

virtual iterator DtRwTemplatedMapPtr< KeyType, ValType >::find ( const KeyType & key )

inlinevirtual

Finds the element with the key equivalent to the key.

template<typename KeyType, typename ValType>

virtual const_iterator DtRwTemplatedMapPtr< KeyType, ValType >::find ( const KeyType & key ) const

inlinevirtual

template<typename KeyType, typename ValType>

virtual iterator DtRwTemplatedMapPtr< KeyType, ValType >::lower_bound ( const KeyType & key )

inlinevirtual

Finds the first element that is not less than the key.

template<typename KeyType, typename ValType>

virtual const_iterator DtRwTemplatedMapPtr< KeyType, ValType >::lower_bound ( const KeyType & key ) const

inlinevirtual

template<typename KeyType, typename ValType>

virtual iterator DtRwTemplatedMapPtr< KeyType, ValType >::upper_bound ( const KeyType & key )

inlinevirtual

Finds the first element that is greater than the key.

template<typename KeyType, typename ValType>

virtual const_iterator DtRwTemplatedMapPtr< KeyType, ValType >::upper_bound ( const KeyType & key ) const

inlinevirtual

template<typename KeyType, typename ValType>

bool DtRwTemplatedMapPtr< KeyType, ValType >::operator== ( const DtRwTemplatedMapPtr< KeyType, ValType > & ) const

Equivalence operators.

template<typename KeyType, typename ValType>

bool DtRwTemplatedMapPtr< KeyType, ValType >::operator!= ( const DtRwTemplatedMapPtr< KeyType, ValType > & ) const

template<typename KeyType, typename ValType>

virtual const DtString& DtRwTemplatedMapPtr< KeyType, ValType >::keyName ( ) const

inlinevirtual

The RW name of the keys in this map.

Referenced by DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::setKeyName().

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::setKeyName ( const DtString & keyName )

inlinevirtual

template<typename KeyType, typename ValType>

virtual const DtString& DtRwTemplatedMapPtr< KeyType, ValType >::elementName ( ) const

inlinevirtual

Accessor/mutator for myElementName.

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::setElementName ( const DtString & e )

inlinevirtual

template<typename KeyType, typename ValType>

virtual const DtString& DtRwTemplatedMapPtr< KeyType, ValType >::valueName ( ) const

inlinevirtual

The RW name of the values in this map.

template<typename KeyType, typename ValType>

virtual void DtRwTemplatedMapPtr< KeyType, ValType >::setValueName ( const DtString & valName )

inlinevirtual

template<typename KeyType, typename ValType>

static const char* DtRwTemplatedMapPtr< KeyType, ValType >::theXmlType ( )

inlinestatic

Referenced by DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::xmlType().

template<typename KeyType, typename ValType>

virtual const char* DtRwTemplatedMapPtr< KeyType, ValType >::xmlType ( ) const

inlinevirtual

Reimplemented from DtRwList.

Referenced by DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::theXmlType().

template<typename KeyType, typename ValType>

virtual DtString DtRwTemplatedMapPtr< KeyType, ValType >::prettyPrint ( ) const

virtual

Routine to return a human readable form of the reader/writer variable.

Not all reader/writer classes implement this feature. Default is to return an empty string

Reimplemented from DtReaderWriter.

template<typename KeyType, typename ValType>

const char* DtRwTemplatedMapPtr< KeyType, ValType >::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.

template<typename KeyType, typename ValType>

static const char* DtRwTemplatedMapPtr< KeyType, ValType >::ListReaderWriterType ( )

static

Member Data Documentation

template<typename KeyType, typename ValType>

DtString DtRwTemplatedMapPtr< KeyType, ValType >::myXmlType

protected

template<typename KeyType, typename ValType>

std::map<KeyType, ValType> DtRwTemplatedMapPtr< KeyType, ValType >::myMap

protected

Referenced by DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::begin(), DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::clear(), DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::end(), DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::erase(), DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::find(), DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::lower_bound(), DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::size(), and DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::upper_bound().

template<typename KeyType, typename ValType>

DtString DtRwTemplatedMapPtr< KeyType, ValType >::myElementName

protected

The name to write out for each element.

By default this is "item" but, when reading this from a file, will be set to the first element name read

Referenced by DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::elementName(), and DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::setElementName().

template<typename KeyType, typename ValType>

DtString DtRwTemplatedMapPtr< KeyType, ValType >::myKeyName

protected

Referenced by DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::keyName(), and DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::setKeyName().

template<typename KeyType, typename ValType>

DtString DtRwTemplatedMapPtr< KeyType, ValType >::myValueName

protected

Referenced by DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::setValueName(), and DtRwTemplatedMapPtr< DtRwInt, DtRwReal >::valueName().

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfutil/rwTemplatedMap.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation