DtRwStringAttributeList Class Reference

class DtRwStringAttributeList:

Instances of DtRwStringAttributeList are lists of DtRwStringAttributes.

Inheritance diagram for DtRwStringAttributeList:

Public Member Functions
	DtRwStringAttributeList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwStringAttributeList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwStringAttributeList (const DtRwStringAttributeList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtRwStringAttributeList &	operator= (const DtRwStringAttributeList &orig)
virtual	~DtRwStringAttributeList ()
virtual DtRwStringAttributeList *	clone (DtReaderWriterRegistry *parentRegistry=NULL)
virtual bool	operator== (const DtRwStringAttributeList &rhs) const
virtual void	emptyList ()
virtual void	copyList (const DtRwStringAttributeList &orig)
virtual DtString	value (const DtString &) const
virtual DtRwStringAttribute *	addStringAttribute (const DtRwStringAttribute &stringAttribute)
virtual const DtRwStringAttribute *	findStringAttribute (const DtRwStringAttribute &attribToFind) const
virtual void	removeStringAttribute (const DtString &key)
virtual void	renameKey (const DtString &oldKey, const DtString &newKey)
virtual std::map< DtString, DtString >	asStdMap () const
virtual void	setFromMap (const std::map< DtString, DtString > &)
virtual void	setFromMap (const std::map< std::string, std::string > &)
virtual const char *	xmlType () const
virtual DtString	toFormattedString () const
virtual void	setFromFormattedString (const DtString &)
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)
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)
	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) 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	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 &)
virtual DtString	prettyPrint () const
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	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 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 Member Functions
	DtRwStringAttributeList ()
virtual DtRwStringAttribute *	addStringAttribute (DtRwStringAttribute *const stringAttribute)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual const char *	readerWriterType () const
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)

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

DtRwStringAttributeList::DtRwStringAttributeList ( )

protected

default constructor

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

constructor

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

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

copy constructor

virtual DtRwStringAttributeList::~DtRwStringAttributeList ( )

virtual

destructor

Member Function Documentation

DtRwStringAttributeList& DtRwStringAttributeList::operator=

(

const DtRwStringAttributeList &

orig

)

Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.

virtual DtRwStringAttributeList* DtRwStringAttributeList::clone ( DtReaderWriterRegistry *  parentRegistry = NULL )

virtual

virtual bool DtRwStringAttributeList::operator== ( const DtRwStringAttributeList &  rhs ) const

virtual

Returns

True if both lists contain equivalent items.

Note

Order is disregarded.

virtual void DtRwStringAttributeList::emptyList ( )

virtual

Removes all object types from the list, and destroys them.

virtual void DtRwStringAttributeList::copyList ( const DtRwStringAttributeList &  orig )

virtual

virtual DtString DtRwStringAttributeList::value ( const DtString &  ) const

virtual

Given the key, return the value.

Referenced by DtModelSetEntry::iconForList().

virtual DtRwStringAttribute* DtRwStringAttributeList::addStringAttribute ( const DtRwStringAttribute &  stringAttribute )

virtual

Referenced by DtModelSetEntry::setIconForList().

virtual const DtRwStringAttribute* DtRwStringAttributeList::findStringAttribute ( const DtRwStringAttribute &  attribToFind ) const

virtual

Returns a pointer to an attribute on this list that is equal to the one passed in. If none are equal, NULL is returned.

virtual void DtRwStringAttributeList::removeStringAttribute ( const DtString &  key )

virtual

Referenced by DtModelSetEntry::setIconForList().

virtual void DtRwStringAttributeList::renameKey ( const DtString &  oldKey, const DtString &  newKey  )

virtual

Renames the old key to the new key.

virtual std::map<DtString, DtString> DtRwStringAttributeList::asStdMap ( ) const

virtual

Returns the contents of this attribute list as a std::map.

virtual void DtRwStringAttributeList::setFromMap ( const std::map< DtString, DtString > &  )

virtual

Referenced by DtScriptedTask::setValue().

virtual void DtRwStringAttributeList::setFromMap ( const std::map< std::string, std::string > &  )

virtual

static const char* DtRwStringAttributeList::theXmlType ( )

static

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

virtual const char* DtRwStringAttributeList::xmlType ( ) const

inlinevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwList.

References DtRwList::theXmlType().

virtual DtString DtRwStringAttributeList::toFormattedString ( ) const

virtual

Returns a string of the type <key>=;<key>=etc. if the key or a value has an = or ; this will not work, so, make sure not to have = or semi colons in your keys or values.

virtual void DtRwStringAttributeList::setFromFormattedString ( const DtString &  )

virtual

Clears out and set the list from the formatted string.

virtual DtRwStringAttribute* DtRwStringAttributeList::addStringAttribute ( DtRwStringAttribute *const  stringAttribute )

protectedvirtual

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

protectedvirtual

Constructs a DtRwStringAttribute item, retrieves it from the mtl stream, and then adds it to the list.

Implements DtRwList.

virtual const char* DtRwStringAttributeList::readerWriterType ( ) const

protectedvirtual

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.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/readerWriter/rwStringAttributeList.h