Inheritance diagram for DtRemoteConfigurationMapper:

Public Types
typedef DtRemoteConfigurationMapEntry (	CreatorFcn )()
	Factory function signature.

typedef std::list< std::pair < DtObjectType, DtRemoteConfigurationMapEntry * > >	ObjTypeList
	Object Type list.
typedef ObjTypeList::iterator	ObjTypeIterator
	Object Type list.
typedef ObjTypeList::const_iterator	const_ObjTypeIterator
	Object Type list.

typedef std::map < DtEntityIdentifier, DtRemoteConfigurationMapEntry * >	EntIdMap
	Entity Identifier list.
typedef EntIdMap::iterator	EntIdIterator
	Entity Identifier list.
typedef EntIdMap::const_iterator	const_EntIdIterator
	Entity Identifier list.

typedef std::map< std::string, DtRemoteConfigurationMapEntry * >	MarkingTextMap
	Marking Text list.
typedef MarkingTextMap::iterator	MarkingTextIterator
	Marking Text list.
typedef MarkingTextMap::const_iterator	const_MarkingTextIterator
	Marking Text list.
Public Member Functions
	DtRemoteConfigurationMapper ()
	CTOR.
	DtRemoteConfigurationMapper (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	CTOR.
	DtRemoteConfigurationMapper (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	CTOR.
	DtRemoteConfigurationMapper (const DtString &name, const DtRemoteConfigurationMapper &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
	DtRemoteConfigurationMapper (const DtSymbolString &name, const DtRemoteConfigurationMapper &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
DtRemoteConfigurationMapper &	operator= (const DtRemoteConfigurationMapper &orig)
	Assignment operator.
virtual	~DtRemoteConfigurationMapper ()
	Destructor.
virtual bool	add (DtRemoteConfigurationMapEntry *pEntry)
	Add an entry to the list.
virtual void	clear ()
	empty the lists
virtual unsigned	count () const
	returns the total number of entries across the lists
virtual void	copyLists (const DtRemoteConfigurationMapper &orig)
	copy the lists
DtRemoteConfigurationMapper::EntIdMap &	entityIdentifierMap ()
	Return entity identifier list.
const DtRemoteConfigurationMapper::EntIdMap &	entityIdentifierMap () const
virtual DtRemoteConfigurationMapEntry *	find (const DtEntityIdentifier &id)
	Search for exact match by entity identifier, return NULL if not found.
virtual const DtRemoteConfigurationMapEntry *	find (const DtEntityIdentifier &id) const
virtual DtRemoteConfigurationMapEntry *	find (const DtObjectType &objType)
	search for closest match by object type, return null if not found
virtual const DtRemoteConfigurationMapEntry *	find (const DtObjectType &objType) const
virtual DtRemoteConfigurationMapEntry *	find (const char *pMarkingText)
	Search for exact match (case sensitive) to marking text, return NULL if not found.
virtual const DtRemoteConfigurationMapEntry *	find (const char *pMarkingText) const
DtRemoteConfigurationMapper::ObjTypeList &	objectTypeList ()
	Return object type list.
const DtRemoteConfigurationMapper::ObjTypeList &	objectTypeList () const
DtRemoteConfigurationMapper::MarkingTextMap &	markingTextMap ()
	Return marking text list.
const DtRemoteConfigurationMapper::MarkingTextMap &	markingTextMap () const
virtual bool	readFile (const DtFilename &fname, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Loads the file.
virtual void	remove (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)
	Remove a node from the list (based on attach-by type), and optionally, delete the entry that was found.

DtRemoteConfigurationMapper::CreatorFcn	creatorFcn () const
	factory function to create entries
void	setCreatorFcn (DtRemoteConfigurationMapper::CreatorFcn fcn)
	factory function to create entries
Protected Member Functions
virtual bool	addByEntityId (DtRemoteConfigurationMapEntry *pEntry)
	Add an entry to myEntityIdMap.
virtual bool	addByObjectType (DtRemoteConfigurationMapEntry *pEntry)
	Add an entry to myObjTypeList.
virtual bool	addByMarkingText (DtRemoteConfigurationMapEntry *pEntry)
	Add an entry to MarkingTextMap.
virtual bool	addByOther (DtRemoteConfigurationMapEntry *pEntry)
	Add an entry to a custom list.
virtual const DtRemoteConfigurationMapEntry *	findBestMatch (const DtObjectType &objtype) const
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Override getData to parse out attachment entries.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual void	removeByEntityId (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)
	Remove an entry from myEntityIdMap.
virtual void	removeByObjectType (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)
	Remove an entry from myObjTypeList.
virtual void	removeByMarkingText (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)
	Remove an entry from MarkingTextMap.
virtual void	removeByOther (DtRemoteConfigurationMapEntry *pEntry, bool bDelete=true)
	Remove an entry from a custom list.
Protected Attributes
EntIdMap	myEntityIdMap
CreatorFcn	myEntryCreatorFcn
ObjTypeList	myObjTypeList
MarkingTextMap	myMarkingTextMap

Detailed Description

DtRemoteConfigurationMapper.

This is a container of DtRemoteConfigurationMapEntry.

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 DtFilename &	searchPath,
		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 ) [protected, virtual]

Add an entry to myEntityIdMap.

virtual bool DtRemoteConfigurationMapper::addByObjectType ( DtRemoteConfigurationMapEntry * pEntry ) [protected, virtual]

Add an entry to myObjTypeList.

virtual bool DtRemoteConfigurationMapper::addByMarkingText ( DtRemoteConfigurationMapEntry * pEntry ) [protected, virtual]

Add an entry to MarkingTextMap.

virtual bool DtRemoteConfigurationMapper::addByOther ( DtRemoteConfigurationMapEntry * pEntry ) [protected, virtual]

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 [protected, virtual]

virtual DtlObjPtr DtRemoteConfigurationMapper::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		`[protected, virtual]`

Override getData to parse out attachment entries.

virtual void DtRemoteConfigurationMapper::putData	(	FILE *	fp,
		int	indentLevel = `0`
	)		`[protected, virtual]`

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

Reimplemented from DtReaderWriter.

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

Remove an entry from myEntityIdMap.

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

Remove an entry from myObjTypeList.

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

Remove an entry from MarkingTextMap.

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

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.