DtRemoteConfigurationEntry Class Reference

This file declares DtRemoteConfigurationEntry.

DtRemoteConfigurationEntry

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()

Public Member Functions
	DtRemoteConfigurationEntry ()
	DtRemoteConfigurationEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtRemoteConfigurationEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtRemoteConfigurationEntry (const DtRemoteConfigurationEntry &orig)
	DtRemoteConfigurationEntry (const DtString &name, const DtRemoteConfigurationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRemoteConfigurationEntry (const DtSymbolString &name, const DtRemoteConfigurationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRemoteConfigurationEntry ()
virtual DtRemoteConfigurationEntry *	clone () const
DtRemoteConfigurationEntry &	operator= (const DtRemoteConfigurationEntry &orig)
virtual bool	addSharedParameterPart (DtReaderWriter *pParamPart)
virtual void	clearSharedParameterParts ()
virtual DtReaderWriter *	findSharedParameterPart (const char *pKeyName)
virtual void	setVariableBindings (const DtVariableBindingsSharedPtr &bindings)
virtual DtVariableBindingsSharedPtr	variableBindings ()
SharedParameterPartsMap &	sharedParameterParts ()
const SharedParameterPartsMap &	sharedParameterParts () const
const DtString &	componentConfigurationFilename () const
void	setComponentConfigurationFilename (const DtString &fn)
const DtString &	keyName () const
void	setKeyName (const DtString &kname)
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)
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	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 DtRemoteConfigurationEntry *	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 Attributes
DtRwString	myConfigurationFilePath
DtRwString	myKeyName
SharedParameterPartsMap	mySharedParameterParts
DtVariableBindingsSharedPtr	myVariableBindings
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
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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 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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/remoteConfigurationEntry.h