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

DtSyncMatrixControllerPSR is a process state repository which holds state variables for the DtSyncMatrixController component.

Inheritance diagram for DtSyncMatrixControllerPSR:
Inheritance graph
[legend]

Public Member Functions

 DtSyncMatrixControllerPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtSyncMatrixControllerPSR (const DtSyncMatrixControllerPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
DtSyncMatrixControllerPSR & operator= (const DtSyncMatrixControllerPSR &orig)
 
virtual ~DtSyncMatrixControllerPSR ()
 
virtual
DtVrfProcessStateRepository * 		clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 
virtual DtString type () const
 
virtual DtRwSyncMatrixPhaseList & phases ()
 
virtual const
DtRwSyncMatrixPhaseList & 		phases () const
 
virtual DtRwSyncMatrixObjectList & objects ()
 
virtual const
DtRwSyncMatrixObjectList & 		objects () const
 
virtual const
DtRwSyncMatrixPlanList & 		plans () const
 
virtual DtRwSyncMatrixPhase * addPhase (const DtString &name, int phaseIndex=-1)
 
virtual void renamePhase (const DtString &currentPhaseName, const DtString &requestedPhaseName)
 
virtual void removePhase (const DtString &phaseName)
 
virtual DtRwSyncMatrixPhase * movePhase (const DtString &name, int phaseIndex)
 
virtual DtString currentPhaseName () const
 
virtual
DtRwSyncMatrixPhaseList::iterator * 		phaseIterator ()
 
virtual void postGetSelf ()
 
virtual void resetPhaseIterator ()
 
virtual void moveToNextPhase ()
 
virtual void syncLinkStatusForPhases ()
 
virtual void removePlanFromPhase (const DtUUID &, const DtString &)
 
virtual void removePlansByUUID (const DtUUID &)
 
virtual bool planContinuedIntoNextPhase (DtRwSyncMatrixPlan *)
 
virtual DtRwSyncMatrixPlan * addPlan (const DtUUID &uuid, const DtString &phaseName, const DtPlan *plan=NULL)
 
virtual DtRwSyncMatrixPlan * getPlanFromPhase (const DtUUID &uuid, const DtString &phaseName)
 
- Public Member Functions inherited from DtVrfProcessStateRepository
 DtVrfProcessStateRepository (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
const DtVrfProcessStateRepository & operator= (const DtVrfProcessStateRepository &orig)
 
virtual ~DtVrfProcessStateRepository ()
 
virtual bool init ()
 
virtual bool loadedFromMTL () const
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
- 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 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 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
DtVrfProcessStateRepository * 		creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory * 		factory ()
 
static void setFactory (DtVrfProcessStateRepositoryFactory *factory)
 
static void addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
 
static
DtVrfProcessStateRepository * 		createRepository (const DtString &name, const DtString &type, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
 
- 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 Types

typedef std::map< DtString,
std::map< DtUUID,
DtRwSyncMatrixPlan * > > 		PlansByPhase
 

Protected Attributes

DtRwSyncMatrixPhaseList myPhases
 
DtRwSyncMatrixObjectList myObjects
 
DtRwSyncMatrixPlanList myPlans
 
DtRwString myCurrentPhaseName
 
DtRwSyncMatrixPhaseList::iterator * myPhaseIterator
 
PlansByPhase myPlansByPhase
 
- Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject * myVrfObject
 
bool myLoadedFromMTL
 
- 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

- 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 )()
 
- Protected Member Functions inherited from DtVrfProcessStateRepository
 DtVrfProcessStateRepository ()
 
const DtSimObject * vrfObject () const
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Static Protected Attributes inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory * 		theFactory
 
- 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 std::map<DtString, std::map<DtUUID, DtRwSyncMatrixPlan*> > DtSyncMatrixControllerPSR::PlansByPhase
protected

Constructor & Destructor Documentation

DtSyncMatrixControllerPSR::DtSyncMatrixControllerPSR ( DtLocalObject *  vrfObject,
const DtString &  rwName = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = 0 
)

Constructor.

DtSyncMatrixControllerPSR::DtSyncMatrixControllerPSR ( const DtSyncMatrixControllerPSR &  orig,
const DtString &  rwName = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = 0 
)

Copy constructor.

virtual DtSyncMatrixControllerPSR::~DtSyncMatrixControllerPSR ( )
virtual

Destructor.

Member Function Documentation

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

Assignment Operator.

virtual DtVrfProcessStateRepository* DtSyncMatrixControllerPSR::clone ( const DtString &  rwName = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = 0 
) const
virtual

Returns complete copy of this class using the copy constructor.

Implements DtVrfProcessStateRepository.

virtual DtString DtSyncMatrixControllerPSR::type ( ) const
virtual

Returns "synchronization-matrix-controller-process-state-repository".

Implements DtVrfProcessStateRepository.

static DtVrfProcessStateRepository* DtSyncMatrixControllerPSR::creator ( const DtString &  rwName,
DtLocalObject *  vrfObject,
DtReaderWriterRegistry *  parentRegistry = 0 
)
static

Static creator function for factory registration.

virtual DtRwSyncMatrixPhaseList& DtSyncMatrixControllerPSR::phases ( )
virtual
virtual const DtRwSyncMatrixPhaseList& DtSyncMatrixControllerPSR::phases ( ) const
virtual
virtual DtRwSyncMatrixObjectList& DtSyncMatrixControllerPSR::objects ( )
virtual
virtual const DtRwSyncMatrixObjectList& DtSyncMatrixControllerPSR::objects ( ) const
virtual
virtual const DtRwSyncMatrixPlanList& DtSyncMatrixControllerPSR::plans ( ) const
virtual
virtual DtRwSyncMatrixPhase* DtSyncMatrixControllerPSR::addPhase ( const DtString &  name,
int  phaseIndex = -1 
)
virtual
virtual void DtSyncMatrixControllerPSR::renamePhase ( const DtString &  currentPhaseName,
const DtString &  requestedPhaseName 
)
virtual
virtual void DtSyncMatrixControllerPSR::removePhase ( const DtString &  phaseName)
virtual
virtual DtRwSyncMatrixPhase* DtSyncMatrixControllerPSR::movePhase ( const DtString &  name,
int  phaseIndex 
)
virtual
virtual DtString DtSyncMatrixControllerPSR::currentPhaseName ( ) const
virtual
virtual DtRwSyncMatrixPhaseList::iterator* DtSyncMatrixControllerPSR::phaseIterator ( )
virtual
virtual void DtSyncMatrixControllerPSR::postGetSelf ( )
virtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

virtual void DtSyncMatrixControllerPSR::resetPhaseIterator ( )
virtual
virtual void DtSyncMatrixControllerPSR::moveToNextPhase ( )
virtual
virtual void DtSyncMatrixControllerPSR::syncLinkStatusForPhases ( )
virtual
virtual void DtSyncMatrixControllerPSR::removePlanFromPhase ( const DtUUID &  ,
const DtString &   
)
virtual
virtual void DtSyncMatrixControllerPSR::removePlansByUUID ( const DtUUID &  )
virtual
virtual bool DtSyncMatrixControllerPSR::planContinuedIntoNextPhase ( DtRwSyncMatrixPlan *  )
virtual
virtual DtRwSyncMatrixPlan* DtSyncMatrixControllerPSR::addPlan ( const DtUUID &  uuid,
const DtString &  phaseName,
const DtPlan *  plan = NULL 
)
virtual
virtual DtRwSyncMatrixPlan* DtSyncMatrixControllerPSR::getPlanFromPhase ( const DtUUID &  uuid,
const DtString &  phaseName 
)
virtual

Member Data Documentation

DtRwSyncMatrixPhaseList DtSyncMatrixControllerPSR::myPhases
protected
DtRwSyncMatrixObjectList DtSyncMatrixControllerPSR::myObjects
protected
DtRwSyncMatrixPlanList DtSyncMatrixControllerPSR::myPlans
protected
DtRwString DtSyncMatrixControllerPSR::myCurrentPhaseName
protected
DtRwSyncMatrixPhaseList::iterator* DtSyncMatrixControllerPSR::myPhaseIterator
protected
PlansByPhase DtSyncMatrixControllerPSR::myPlansByPhase
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)