VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
DtVrfProcessStateRepositoryManager Class Reference

class DtVrfProcessStateRepositoryManager:

Instances of DtVrfProcessStateRepositoryManager are readable/writeable lists of DtVrfProcessStateRepository.

Related Examples
Inheritance diagram for DtVrfProcessStateRepositoryManager:
Inheritance graph
[legend]

Public Member Functions

 DtVrfProcessStateRepositoryManager ()
 
 DtVrfProcessStateRepositoryManager (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtVrfProcessStateRepositoryManager ()
 
 DtVrfProcessStateRepositoryManager (const DtString &name, const DtVrfProcessStateRepositoryManager &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtVrfProcessStateRepositoryManageroperator= (const DtVrfProcessStateRepositoryManager &orig)
 
virtual
DtVrfProcessStateRepositoryManager
clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
virtual void addProcessStateRepository (DtVrfProcessStateRepository *repToAdd)
 
virtual void addCompatibilityProcessStateRepository (DtVrfProcessStateRepository *repToAdd, const DtString &psrName)
 
virtual void removeProcessStateRepository (DtVrfProcessStateRepository *repToRemove)
 
virtual void removeCompatibilityProcessStateRepository (DtVrfProcessStateRepository *repToRemove, const DtString &psrName)
 
virtual
DtVrfProcessStateRepository
lookupProcessStateRepository (const DtString &procRepName, bool recurse=true) const
 
const
DtVrfProcessStateRepositoryIterator
iterator () const
 
virtual void completePSRList (std::list< DtVrfProcessStateRepository * > &psrList) const
 
virtual void addProcessStateRepositoryAddedCallback (DtVrfProcessStateManagerCallbackFcn fcn, void *usrData)
 
virtual void removeProcessStateRepositoryAddedCallback (DtVrfProcessStateManagerCallbackFcn fcn, void *usrData)
 
virtual void invokeProcessStateRepositoryAddedCallbacks (DtVrfProcessStateRepository *repBeingRemove) const
 
virtual void addProcessStateRepositoryAboutToBeRemovedCallback (DtVrfProcessStateManagerCallbackFcn fcn, void *usrData)
 
virtual void removeProcessStateRepositoryAboutToBeRemovedCallback (DtVrfProcessStateManagerCallbackFcn fcn, void *usrData)
 
virtual void invokeProcessStateRepositoryAboutToBeRemovedCallbacks (DtVrfProcessStateRepository *repBeingRemove) const
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
- Public Member Functions inherited from DtRwList
 DtRwList ()
 
 DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRwList ()
 
const DtRwListoperator= (const DtRwList &orig)
 
virtual DtListItem * add (DtReaderWriter *data)
 
virtual DtListItem * addWithAlternateName (DtReaderWriter *data, const DtString &name)
 
virtual DtListItem * addToStart (DtReaderWriter *data)
 
virtual DtListItem * addToEnd (DtReaderWriter *data)
 
virtual void * remove (DtReaderWriter *data, DtListItem *item)
 
virtual DtlObjPtr getLocalData (DtlObjPtr args)
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual DtListItem * addBefore (DtReaderWriter *data, DtReaderWriter *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtReaderWriter *after)
 
virtual void removeAll ()
 
virtual void removeAndDeleteAll ()
 
virtual void reset ()
 
virtual const charreaderWriterType () const
 
bool operator== (const DtRwList &rhs) const
 
bool operator!= (const DtRwList &rhs) const
 
virtual void populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
virtual void populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
 DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtString &before)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtSymbolString &before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtString &after)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtSymbolString &after)
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual const charxmlType () const
 
virtual std::set< DtStringsupportedXmlTypes () const
 
- 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 DtReaderWriteroperator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
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 aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
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 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 DtReaderWriterdefaultRWValue () const
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Protected Types

typedef std::pair< DtString,
DtVrfProcessStateRepository * > 
CompatibilityPsrInfo
 

Protected Member Functions

void emptyList ()
 
void copyList (const DtVrfProcessStateRepositoryManager &origList)
 
void emptyCallbackList (DtList &listToEmpty)
 
void copyCallbackList (DtList &destList, const DtList &origList)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
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)
 
virtual bool isCompatiblePsr (DtVrfProcessStateRepository *psr) const
 
- Protected Member Functions inherited from DtRwList
virtual DtListItem * addBefore (DtReaderWriter *data, DtListItem *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtListItem *after)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

DtHashlist myHashIndex
 
DtList myAboutToBeRemovedProcessStateRepositoryCallbackList
 
DtList myAddedProcessStateRepositoryCallbackList
 
DtVrfProcessStateRepositoryIteratormyIterator
 
std::list< CompatibilityPsrInfomyCompatibilityPsrs
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

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::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- Static Public Member Functions inherited from DtRwList
static const chartheXmlType ()
 
- 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 chartheXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Member Typedef Documentation

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
virtual void DtVrfProcessStateRepositoryManager::addProcessStateRepository ( DtVrfProcessStateRepository repToAdd)
virtual

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

virtual void DtVrfProcessStateRepositoryManager::addCompatibilityProcessStateRepository ( DtVrfProcessStateRepository repToAdd,
const DtString psrName 
)
virtual

Adds a PSR for backwards compatibility for reading a PSR with a different name that it currently has.

virtual void DtVrfProcessStateRepositoryManager::removeProcessStateRepository ( DtVrfProcessStateRepository repToRemove)
virtual

remove Does not deallocate memory associated with the PSR

virtual void DtVrfProcessStateRepositoryManager::removeCompatibilityProcessStateRepository ( DtVrfProcessStateRepository repToRemove,
const DtString psrName 
)
virtual

Removes a PSR for that was added with addCompatibilityProcessStateRepository()

virtual DtVrfProcessStateRepository* DtVrfProcessStateRepositoryManager::lookupProcessStateRepository ( const DtString procRepName,
bool  recurse = true 
) const
virtual

lookup by name If recurse is true, looks up PSRs in child PSR managers as well. If recurse is false, only immediate children will be found.

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.

virtual void DtVrfProcessStateRepositoryManager::putSelf ( std::string &  fp,
int  indentLevel = 0,
bool  writeUnspecified = false,
const DtFilename &  path = DtFilename::nullFilename() 
)
virtual

Overloaded from parent to prevent the writing of compatibility PSRs.

Reimplemented from DtReaderWriter.

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 DtReaderWriter::SearchPaths searchPaths,
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
virtual bool DtVrfProcessStateRepositoryManager::isCompatiblePsr ( DtVrfProcessStateRepository psr) const
protectedvirtual
Returns
True if psr is on the myCompatiblityPsrs list.

Member Data Documentation

DtHashlist DtVrfProcessStateRepositoryManager::myHashIndex
protected
DtList DtVrfProcessStateRepositoryManager::myAboutToBeRemovedProcessStateRepositoryCallbackList
protected
DtList DtVrfProcessStateRepositoryManager::myAddedProcessStateRepositoryCallbackList
protected
DtVrfProcessStateRepositoryIterator* DtVrfProcessStateRepositoryManager::myIterator
protected
std::list<CompatibilityPsrInfo> DtVrfProcessStateRepositoryManager::myCompatibilityPsrs
protected

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

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)