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.

Inheritance diagram for DtRwKeywordValuePairsReader:

[legend]

Public Member Functions
	DtRwKeywordValuePairsReader (const DtString &name="DtRwKeywordValuePairsReader")

	DtRwKeywordValuePairsReader (const DtRwKeywordValuePairsReader &orig)

const DtRwKeywordValuePairsReader &	operator= (const DtRwKeywordValuePairsReader &orig)

virtual	~DtRwKeywordValuePairsReader () override

virtual const char *	readerWriterType ()

virtual const char *	xmlType () const override

virtual DtString	parameterNameFor (const DtString &) const

virtual bool	hasMappingFor (const DtString &) const

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

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

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

virtual void	remove (const DtString &)

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

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

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

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

Public Member Functions inherited from DtRwTemplatedListPtr< DtRwKeyValueList, true >
	DtRwTemplatedListPtr ()

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

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

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

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

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

virtual DtRwTemplatedListPtr &	operator= (const DtRwTemplatedListPtr &orig)

virtual	~DtRwTemplatedListPtr () override

virtual DtReaderWriter *	createPrototype (const char *name="") const override

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

virtual DtListItem *	insertItemAt (DtRwKeyValueList *data, int index)

virtual DtListItem *	add (DtReaderWriter *item) override

virtual DtListItem *	add (DtRwKeyValueList *data)

virtual void	removeAll () override

void *	remove (DtListItem *item)

void *	remove (DtRwKeyValueList *item)

virtual std::set< DtString >	supportedXmlTypes () const override

virtual void	removeAndDeleteAll () override

virtual bool	operator== (const DtRwTemplatedListPtr &) const

bool	operator!= (const DtRwTemplatedListPtr &) const

virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings) override

DtListItem *	find (boost::function< bool(const DtRwKeyValueList &)> predFcn) const

virtual DtString	prettyPrint () const override

virtual const char *	readerWriterType () const override

void	copyList (const DtRwTemplatedListPtr &orig)

Public Member Functions inherited from DtRwList
	DtRwList ()

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

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

virtual	~DtRwList () override

const DtRwList &	operator= (const DtRwList &orig)

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()) override

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	reset () override

bool	operator== (const DtRwList &rhs) const

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)

	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 override

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

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 DtRwTemplatedListPtr< DtRwKeyValueList, true >
static const char *	theXmlType ()

static const char *	ListReaderWriterType ()

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)

Additional Inherited Members
Public Types inherited from DtRwTemplatedListPtr< DtRwKeyValueList, true >
typedef DtIteratorBase < DtRwKeyValueList >	iterator

typedef DtIteratorBase< const DtRwKeyValueList >	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 )()

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)

Protected Attributes inherited from DtRwTemplatedListPtr< DtRwKeyValueList, true >
DtString	myXmlType

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

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

default constructor

DtRwKeywordValuePairsReader::DtRwKeywordValuePairsReader ( const DtRwKeywordValuePairsReader & orig )

copy constructor

virtual DtRwKeywordValuePairsReader::~DtRwKeywordValuePairsReader ( )

overridevirtual

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.

virtual const char* DtRwKeywordValuePairsReader::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwTemplatedListPtr< DtRwKeyValueList, true >.

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

virtual DtString DtRwKeywordValuePairsReader::parameterNameFor ( const DtString & ) const

virtual

This could be a sub-item for a current mapping pair, so, if it is, return the parent item name.

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

overridevirtual

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/rwKeywordValuePairsReader.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation