DtAggregateMoveToPSR Class Reference

This is a process state repository for the DtAggregateMoveToController that stores the list of the names of currently tasked entities. More...

Inheritance diagram for DtAggregateMoveToPSR:

Public Member Functions
	DtAggregateMoveToPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAggregateMoveToPSR (const DtAggregateMoveToPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtAggregateMoveToPSR ()
	destructor
DtAggregateMoveToPSR &	operator= (const DtAggregateMoveToPSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of this process state repository, defined in procSRTypes.h.
virtual bool	taskedSubordinateNameInList (const DtString &objectName) const
virtual void	addTaskedSubordinateName (const DtString &objectName)
virtual void	removeTaskedSubordinateName (const DtString &objectName)
virtual void	clearTaskedSubordinateNames ()
virtual bool	taskedSubordinateNamesEmpty () const
virtual const std::set < DtString > &	taskedSubordinateNames () const
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to put contents of myPromotionIndexRouteNameMap into myPromotionIdRouteNameList, to put it in a writeable form.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Override to put contents of myPromotionIdRouteNameList into myPromotionIndexRouteNameMap.
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *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 ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
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
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 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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
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 ()

Protected Member Functions
void	copyCurrentlyTaskedSubordinateNames (const DtRwStringList &other)
	Not virtual because it is called from a constructor.
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
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
std::set< DtString >	myCurrentlyTaskedSubordinateNames
	Set of currently tasked subordinate names.
DtRwStringList	mySerializableCurrentlyTaskedSubordinateNames
	Readable writeable list of currently tasked subordinate names.
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

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 Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

This is a process state repository for the DtAggregateMoveToController that stores the list of the names of currently tasked entities.

Constructor & Destructor Documentation

DtAggregateMoveToPSR::DtAggregateMoveToPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

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

copy constructor

virtual DtAggregateMoveToPSR::~DtAggregateMoveToPSR ( )

virtual

destructor

Member Function Documentation

DtAggregateMoveToPSR& DtAggregateMoveToPSR::operator=

(

const DtAggregateMoveToPSR &

orig

)

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAggregateMoveToPSR::type ( ) const

virtual

Returns the string type of this process state repository, defined in procSRTypes.h.

Returns "vrf-aggregate-move-to-process-state-repository".

Implements DtVrfProcessStateRepository.

virtual bool DtAggregateMoveToPSR::taskedSubordinateNameInList ( const DtString &  objectName ) const

virtual

virtual void DtAggregateMoveToPSR::addTaskedSubordinateName ( const DtString &  objectName )

virtual

virtual void DtAggregateMoveToPSR::removeTaskedSubordinateName ( const DtString &  objectName )

virtual

virtual void DtAggregateMoveToPSR::clearTaskedSubordinateNames ( )

virtual

virtual bool DtAggregateMoveToPSR::taskedSubordinateNamesEmpty ( ) const

virtual

virtual const std::set<DtString>& DtAggregateMoveToPSR::taskedSubordinateNames ( ) const

virtual

virtual void DtAggregateMoveToPSR::putSelf ( FILE *  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtReaderWriter::appPath()  )

virtual

Override to put contents of myPromotionIndexRouteNameMap into myPromotionIdRouteNameList, to put it in a writeable form.

Reimplemented from DtReaderWriter.

virtual void DtAggregateMoveToPSR::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

Override to put contents of myPromotionIdRouteNameList into myPromotionIndexRouteNameMap.

Reimplemented from DtVrfProcessStateRepository.

static DtVrfProcessStateRepository* DtAggregateMoveToPSR::creator ( const DtString &  rwName, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

void DtAggregateMoveToPSR::copyCurrentlyTaskedSubordinateNames ( const DtRwStringList &  other )

protected

Not virtual because it is called from a constructor.

Member Data Documentation

std::set<DtString> DtAggregateMoveToPSR::myCurrentlyTaskedSubordinateNames

protected

Set of currently tasked subordinate names.

DtRwStringList DtAggregateMoveToPSR::mySerializableCurrentlyTaskedSubordinateNames

protected

Readable writeable list of currently tasked subordinate names.

Valid only immediately after getSelf() has been called. Used to populate the contents of myCurrentlyTaskedSubordinateNames (which is valid for the lifetime of this object). Used in putSelf, in which the contents of myCurrentlyTaskedSubordinateNames is placed in this object before writing to file.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/aggregateMoveToPSR.h