This file declares DtRemoteConfigurationEntry. More...

Inheritance diagram for DtRemoteConfigurationEntry:

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 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
	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.
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 DtRemoteConfigurationEntry *	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 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.
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
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 void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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 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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation