DtRemoteConfigurationList Class Reference

This file declares DtComponentAttachmentConfigurationEntry. More...

Inheritance diagram for DtRemoteConfigurationList:

List of all members.

Public Types
typedef DtRemoteConfigurationList *(*	CreatorFcn )(const DtString &name, DtReaderWriterRegistry *parentRegistry)
typedef std::map< std::string, DtRemoteConfigurationEntry * >	ConfigMap
	Object Type list.
typedef ConfigMap::iterator	ConfigIterator
	Object Type list.
typedef ConfigMap::const_iterator	const_ConfigIterator
	Object Type list.
Public Member Functions
	DtRemoteConfigurationList ()
	CTOR.
	DtRemoteConfigurationList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	CTOR.
	DtRemoteConfigurationList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	CTOR.
	DtRemoteConfigurationList (const DtString &name, const DtRemoteConfigurationList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
	DtRemoteConfigurationList (const DtSymbolString &name, const DtRemoteConfigurationList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
virtual	~DtRemoteConfigurationList ()
	Destructor.
const DtRemoteConfigurationList &	operator= (const DtRemoteConfigurationList &orig)
	Assignment operator.
const DtRemoteConfigurationList &	operator+= (const DtRemoteConfigurationList &orig)
	operator+= has same behavior as append.
virtual void	add (DtRemoteConfigurationEntry *pEntry)
	Add an entry to the map.
virtual void	append (const DtRemoteConfigurationList &orig)
	append: add the contents of orig to this map. Duplicate keys will override originals.
virtual bool	appendFile (const DtFilename &fname, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	appendFile: add the contents the file to this map. Duplicate keys will override originals.
virtual void	clear ()
	empty the map
unsigned	size () const
	returns number of entries in the map
virtual void	copyMap (const DtRemoteConfigurationList &orig)
	copy the map
virtual bool	readFile (const DtFilename &fname, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Loads the file.
DtRemoteConfigurationList::ConfigIterator	begin ()
	Returns an iterator pointing to the first item in the map.
DtRemoteConfigurationList::const_ConfigIterator	begin () const
	Returns an iterator pointing to the first item in the map.
DtRemoteConfigurationList::ConfigMap &	configurationMap ()
	returns the map
const DtRemoteConfigurationList::ConfigMap &	configurationMap () const
	returns the map
DtRemoteConfigurationEntry::CreatorFcn	entryCreatorFcn () const
	factory function to create entries
void	setEntryCreatorFcn (DtRemoteConfigurationEntry::CreatorFcn fcn)
	factory function to create entries
DtRemoteConfigurationList::ConfigIterator	end ()
	Returns an iterator pointing to the first item in the map.
DtRemoteConfigurationList::const_ConfigIterator	end () const
	Returns an iterator pointing to the first item in the map.
virtual void	remove (DtRemoteConfigurationEntry *pEntry)
	Remove an entry from the map.
virtual void	remove (const char *pKeyName)
	Remove an entry from the map.
Static Public Member Functions
static DtRemoteConfigurationList *	create (const DtString &name, DtReaderWriterRegistry *parentRegistry)
Protected Member Functions
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.
Protected Attributes
ConfigMap	myConfigMap
DtRemoteConfigurationEntry::CreatorFcn	myEntryCreatorFcn

---

Detailed Description

This file declares DtComponentAttachmentConfigurationEntry.

DtRemoteConfigurationList

---

Member Typedef Documentation

typedef DtRemoteConfigurationList*(* DtRemoteConfigurationList::CreatorFcn)(const DtString &name, DtReaderWriterRegistry *parentRegistry)

typedef std::map< std::string, DtRemoteConfigurationEntry* > DtRemoteConfigurationList::ConfigMap

Object Type list.

typedef ConfigMap::iterator DtRemoteConfigurationList::ConfigIterator

Object Type list.

typedef ConfigMap::const_iterator DtRemoteConfigurationList::const_ConfigIterator

Object Type list.

---

Constructor & Destructor Documentation

DtRemoteConfigurationList::DtRemoteConfigurationList

(

)

CTOR.

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

CTOR.

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

CTOR.

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

Copy constructor.

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

Copy constructor.

virtual DtRemoteConfigurationList::~DtRemoteConfigurationList

(

)

[virtual]

Destructor.

---

Member Function Documentation

const DtRemoteConfigurationList& DtRemoteConfigurationList::operator=

(

const DtRemoteConfigurationList &

orig

)

Assignment operator.

const DtRemoteConfigurationList& DtRemoteConfigurationList::operator+=

(

const DtRemoteConfigurationList &

orig

)

operator+= has same behavior as append.

virtual void DtRemoteConfigurationList::add

(

DtRemoteConfigurationEntry *

pEntry

)

[virtual]

Add an entry to the map.

Adds the entry to the map. Assumes ownership of pEntry memory. Uses pEntry->keyName() to index. if (pEntry->keyName()) already exists, remove that instance and delete, then add pEntry.

DtRemoteConfigurationList::ConfigIterator DtRemoteConfigurationList::begin

(

)

[inline]

Returns an iterator pointing to the first item in the map.

References myConfigMap.

DtRemoteConfigurationList::const_ConfigIterator DtRemoteConfigurationList::begin

(

)

const [inline]

Returns an iterator pointing to the first item in the map.

References myConfigMap.

virtual void DtRemoteConfigurationList::append

(

const DtRemoteConfigurationList &

orig

)

[virtual]

append: add the contents of orig to this map. Duplicate keys will override originals.

virtual bool DtRemoteConfigurationList::appendFile	(	const DtFilename &	fname,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

appendFile: add the contents the file to this map. Duplicate keys will override originals.

virtual void DtRemoteConfigurationList::clear

(

)

[virtual]

empty the map

DtRemoteConfigurationList::ConfigMap & DtRemoteConfigurationList::configurationMap

(

)

[inline]

returns the map

References myConfigMap.

const DtRemoteConfigurationList::ConfigMap & DtRemoteConfigurationList::configurationMap

(

)

const [inline]

returns the map

References myConfigMap.

unsigned DtRemoteConfigurationList::size

(

)

const [inline]

returns number of entries in the map

References myConfigMap.

virtual void DtRemoteConfigurationList::copyMap

(

const DtRemoteConfigurationList &

orig

)

[virtual]

copy the map

DtRemoteConfigurationEntry::CreatorFcn DtRemoteConfigurationList::entryCreatorFcn

(

)

const [inline]

factory function to create entries

References myEntryCreatorFcn.

void DtRemoteConfigurationList::setEntryCreatorFcn

(

DtRemoteConfigurationEntry::CreatorFcn

fcn

)

[inline]

factory function to create entries

References myEntryCreatorFcn.

DtRemoteConfigurationList::ConfigIterator DtRemoteConfigurationList::end

(

)

[inline]

Returns an iterator pointing to the first item in the map.

References myConfigMap.

DtRemoteConfigurationList::const_ConfigIterator DtRemoteConfigurationList::end

(

)

const [inline]

Returns an iterator pointing to the first item in the map.

References myConfigMap.

virtual bool DtRemoteConfigurationList::readFile	(	const DtFilename &	fname,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

Loads the file.

virtual void DtRemoteConfigurationList::remove

(

DtRemoteConfigurationEntry *

pEntry

)

[virtual]

Remove an entry from the map.

virtual void DtRemoteConfigurationList::remove

(

const char *

pKeyName

)

[virtual]

Remove an entry from the map.

static DtRemoteConfigurationList* DtRemoteConfigurationList::create	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

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

Override getData to parse out attachment entries.

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

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

Reimplemented from DtReaderWriter.

---

Member Data Documentation

ConfigMap DtRemoteConfigurationList::myConfigMap [protected]

Referenced by begin(), configurationMap(), end(), and size().

DtRemoteConfigurationEntry::CreatorFcn DtRemoteConfigurationList::myEntryCreatorFcn [protected]

Referenced by entryCreatorFcn(), and setEntryCreatorFcn().

---

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

• include/vrfutil/remoteConfigurationList.h