This file declares DtComponentAttachmentConfigurationEntry.

Inheritance diagram for DtRemoteConfigurationList:

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


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

typedef ConfigMap::iterator	ConfigIterator

typedef ConfigMap::const_iterator	const_ConfigIterator

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

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

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

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

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

virtual	~DtRemoteConfigurationList () override

const DtRemoteConfigurationList &	operator= (const DtRemoteConfigurationList &orig)

const DtRemoteConfigurationList &	operator+= (const DtRemoteConfigurationList &orig)

virtual void	add (DtRemoteConfigurationEntry *pEntry)

virtual void	add (const DtRemoteConfigurationEntry &entry, bool replace=true)

virtual void	append (const DtRemoteConfigurationList &orig)

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

virtual void	clear ()

unsigned	size () const

virtual void	copyMap (const DtRemoteConfigurationList &orig)

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


DtRemoteConfigurationList::ConfigIterator	begin ()

DtRemoteConfigurationList::const_ConfigIterator	begin () const


DtRemoteConfigurationList::ConfigMap &	configurationMap ()

const DtRemoteConfigurationList::ConfigMap &	configurationMap () const


DtRemoteConfigurationEntry::CreatorFcn	entryCreatorFcn () const

void	setEntryCreatorFcn (DtRemoteConfigurationEntry::CreatorFcn fcn)


DtRemoteConfigurationList::ConfigIterator	end ()

DtRemoteConfigurationList::const_ConfigIterator	end () const


virtual void	remove (DtRemoteConfigurationEntry *pEntry)

virtual void	remove (const char *pKeyName)

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

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)

Static Public Member Functions
static DtRemoteConfigurationList *	create (const DtString &name, DtReaderWriterRegistry *parentRegistry)

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)

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

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

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

Protected Attributes
ConfigMap	myConfigMap

DtRemoteConfigurationEntry::CreatorFcn	myEntryCreatorFcn

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

overridevirtual

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.

virtual void DtRemoteConfigurationList::add	(	const DtRemoteConfigurationEntry &	entry,
		bool	replace = `true`
	)

virtual

Add an entry to the map. Adds the entry to the map. Makes a local copy of entry. Uses entry.keyName() to index. if (entry.keyName()) already exists and replace is true, remove that instance and delete, then add entry. If replace is false, keep the current entry.

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 DtReaderWriter::SearchPaths &	searchPaths,
		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 DtReaderWriter::SearchPaths &	searchPaths,
		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 DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

overrideprotectedvirtual

Override getData to parse out attachment entries.

Reimplemented from DtReaderWriter.

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

overrideprotectedvirtual

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/remoteConfigurationList.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation