This file declares DtComponentAttachmentConfigurationEntry. More...

Inheritance diagram for DtRemoteConfigurationList:

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

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

Static Public Member Functions
static DtRemoteConfigurationList *	create (const DtString &name, DtReaderWriterRegistry *parentRegistry)
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 DtReaderWriterFactory *	factory ()

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

Protected Attributes
ConfigMap	myConfigMap
DtRemoteConfigurationEntry::CreatorFcn	myEntryCreatorFcn
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 Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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
	)

protectedvirtual

Override getData to parse out attachment entries.

Reimplemented from DtReaderWriter.

virtual void DtRemoteConfigurationList::putData	(	FILE *	fp,
		int	indentLevel = `0`
	)

protectedvirtual

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation