This file reader will read a specically formatted file that has multiple keyword/value pairs by reader/writer name. More...

Inheritance diagram for DtRwKeywordValuePairsReader:

[legend]

Public Member Functions
	DtRwKeywordValuePairsReader (const DtString &name="DtRwKeywordValuePairsReader")
	default constructor
	DtRwKeywordValuePairsReader (const DtRwKeywordValuePairsReader &orig)
	copy constructor
const DtRwKeywordValuePairsReader &	operator= (const DtRwKeywordValuePairsReader &orig)
	assignment operator
virtual	~DtRwKeywordValuePairsReader ()
virtual const char *	readerWriterType ()
virtual const char *	xmlType () const
virtual bool	hasMappingFor (const DtString &) const
	Returns true if the reader/writer name is present.
virtual std::map< DtString, DtString >	asStdMap (const DtString &) const
	Returns a std::map for DtStrings.
virtual bool	isUserEditable (const DtString &) const
	Returns true if the reader/writer is user editable.
virtual void	setValuesFor (const DtString &rw, const std::map< DtString, DtString > &)
	Sets the map for the given reader/writer item. adds new if needed.
virtual void	setValuesFor (const DtString &rw, const DtRwKeyValueList &)
virtual void	remove (const DtString &)
	Removes the key/value pairs for the given reader/writer.
virtual void	getData (const DtEnvironmentSP env, const DtEnvValueSP envObject, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
	Override to replace newly read items into the list if they already exist.
virtual std::set< DtString >	readerWriterItems () const
	Returns a list of the current reader/writer items.
virtual void	rename (const DtString &from, const DtString &to)
	Renames from existing name to a new name for the reader/writer item.
virtual DtString	displayNameForKeyword (const DtString &rwName, const DtString &keyword) const
	Returns the display name for the reader/writer name and keyword pair.
Public Member Functions inherited from DtRwTemplatedListPtr< DtRwKeyValueList, true >
	DtRwTemplatedListPtr ()
	default constructor
	DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	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:
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.
virtual DtListItem *	add (DtRwKeyValueList *data)
	Define this function to hide the DtRwList version, and accept only the specific DtReaderWriter subclass that this list is handling.
void	removeAll ()
	Removes all entries from the list.
void *	remove (DtListItem *item)
void *	remove (DtRwKeyValueList *item)
virtual std::set< DtString >	supportedXmlTypes () const
	Returns list of supported types. Default is the templated object xml type.
void	removeAndDeleteAll ()
	Removes and deletes all entries in the list.
bool	operator== (const DtRwTemplatedListPtr &) const
	Equivalence operators.
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 DtRwKeyValueList &)> predFcn) const
	Finds the first item in the list for which predFcn returns true.
const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
void	copyList (const DtRwTemplatedListPtr &orig)
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	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	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.
	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
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 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 &)
	Restires 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.
Static Public Member Functions inherited from DtRwTemplatedListPtr< DtRwKeyValueList, true >
static const char *	ListReaderWriterType ()
Static Public Member Functions inherited from DtRwList

Additional Inherited Members
Public Types inherited from DtRwTemplatedListPtr< DtRwKeyValueList, true >
typedef DtIteratorBase < DtRwKeyValueList >	iterator
typedef DtIteratorBase< const DtRwKeyValueList >	const_iterator
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)
	Add element to the list just after the indicated item.
Protected Attributes inherited from DtRwTemplatedListPtr< DtRwKeyValueList, true >
DtString	myXmlType
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

This file reader will read a specically formatted file that has multiple keyword/value pairs by reader/writer name.

So, for example, Pacing-Tracking will contains multiple keyword/value pairs that are valid for Pacing-Tracking. This is a reader/writer item to allow it to automatically read/write itself from an xml file

Constructor & Destructor Documentation

DtRwKeywordValuePairsReader::DtRwKeywordValuePairsReader ( const DtString & name = "DtRwKeywordValuePairsReader" )

default constructor

DtRwKeywordValuePairsReader::DtRwKeywordValuePairsReader ( const DtRwKeywordValuePairsReader & orig )

copy constructor

virtual DtRwKeywordValuePairsReader::~DtRwKeywordValuePairsReader ( )

virtual

Member Function Documentation

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

assignment operator

virtual const char* DtRwKeywordValuePairsReader::readerWriterType ( )

virtual

static const char* DtRwKeywordValuePairsReader::theXmlType ( )

static

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

Reimplemented from DtRwTemplatedListPtr< DtRwKeyValueList, true >.

virtual const char* DtRwKeywordValuePairsReader::xmlType ( ) const

inlinevirtual

Reimplemented from DtRwTemplatedListPtr< DtRwKeyValueList, true >.

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

virtual bool DtRwKeywordValuePairsReader::hasMappingFor ( const DtString & ) const

virtual

Returns true if the reader/writer name is present.

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

virtual

Returns a std::map for DtStrings.

virtual bool DtRwKeywordValuePairsReader::isUserEditable ( const DtString & ) const

virtual

Returns true if the reader/writer is user editable.

virtual void DtRwKeywordValuePairsReader::setValuesFor	(	const DtString &	rw,
		const std::map< DtString, DtString > &
	)

virtual

Sets the map for the given reader/writer item. adds new if needed.

virtual void DtRwKeywordValuePairsReader::setValuesFor	(	const DtString &	rw,
		const DtRwKeyValueList &
	)

virtual

virtual void DtRwKeywordValuePairsReader::remove ( const DtString & )

virtual

Removes the key/value pairs for the given reader/writer.

virtual void DtRwKeywordValuePairsReader::getData	(	const DtEnvironmentSP	env,
		const DtEnvValueSP	envObject,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	bindings
	)

virtual

Override to replace newly read items into the list if they already exist.

Reimplemented from DtRwList.

virtual std::set<DtString> DtRwKeywordValuePairsReader::readerWriterItems ( ) const

virtual

Returns a list of the current reader/writer items.

These items will contain keyword/value pairs that are mapped to those names (e.g. Pacing-Tracking)

virtual void DtRwKeywordValuePairsReader::rename	(	const DtString &	from,
		const DtString &	to
	)

virtual

Renames from existing name to a new name for the reader/writer item.

virtual DtString DtRwKeywordValuePairsReader::displayNameForKeyword	(	const DtString &	rwName,
		const DtString &	keyword
	)		const

virtual

Returns the display name for the reader/writer name and keyword pair.

Empty string if does not exist. Note that this is the raw string, not a potentiall translated string. If you wish to translate the string, do the following: DtString module = DtReplaceAllSubstrings(rwName, "-", "_"); QString title = QCoreApplication::translate(module.c_str(), keyword.c_str(), 0);

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation