VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtLegacyProcessStateRepositoryManager Class Reference

Version of the DtVrfProcessStateRepositoryManager that is used specifically to read in scenario files written out by pre VRF 3.11 version. More...

Inheritance diagram for DtLegacyProcessStateRepositoryManager:
Inheritance graph
[legend]

Public Member Functions

 DtLegacyProcessStateRepositoryManager ()
 default constructor
 DtLegacyProcessStateRepositoryManager (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 readable/writable constructor
virtual ~DtLegacyProcessStateRepositoryManager ()
 destructor
 DtLegacyProcessStateRepositoryManager (const DtString &name, const DtLegacyProcessStateRepositoryManager &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
DtLegacyProcessStateRepositoryManageroperator= (const DtLegacyProcessStateRepositoryManager &orig)
 assignment operator
virtual
DtLegacyProcessStateRepositoryManager
clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
virtual void setSystemPsrManager (DtVrfProcessStateRepositoryManager *manager)
- Public Member Functions inherited from DtVrfProcessStateRepositoryManager
 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
DtVrfProcessStateRepositoryManageroperator= (const DtVrfProcessStateRepositoryManager &orig)
 assignment operator
virtual void addProcessStateRepository (DtVrfProcessStateRepository *repToAdd)
 add Does not assume responsibility for or deallocate memory associated with the PSR.
virtual void addCompatibilityProcessStateRepository (DtVrfProcessStateRepository *repToAdd, const DtString &psrName)
 Adds a PSR for backwards compatibility for reading a PSR with a different name that it currently has.
virtual void removeProcessStateRepository (DtVrfProcessStateRepository *repToRemove)
 remove Does not deallocate memory associated with the PSR
virtual void removeCompatibilityProcessStateRepository (DtVrfProcessStateRepository *repToRemove, const DtString &psrName)
 Removes a PSR for that was added with addCompatibilityProcessStateRepository()
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.
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Overloaded from parent to prevent the writing of compatibility PSRs.
- 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 DtRwListoperator= (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 * addWithAlternateName (DtReaderWriter *data, const DtString &name)
 Add element to the end of the list, but use the provided name in place of the object name on the data object.
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)
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.
bool operator== (const DtRwList &rhs) const
 Iterates over all items and calls the factory to compare.
bool operator!= (const DtRwList &rhs) const
 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 DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
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 aliasContaineraliases () 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 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)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 This form assumes the relevant process state repository has already been created.
virtual
DtVrfProcessStateRepository
findPsrByName (const DtString &name, const std::list< DtVrfProcessStateRepository * > &psrList)
- Protected Member Functions inherited from DtVrfProcessStateRepositoryManager
void emptyList ()
 Used by the destructor.
void copyList (const DtVrfProcessStateRepositoryManager &origList)
void emptyCallbackList (DtList &listToEmpty)
void copyCallbackList (DtList &destList, const DtList &origList)
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)
 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.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.

Protected Attributes

DtVrfProcessStateRepositoryManagermySystemPsrManager
 A pointer to the system PSR manager on the entity.
- Protected Attributes inherited from DtVrfProcessStateRepositoryManager
DtHashlist myHashIndex
DtList myAboutToBeRemovedProcessStateRepositoryCallbackList
DtList myAddedProcessStateRepositoryCallbackList
DtVrfProcessStateRepositoryIteratormyIterator
std::list< CompatibilityPsrInfomyCompatibilityPsrs

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
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- 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 void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory.
static void createReaderWriterFactory ()
static DtReaderWriterFactoryfactory ()
- Protected Types inherited from DtVrfProcessStateRepositoryManager
typedef std::pair< DtString,
DtVrfProcessStateRepository * > 
CompatibilityPsrInfo
- 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

Detailed Description

Version of the DtVrfProcessStateRepositoryManager that is used specifically to read in scenario files written out by pre VRF 3.11 version.

Instead of reading the PSRs into its own list, it attempts to read the PSRs into the list specified by mySystemPsrManager. This class will be removed once it is no longer necessary to read in scenarios from these versions.

Constructor & Destructor Documentation

DtLegacyProcessStateRepositoryManager::DtLegacyProcessStateRepositoryManager ( )

default constructor

DtLegacyProcessStateRepositoryManager::DtLegacyProcessStateRepositoryManager ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)

readable/writable constructor

virtual DtLegacyProcessStateRepositoryManager::~DtLegacyProcessStateRepositoryManager ( )
virtual

destructor

DtLegacyProcessStateRepositoryManager::DtLegacyProcessStateRepositoryManager ( const DtString name,
const DtLegacyProcessStateRepositoryManager orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

Member Function Documentation

DtLegacyProcessStateRepositoryManager& DtLegacyProcessStateRepositoryManager::operator= ( const DtLegacyProcessStateRepositoryManager orig)

assignment operator

virtual DtLegacyProcessStateRepositoryManager* DtLegacyProcessStateRepositoryManager::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)
virtual
virtual void DtLegacyProcessStateRepositoryManager::setSystemPsrManager ( DtVrfProcessStateRepositoryManager manager)
virtual
virtual DtlObjPtr DtLegacyProcessStateRepositoryManager::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.

Reimplemented from DtVrfProcessStateRepositoryManager.

virtual DtVrfProcessStateRepository* DtLegacyProcessStateRepositoryManager::findPsrByName ( const DtString name,
const std::list< DtVrfProcessStateRepository * > &  psrList 
)
protectedvirtual

Member Data Documentation

DtVrfProcessStateRepositoryManager* DtLegacyProcessStateRepositoryManager::mySystemPsrManager
protected

A pointer to the system PSR manager on the entity.


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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)