DtRemoteConfigurationEntry Class Reference

This file declares DtRemoteConfigurationEntry. More...

Inheritance diagram for DtRemoteConfigurationEntry:

List of all members.

Public Types
typedef DtRemoteConfigurationEntry *(*	CreatorFcn )(const DtString &name, DtReaderWriterRegistry *parentRegistry)
typedef std::map< std::string, DtReaderWriter * >	SharedParameterPartsMap
typedef SharedParameterPartsMap::iterator	SharedPartsIterator
typedef SharedParameterPartsMap::const_iterator	const_SharedPartsIterator
Public Member Functions
	DtRemoteConfigurationEntry ()
	Default Constructor.
	DtRemoteConfigurationEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	Constructor.
	DtRemoteConfigurationEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	Constructor.
	DtRemoteConfigurationEntry (const DtRemoteConfigurationEntry &orig)
	Copy constructor.
	DtRemoteConfigurationEntry (const DtString &name, const DtRemoteConfigurationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
	DtRemoteConfigurationEntry (const DtSymbolString &name, const DtRemoteConfigurationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
virtual	~DtRemoteConfigurationEntry ()
	Destructor.
virtual DtRemoteConfigurationEntry *	clone () const
	Clone operator.
DtRemoteConfigurationEntry &	operator= (const DtRemoteConfigurationEntry &orig)
	Assignment operator.
virtual bool	addSharedParameterPart (DtReaderWriter *pParamPart)
	Add the reader writer object to mySharedParameterParts.
virtual void	clearSharedParameterParts ()
	Erases the shared parameter parts map.
virtual DtReaderWriter *	findSharedParameterPart (const char *pKeyName)
	looks up the parameter chunk by key name and returns it if found, otherwise returns NULL.
virtual void	setVariableBindings (const DtVariableBindingsSharedPtr &bindings)
virtual DtVariableBindingsSharedPtr	variableBindings ()
SharedParameterPartsMap &	sharedParameterParts ()
const SharedParameterPartsMap &	sharedParameterParts () const
const DtString &	componentConfigurationFilename () const
	Get/set component configuration filename.
void	setComponentConfigurationFilename (const DtString &fn)
	Get/set component configuration filename.
const DtString &	keyName () const
	Get/set key name, used to lookup named configuration.
void	setKeyName (const DtString &kname)
	Get/set key name, used to lookup named configuration.
Static Public Member Functions
static DtRemoteConfigurationEntry *	create (const DtString &name, DtReaderWriterRegistry *parentRegistry)
Protected Attributes
DtRwString	myConfigurationFilePath
	Filepath containing the configuration.
DtRwString	myKeyName
	The lookup name of the configuration.
SharedParameterPartsMap	mySharedParameterParts
	This is a lookup table for things like descriptor lists, keyed by reader writer name.
DtVariableBindingsSharedPtr	myVariableBindings
	These are used to resolve symbols in the configuration file.

---

Detailed Description

This file declares DtRemoteConfigurationEntry.

DtRemoteConfigurationEntry

---

Member Typedef Documentation

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

typedef std::map<std::string, DtReaderWriter*> DtRemoteConfigurationEntry::SharedParameterPartsMap

This map is used to store things like descriptor lists, which are shared among simulated objects that match this entry.

typedef SharedParameterPartsMap::iterator DtRemoteConfigurationEntry::SharedPartsIterator

This map is used to store things like descriptor lists, which are shared among simulated objects that match this entry.

typedef SharedParameterPartsMap::const_iterator DtRemoteConfigurationEntry::const_SharedPartsIterator

This map is used to store things like descriptor lists, which are shared among simulated objects that match this entry.

---

Constructor & Destructor Documentation

DtRemoteConfigurationEntry::DtRemoteConfigurationEntry

(

)

Default Constructor.

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

Constructor.

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

Constructor.

DtRemoteConfigurationEntry::DtRemoteConfigurationEntry

(

const DtRemoteConfigurationEntry &

orig

)

Copy constructor.

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

Copy constructor.

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

Copy constructor.

virtual DtRemoteConfigurationEntry::~DtRemoteConfigurationEntry

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual DtRemoteConfigurationEntry* DtRemoteConfigurationEntry::clone

(

)

const [virtual]

Clone operator.

DtRemoteConfigurationEntry& DtRemoteConfigurationEntry::operator=

(

const DtRemoteConfigurationEntry &

orig

)

Assignment operator.

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

virtual bool DtRemoteConfigurationEntry::addSharedParameterPart

(

DtReaderWriter *

pParamPart

)

[virtual]

Add the reader writer object to mySharedParameterParts.

Keyed by pParamPart->name(). If a duplicate is found, the original is retained, and false is returned. Returns true if the item was added. If the item is added, the remoteConfigurationMemory assumes responsibility for deleting it.

virtual void DtRemoteConfigurationEntry::clearSharedParameterParts

(

)

[virtual]

Erases the shared parameter parts map.

const DtString & DtRemoteConfigurationEntry::componentConfigurationFilename

(

)

const [inline]

Get/set component configuration filename.

References myConfigurationFilePath.

void DtRemoteConfigurationEntry::setComponentConfigurationFilename

(

const DtString &

fn

)

[inline]

Get/set component configuration filename.

References myConfigurationFilePath.

virtual DtReaderWriter* DtRemoteConfigurationEntry::findSharedParameterPart

(

const char *

pKeyName

)

[virtual]

looks up the parameter chunk by key name and returns it if found, otherwise returns NULL.

const DtString & DtRemoteConfigurationEntry::keyName

(

)

const [inline]

Get/set key name, used to lookup named configuration.

References myKeyName.

void DtRemoteConfigurationEntry::setKeyName

(

const DtString &

kname

)

[inline]

Get/set key name, used to lookup named configuration.

References myKeyName.

virtual void DtRemoteConfigurationEntry::setVariableBindings

(

const DtVariableBindingsSharedPtr &

bindings

)

[virtual]

virtual DtVariableBindingsSharedPtr DtRemoteConfigurationEntry::variableBindings

(

)

[virtual]

DtRemoteConfigurationEntry::SharedParameterPartsMap & DtRemoteConfigurationEntry::sharedParameterParts

(

)

[inline]

References mySharedParameterParts.

const DtRemoteConfigurationEntry::SharedParameterPartsMap & DtRemoteConfigurationEntry::sharedParameterParts

(

)

const [inline]

References mySharedParameterParts.

---

Member Data Documentation

DtRwString DtRemoteConfigurationEntry::myConfigurationFilePath [protected]

Filepath containing the configuration.

Referenced by componentConfigurationFilename(), and setComponentConfigurationFilename().

DtRwString DtRemoteConfigurationEntry::myKeyName [protected]

The lookup name of the configuration.

Referenced by keyName(), and setKeyName().

SharedParameterPartsMap DtRemoteConfigurationEntry::mySharedParameterParts [protected]

This is a lookup table for things like descriptor lists, keyed by reader writer name.

Referenced by sharedParameterParts().

DtVariableBindingsSharedPtr DtRemoteConfigurationEntry::myVariableBindings [protected]

These are used to resolve symbols in the configuration file.

The variable bindings come from DtMtlParameterDb, and are provided by DtMtlParameterDbReader

---

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

• include/vrfutil/remoteConfigurationEntry.h