This is a container of DtRemoteConfigurationMapEntry.

Inheritance diagram for DtRemoteConfigurationMapper:

Public Types
typedef DtRemoteConfigurationMapEntry (	CreatorFcn )()


typedef std::list< std::pair < DtObjectType, DtRemoteConfigurationMapEntry * > >	ObjTypeList

typedef ObjTypeList::iterator	ObjTypeIterator

typedef ObjTypeList::const_iterator	const_ObjTypeIterator


typedef std::map < DtEntityIdentifier, DtRemoteConfigurationMapEntry * >	EntIdMap

typedef EntIdMap::iterator	EntIdIterator

typedef EntIdMap::const_iterator	const_EntIdIterator


typedef std::map< std::string, DtRemoteConfigurationMapEntry * >	MarkingTextMap

typedef MarkingTextMap::iterator	MarkingTextIterator

typedef MarkingTextMap::const_iterator	const_MarkingTextIterator

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

	DtRemoteConfigurationMapper (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtRemoteConfigurationMapper (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

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

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

DtRemoteConfigurationMapper &	operator= (const DtRemoteConfigurationMapper &orig)

virtual	~DtRemoteConfigurationMapper ()

virtual bool	add (DtRemoteConfigurationMapEntry *pEntry)

virtual void	clear ()

virtual unsigned	count () const

virtual void	copyLists (const DtRemoteConfigurationMapper &orig)

DtRemoteConfigurationMapper::EntIdMap &	entityIdentifierMap ()

const DtRemoteConfigurationMapper::EntIdMap &	entityIdentifierMap () const

virtual DtRemoteConfigurationMapEntry *	find (const DtEntityIdentifier &id)

virtual const DtRemoteConfigurationMapEntry *	find (const DtEntityIdentifier &id) const

virtual DtRemoteConfigurationMapEntry *	find (const DtObjectType &objType)

virtual const DtRemoteConfigurationMapEntry *	find (const DtObjectType &objType) const

virtual DtRemoteConfigurationMapEntry *	find (const char *pMarkingText)

virtual const DtRemoteConfigurationMapEntry *	find (const char *pMarkingText) const

DtRemoteConfigurationMapper::ObjTypeList &	objectTypeList ()

const DtRemoteConfigurationMapper::ObjTypeList &	objectTypeList () const

DtRemoteConfigurationMapper::MarkingTextMap &	markingTextMap ()

const DtRemoteConfigurationMapper::MarkingTextMap &	markingTextMap () const

virtual bool	readFile (const DtFilename &fname, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	remove (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)


DtRemoteConfigurationMapper::CreatorFcn	creatorFcn () const

void	setCreatorFcn (DtRemoteConfigurationMapper::CreatorFcn fcn)

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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

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 void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

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	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	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
virtual bool	addByEntityId (DtRemoteConfigurationMapEntry *pEntry)

virtual bool	addByObjectType (DtRemoteConfigurationMapEntry *pEntry)

virtual bool	addByMarkingText (DtRemoteConfigurationMapEntry *pEntry)

virtual bool	addByOther (DtRemoteConfigurationMapEntry *pEntry)

virtual const DtRemoteConfigurationMapEntry *	findBestMatch (const DtObjectType &objtype) const

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

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

virtual void	removeByEntityId (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)

virtual void	removeByObjectType (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)

virtual void	removeByMarkingText (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)

virtual void	removeByOther (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)

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

Protected Attributes
EntIdMap	myEntityIdMap

CreatorFcn	myEntryCreatorFcn

ObjTypeList	myObjTypeList

MarkingTextMap	myMarkingTextMap

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

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

typedef std::list< std::pair<DtObjectType,DtRemoteConfigurationMapEntry*> > DtRemoteConfigurationMapper::ObjTypeList

Object Type list.

typedef ObjTypeList::iterator DtRemoteConfigurationMapper::ObjTypeIterator

Object Type list.

typedef ObjTypeList::const_iterator DtRemoteConfigurationMapper::const_ObjTypeIterator

Object Type list.

typedef std::map<DtEntityIdentifier,DtRemoteConfigurationMapEntry*> DtRemoteConfigurationMapper::EntIdMap

Entity Identifier list.

typedef EntIdMap::iterator DtRemoteConfigurationMapper::EntIdIterator

Entity Identifier list.

typedef EntIdMap::const_iterator DtRemoteConfigurationMapper::const_EntIdIterator

Entity Identifier list.

typedef std::map<std::string,DtRemoteConfigurationMapEntry*> DtRemoteConfigurationMapper::MarkingTextMap

Marking Text list.

typedef MarkingTextMap::iterator DtRemoteConfigurationMapper::MarkingTextIterator

Marking Text list.

typedef MarkingTextMap::const_iterator DtRemoteConfigurationMapper::const_MarkingTextIterator

Marking Text list.

typedef DtRemoteConfigurationMapEntry*(* DtRemoteConfigurationMapper::CreatorFcn)()

Factory function signature.

Constructor & Destructor Documentation

DtRemoteConfigurationMapper::DtRemoteConfigurationMapper ( )

CTOR.

DtRemoteConfigurationMapper::DtRemoteConfigurationMapper	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		bool	readonly = `false`
	)

CTOR.

DtRemoteConfigurationMapper::DtRemoteConfigurationMapper	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		bool	readonly = `false`
	)

CTOR.

DtRemoteConfigurationMapper::DtRemoteConfigurationMapper	(	const DtString &	name,
		const DtRemoteConfigurationMapper &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Copy constructor.

DtRemoteConfigurationMapper::DtRemoteConfigurationMapper	(	const DtSymbolString &	name,
		const DtRemoteConfigurationMapper &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Copy constructor.

virtual DtRemoteConfigurationMapper::~DtRemoteConfigurationMapper ( )

virtual

Destructor.

Member Function Documentation

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

Assignment operator.

virtual bool DtRemoteConfigurationMapper::add ( DtRemoteConfigurationMapEntry * pEntry )

virtual

Add an entry to the list. Adds the entry to the list, based upon it's "attach by" type. Returns true if added, false if not. Addition will replace and delete prior entries that have an exact match to the attachment criterion. If attach by type is not understood, the entry will not be added, and false will be returned. If false is returned, it is up to the caller to delete pEntry.

virtual void DtRemoteConfigurationMapper::clear ( )

virtual

empty the lists

virtual unsigned DtRemoteConfigurationMapper::count ( ) const

virtual

returns the total number of entries across the lists

virtual void DtRemoteConfigurationMapper::copyLists ( const DtRemoteConfigurationMapper & orig )

virtual

copy the lists

DtRemoteConfigurationMapper::EntIdMap & DtRemoteConfigurationMapper::entityIdentifierMap ( )

inline

Return entity identifier list.

References myEntityIdMap.

const DtRemoteConfigurationMapper::EntIdMap & DtRemoteConfigurationMapper::entityIdentifierMap ( ) const

inline

References myEntityIdMap.

virtual DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapper::find ( const DtEntityIdentifier & id )

virtual

Search for exact match by entity identifier, return NULL if not found.

virtual const DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapper::find ( const DtEntityIdentifier & id ) const

virtual

virtual DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapper::find ( const DtObjectType & objType )

virtual

search for closest match by object type, return null if not found

virtual const DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapper::find ( const DtObjectType & objType ) const

virtual

virtual DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapper::find ( const char * pMarkingText )

virtual

Search for exact match (case sensitive) to marking text, return NULL if not found.

virtual const DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapper::find ( const char * pMarkingText ) const

virtual

DtRemoteConfigurationMapper::ObjTypeList & DtRemoteConfigurationMapper::objectTypeList ( )

inline

Return object type list.

References myObjTypeList.

const DtRemoteConfigurationMapper::ObjTypeList & DtRemoteConfigurationMapper::objectTypeList ( ) const

inline

References myObjTypeList.

DtRemoteConfigurationMapper::MarkingTextMap & DtRemoteConfigurationMapper::markingTextMap ( )

inline

Return marking text list.

References myMarkingTextMap.

const DtRemoteConfigurationMapper::MarkingTextMap & DtRemoteConfigurationMapper::markingTextMap ( ) const

inline

References myMarkingTextMap.

virtual bool DtRemoteConfigurationMapper::readFile	(	const DtFilename &	fname,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

virtual

Loads the file.

virtual void DtRemoteConfigurationMapper::remove	(	DtRemoteConfigurationMapEntry *	pEntry,
		bool	bDelete = `true`
	)

virtual

Remove a node from the list (based on attach-by type), and optionally, delete the entry that was found. Given pEntry, search the lists for a node, based on pEntry->attachByType(). If that node is found, remove it. If bDelete is true, the DtRemoteConfigurationMapEntry* stored with the node will be deleted. If that pointer is the same as pEntry, pEntry will the point to invalid memory.

DtRemoteConfigurationMapper::CreatorFcn DtRemoteConfigurationMapper::creatorFcn ( ) const

inline

factory function to create entries

References myEntryCreatorFcn.

void DtRemoteConfigurationMapper::setCreatorFcn ( DtRemoteConfigurationMapper::CreatorFcn fcn )

inline

factory function to create entries

References myEntryCreatorFcn.

virtual bool DtRemoteConfigurationMapper::addByEntityId ( DtRemoteConfigurationMapEntry * pEntry )

protectedvirtual

Add an entry to myEntityIdMap.

virtual bool DtRemoteConfigurationMapper::addByObjectType ( DtRemoteConfigurationMapEntry * pEntry )

protectedvirtual

Add an entry to myObjTypeList.

virtual bool DtRemoteConfigurationMapper::addByMarkingText ( DtRemoteConfigurationMapEntry * pEntry )

protectedvirtual

Add an entry to MarkingTextMap.

virtual bool DtRemoteConfigurationMapper::addByOther ( DtRemoteConfigurationMapEntry * pEntry )

protectedvirtual

Add an entry to a custom list. Add the entry to a custom list. This requires derivation of DtRemoteConfigurationMapper, and an override of addByOther() to understand how to add the entry. The base class deletes pEntry if true.

virtual const DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapper::findBestMatch ( const DtObjectType & objtype ) const

protectedvirtual

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

protectedvirtual

Override getData to parse out attachment entries.

Reimplemented from DtReaderWriter.

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

protectedvirtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual void DtRemoteConfigurationMapper::removeByEntityId	(	DtRemoteConfigurationMapEntry *	pEntry,
		bool	bDelete = `true`
	)

protectedvirtual

Remove an entry from myEntityIdMap.

virtual void DtRemoteConfigurationMapper::removeByObjectType	(	DtRemoteConfigurationMapEntry *	pEntry,
		bool	bDelete = `true`
	)

protectedvirtual

Remove an entry from myObjTypeList.

virtual void DtRemoteConfigurationMapper::removeByMarkingText	(	DtRemoteConfigurationMapEntry *	pEntry,
		bool	bDelete = `true`
	)

protectedvirtual

Remove an entry from MarkingTextMap.

virtual void DtRemoteConfigurationMapper::removeByOther	(	DtRemoteConfigurationMapEntry *	pEntry,
		bool	bDelete = `true`
	)

protectedvirtual

Remove an entry from a custom list. Remove the entry to a custom list. This requires derivation of DtRemoteConfigurationMapper, and an override of removeByOther() to understand how to remove the entry. The base class does nothing.