VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
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:
Inheritance graph
[legend]

List of all members.

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
DtAggregateMoveToPSRoperator= (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.

Static Public Member Functions

static
DtVrfProcessStateRepository
creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
 Returns a newly created instance of this class.

Protected Member Functions

void copyCurrentlyTaskedSubordinateNames (const DtRwStringList &other)
 Not virtual because it is called from a constructor.

Protected Attributes

std::set< DtStringmyCurrentlyTaskedSubordinateNames
 Set of currently tasked subordinate names.
DtRwStringList mySerializableCurrentlyTaskedSubordinateNames
 Readable writeable list of currently tasked subordinate names.

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

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 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.

Not virtual because it is called from a constructor.


Member Data Documentation

Set of currently tasked subordinate names.

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:

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)