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 Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

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
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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 (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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 Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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 DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
EntIdMap	myEntityIdMap
CreatorFcn	myEntryCreatorFcn
ObjTypeList	myObjTypeList
MarkingTextMap	myMarkingTextMap
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()
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

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 )

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 DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)

protectedvirtual

Override getData to parse out attachment entries.

virtual void DtRemoteConfigurationMapper::putData	(	FILE *	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.