DtVrfProcessStateRepositoryManager Class Reference

class DtVrfProcessStateRepositoryManager: More...

Inheritance diagram for DtVrfProcessStateRepositoryManager:

Public Member Functions
	DtVrfProcessStateRepositoryManager ()
	default constructor
	DtVrfProcessStateRepositoryManager (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	readable/writable constructor
virtual	~DtVrfProcessStateRepositoryManager ()
	destructor
	DtVrfProcessStateRepositoryManager (const DtString &name, const DtVrfProcessStateRepositoryManager &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtVrfProcessStateRepositoryManager &	operator= (const DtVrfProcessStateRepositoryManager &orig)
	assignment operator
virtual DtVrfProcessStateRepositoryManager *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
virtual void	addProcessStateRepository (DtVrfProcessStateRepository *repToAdd)
	add Does not assume responsibility for or deallocate memory associated with the PSR.
virtual void	removeProcessStateRepository (DtVrfProcessStateRepository *repToRemove)
	remove Does not deallocate memory associated with the PSR
virtual DtVrfProcessStateRepository *	lookupProcessStateRepository (const DtString &procRepName) const
	lookup by name Looks only in the list immediately owned by this manager and not in any children PSRmanagers
const DtVrfProcessStateRepositoryIterator &	iterator () const
	iterate -
virtual void	completePSRList (std::list< DtVrfProcessStateRepository * > &psrList) const
	Fills in psrList with pointers to all the PSRs of this PSR Manager and all PSRs listed in system PSRs that are part of this manager.
virtual void	addProcessStateRepositoryAddedCallback (DtVrfProcessStateManagerCallbackFcn fcn, void *usrData)
	track process state additions and removals
virtual void	removeProcessStateRepositoryAddedCallback (DtVrfProcessStateManagerCallbackFcn fcn, void *usrData)
	Remove a previously register callback for notification when a DtVrfProcessStateRepository is removed.
virtual void	invokeProcessStateRepositoryAddedCallbacks (DtVrfProcessStateRepository *repBeingRemove) const
	Called by removeProcessStateRepository(). Calls registered callbacks.
virtual void	addProcessStateRepositoryAboutToBeRemovedCallback (DtVrfProcessStateManagerCallbackFcn fcn, void *usrData)
	Registers a callback for notification when a new DtVrfProcessStateRepository is about to be removed.
virtual void	removeProcessStateRepositoryAboutToBeRemovedCallback (DtVrfProcessStateManagerCallbackFcn fcn, void *usrData)
	Remove a previously register callback for notification when a DtVrfProcessStateRepository is removed.
virtual void	invokeProcessStateRepositoryAboutToBeRemovedCallbacks (DtVrfProcessStateRepository *repBeingRemove) const
	Called by removeProcessStateRepository(). Calls registered callbacks.
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
	Add element to the list just after the indicated item.
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	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 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.

Protected Member Functions
void	emptyList ()
	Used by the destructor.
void	copyList (const DtVrfProcessStateRepositoryManager &origList)
void	emptyCallbackList (DtList &listToEmpty)
void	copyCallbackList (DtList &destList, const DtList &origList)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	This form assumes the relevant process state repository has already been created.
virtual DtListItem *	lookupProcessStateRepositoryItem (const DtString &repositoryName)
virtual void	addProcessStateRepositoryAddedCallback (DtVrfProcessStateManagerCallbackInfo *cbInfo)
virtual void	removeProcessStateRepositoryAddedCallback (const DtVrfProcessStateManagerCallbackInfo &cbInfo)
virtual void	addProcessStateRepositoryAboutToBeRemovedCallback (DtVrfProcessStateManagerCallbackInfo *cbInfo)
virtual void	removeProcessStateRepositoryAboutToBeRemovedCallback (const DtVrfProcessStateManagerCallbackInfo &cbInfo)
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
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.

Protected Attributes
DtHashlist	myHashIndex
DtList	myAboutToBeRemovedProcessStateRepositoryCallbackList
DtList	myAddedProcessStateRepositoryCallbackList
DtVrfProcessStateRepositoryIterator *	myIterator

Additional Inherited Members
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
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 ()
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

class DtVrfProcessStateRepositoryManager:

Instances of DtVrfProcessStateRepositoryManager are readable/writeable lists of DtVrfProcessStateRepositories.

Constructor & Destructor Documentation

DtVrfProcessStateRepositoryManager::DtVrfProcessStateRepositoryManager

(

)

default constructor

DtVrfProcessStateRepositoryManager::DtVrfProcessStateRepositoryManager	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

readable/writable constructor

virtual DtVrfProcessStateRepositoryManager::~DtVrfProcessStateRepositoryManager ( )

virtual

destructor

DtVrfProcessStateRepositoryManager::DtVrfProcessStateRepositoryManager	(	const DtString &	name,
		const DtVrfProcessStateRepositoryManager &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

Member Function Documentation

DtVrfProcessStateRepositoryManager& DtVrfProcessStateRepositoryManager::operator=

(

const DtVrfProcessStateRepositoryManager &

orig

)

assignment operator

virtual DtVrfProcessStateRepositoryManager* DtVrfProcessStateRepositoryManager::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  )

virtual

Reimplemented in DtLegacyProcessStateRepositoryManager.

virtual void DtVrfProcessStateRepositoryManager::addProcessStateRepository ( DtVrfProcessStateRepository *  repToAdd )

virtual

add Does not assume responsibility for or deallocate memory associated with the PSR.

virtual void DtVrfProcessStateRepositoryManager::removeProcessStateRepository ( DtVrfProcessStateRepository *  repToRemove )

virtual

remove Does not deallocate memory associated with the PSR

virtual DtVrfProcessStateRepository* DtVrfProcessStateRepositoryManager::lookupProcessStateRepository ( const DtString &  procRepName ) const

virtual

lookup by name Looks only in the list immediately owned by this manager and not in any children PSRmanagers

const DtVrfProcessStateRepositoryIterator& DtVrfProcessStateRepositoryManager::iterator

(

)

const

iterate -

allocates and returns an iterator to iterate over this subObject list. It is the responsibility of the caller to delete this iterator when finished with it.

virtual void DtVrfProcessStateRepositoryManager::completePSRList ( std::list< DtVrfProcessStateRepository * > &  psrList ) const

virtual

Fills in psrList with pointers to all the PSRs of this PSR Manager and all PSRs listed in system PSRs that are part of this manager.

virtual void DtVrfProcessStateRepositoryManager::addProcessStateRepositoryAddedCallback ( DtVrfProcessStateManagerCallbackFcn  fcn, void *  usrData  )

virtual

track process state additions and removals

Registers a callback for notification when a new DtVrfProcessStateRepository is added.

virtual void DtVrfProcessStateRepositoryManager::removeProcessStateRepositoryAddedCallback ( DtVrfProcessStateManagerCallbackFcn  fcn, void *  usrData  )

virtual

Remove a previously register callback for notification when a DtVrfProcessStateRepository is removed.

virtual void DtVrfProcessStateRepositoryManager::invokeProcessStateRepositoryAddedCallbacks ( DtVrfProcessStateRepository *  repBeingRemove ) const

virtual

Called by removeProcessStateRepository(). Calls registered callbacks.

virtual void DtVrfProcessStateRepositoryManager::addProcessStateRepositoryAboutToBeRemovedCallback ( DtVrfProcessStateManagerCallbackFcn  fcn, void *  usrData  )

virtual

Registers a callback for notification when a new DtVrfProcessStateRepository is about to be removed.

virtual void DtVrfProcessStateRepositoryManager::removeProcessStateRepositoryAboutToBeRemovedCallback ( DtVrfProcessStateManagerCallbackFcn  fcn, void *  usrData  )

virtual

Remove a previously register callback for notification when a DtVrfProcessStateRepository is removed.

virtual void DtVrfProcessStateRepositoryManager::invokeProcessStateRepositoryAboutToBeRemovedCallbacks ( DtVrfProcessStateRepository *  repBeingRemove ) const

virtual

Called by removeProcessStateRepository(). Calls registered callbacks.

void DtVrfProcessStateRepositoryManager::emptyList ( )

protected

Used by the destructor.

It removes all process state rep pointers on the list.

void DtVrfProcessStateRepositoryManager::copyList ( const DtVrfProcessStateRepositoryManager &  origList )

protected

void DtVrfProcessStateRepositoryManager::emptyCallbackList ( DtList &  listToEmpty )

protected

void DtVrfProcessStateRepositoryManager::copyCallbackList ( DtList &  destList, const DtList &  origList  )

protected

virtual DtlObjPtr DtVrfProcessStateRepositoryManager::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

This form assumes the relevant process state repository has already been created.

It does a lookup for the object named by args and if it exists, reads relevant data from the stream.

Implements DtRwList.

Reimplemented in DtLegacyProcessStateRepositoryManager.

virtual DtListItem* DtVrfProcessStateRepositoryManager::lookupProcessStateRepositoryItem ( const DtString &  repositoryName )

protectedvirtual

virtual void DtVrfProcessStateRepositoryManager::addProcessStateRepositoryAddedCallback ( DtVrfProcessStateManagerCallbackInfo *  cbInfo )

protectedvirtual

virtual void DtVrfProcessStateRepositoryManager::removeProcessStateRepositoryAddedCallback ( const DtVrfProcessStateManagerCallbackInfo &  cbInfo )

protectedvirtual

virtual void DtVrfProcessStateRepositoryManager::addProcessStateRepositoryAboutToBeRemovedCallback ( DtVrfProcessStateManagerCallbackInfo *  cbInfo )

protectedvirtual

virtual void DtVrfProcessStateRepositoryManager::removeProcessStateRepositoryAboutToBeRemovedCallback ( const DtVrfProcessStateManagerCallbackInfo &  cbInfo )

protectedvirtual

Member Data Documentation

DtHashlist DtVrfProcessStateRepositoryManager::myHashIndex

protected

DtList DtVrfProcessStateRepositoryManager::myAboutToBeRemovedProcessStateRepositoryCallbackList

protected

DtList DtVrfProcessStateRepositoryManager::myAddedProcessStateRepositoryCallbackList

protected

DtVrfProcessStateRepositoryIterator* DtVrfProcessStateRepositoryManager::myIterator

protected

---

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

• include/vrfobjcore/procSRMgr.h