DtRemoteConfigurationList Class Reference

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
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 ()
	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 DtReaderWriter::SearchPaths &searchPaths, 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 DtReaderWriter::SearchPaths &searchPaths, 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
DtRemoteConfigurationList::ConfigMap &	configurationMap ()
	returns the map
const DtRemoteConfigurationList::ConfigMap &	configurationMap () const
DtRemoteConfigurationEntry::CreatorFcn	entryCreatorFcn () const
	factory function to create entries
void	setEntryCreatorFcn (DtRemoteConfigurationEntry::CreatorFcn fcn)
DtRemoteConfigurationList::ConfigIterator	end ()
	Returns an iterator pointing to the first item in the map.
DtRemoteConfigurationList::const_ConfigIterator	end () const
virtual void	remove (DtRemoteConfigurationEntry *pEntry)
	Remove an entry from the map.
virtual void	remove (const char *pKeyName)
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

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 ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
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)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Override getData to parse out attachment entries.
virtual void	putData (std::string &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.

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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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

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

typedef ConfigMap::const_iterator DtRemoteConfigurationList::const_ConfigIterator

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

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

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

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

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

static DtRemoteConfigurationList* DtRemoteConfigurationList::create ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry  )

static

virtual DtlObjPtr DtRemoteConfigurationList::getData ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

Override getData to parse out attachment entries.

Reimplemented from DtReaderWriter.

virtual void DtRemoteConfigurationList::putData ( std::string &  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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/remoteConfigurationList.h