 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
class DtVrfOccupancyDirectorPSR: More...
Public Member Functions | |
| DtVrfOccupancyDirectorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtVrfOccupancyDirectorPSR (const DtVrfOccupancyDirectorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| virtual | ~DtVrfOccupancyDirectorPSR () |
| destructor | |
| DtVrfOccupancyDirectorPSR & | operator= (const DtVrfOccupancyDirectorPSR &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 the repository, as defined in procSRTypes.h. | |
| DtEmbarkationSlotManager * | embarkationSlotManager () |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) |
| Override to put contents of myCurrentlyDisembarkingObjectNames into mySerializableCurrentlyDisembarkingObjectNames, to put it in a writeable form. | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Override to put contents of mySerializableCurrentlyDisembarkingObjectNames into myCurrentlyDisembarkingObjectNames. | |
| virtual DtString | disembarkingObjectName () const |
| The name of the object currently disembarking when a disembark-all task is being performed. | |
| virtual void | setDisembarkingObjectName (const DtString &name) |
| The name of the object currently disembarking when a disembark-all task is being performed. | |
| virtual void | addDisembarkingObjectName (const DtString &objectName) |
| The list of the disembarking objects when a disembark-all task is being performed. | |
| virtual void | removeDisembarkingObjectName (const DtString &objectName) |
| The list of the disembarking objects when a disembark-all task is being performed. | |
| virtual void | clearDisembarkingObjectNames () |
| The list of the disembarking objects when a disembark-all task is being performed. | |
| virtual bool | disembarkingObjectNamesEmpty () const |
| The list of the disembarking objects when a disembark-all task is being performed. | |
| virtual const std::set < DtString > & | disembarkingObjectNames () const |
| The list of the disembarking objects when a disembark-all task is being performed. | |
| virtual bool | disembarkedObjectNameInList (const DtString &objectName) const |
| The list of the disembarking objects when a disembark-all task is being performed. | |
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 | |
| virtual bool | init () |
| Used for virtual construction. This base method simply returns true. | |
| virtual void | createEmbarkationSlotManager () |
| Override to create your own type of slot manager and set it to mySlotManager variable. | |
| virtual void | copyCurrentlyDisembarkingObjectNames (const DtRwStringList &other) |
| Copy the saved list of objects to be disembarked. | |
Protected Attributes | |
| DtEmbarkationSlotManager * | mySlotManager |
| DtRwString | myDisembarkingObjectName |
| The name of the object currently disembarking, when a disembark-all task is being performed. | |
| std::set< DtString > | myCurrentlyDisembarkingObjectNames |
| Set of currently objects to be disembarked when a disembark-all task is being performed. | |
| DtRwStringList | mySerializableCurrentlyDisembarkingObjectNames |
| Readable writeable list of currently objects to be disembarked. | |
class DtVrfOccupancyDirectorPSR:
Instances of DtVrfOccupancyDirectorPSR are used to hold the shared/checkpointable data for an occupancy data for items that are to be embarked.
| DtVrfOccupancyDirectorPSR::DtVrfOccupancyDirectorPSR | ( | DtVrfObject * | vrfObject, |
| const DtString & | rwName = DtString::nullString(), |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtVrfOccupancyDirectorPSR::DtVrfOccupancyDirectorPSR | ( | const DtVrfOccupancyDirectorPSR & | orig, |
| const DtString & | rwName = DtString::nullString(), |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtVrfOccupancyDirectorPSR::~DtVrfOccupancyDirectorPSR | ( | ) | [virtual] |
destructor
| DtVrfOccupancyDirectorPSR& DtVrfOccupancyDirectorPSR::operator= | ( | const DtVrfOccupancyDirectorPSR & | orig | ) |
assignment operator
| virtual DtVrfProcessStateRepository* DtVrfOccupancyDirectorPSR::clone | ( | const DtString & | rwName = DtString::nullString(), |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
returns a newly created copy of this object
Implements DtVrfProcessStateRepository.
| virtual DtString DtVrfOccupancyDirectorPSR::type | ( | ) | const [virtual] |
Returns the string type of the repository, as defined in procSRTypes.h.
(DtVrfAutomotiveProcessStateRepositoryType).
Implements DtVrfProcessStateRepository.
References createEmbarkationSlotManager(), and mySlotManager.
| virtual DtString DtVrfOccupancyDirectorPSR::disembarkingObjectName | ( | ) | const [virtual] |
The name of the object currently disembarking when a disembark-all task is being performed.
| virtual void DtVrfOccupancyDirectorPSR::setDisembarkingObjectName | ( | const DtString & | name | ) | [virtual] |
The name of the object currently disembarking when a disembark-all task is being performed.
| virtual void DtVrfOccupancyDirectorPSR::addDisembarkingObjectName | ( | const DtString & | objectName | ) | [virtual] |
The list of the disembarking objects when a disembark-all task is being performed.
| virtual void DtVrfOccupancyDirectorPSR::removeDisembarkingObjectName | ( | const DtString & | objectName | ) | [virtual] |
The list of the disembarking objects when a disembark-all task is being performed.
| virtual void DtVrfOccupancyDirectorPSR::clearDisembarkingObjectNames | ( | ) | [virtual] |
The list of the disembarking objects when a disembark-all task is being performed.
| virtual bool DtVrfOccupancyDirectorPSR::disembarkingObjectNamesEmpty | ( | ) | const [virtual] |
The list of the disembarking objects when a disembark-all task is being performed.
| virtual const std::set<DtString>& DtVrfOccupancyDirectorPSR::disembarkingObjectNames | ( | ) | const [virtual] |
The list of the disembarking objects when a disembark-all task is being performed.
| virtual bool DtVrfOccupancyDirectorPSR::disembarkedObjectNameInList | ( | const DtString & | objectName | ) | const [virtual] |
The list of the disembarking objects when a disembark-all task is being performed.
| virtual void DtVrfOccupancyDirectorPSR::putSelf | ( | FILE * | fp, |
| int | indentLevel = 0, |
||
| bool | writeUnspecified = false, |
||
| const DtFilename & | path = DtReaderWriter::appPath() |
||
| ) | [virtual] |
Override to put contents of myCurrentlyDisembarkingObjectNames into mySerializableCurrentlyDisembarkingObjectNames, to put it in a writeable form.
Reimplemented from DtReaderWriter.
| virtual void DtVrfOccupancyDirectorPSR::getSelf | ( | DtlObjPtr | args, |
| const DtFilename & | searchPath, | ||
| const DtVariableBindingsList & | variableBindings | ||
| ) | [virtual] |
Override to put contents of mySerializableCurrentlyDisembarkingObjectNames into myCurrentlyDisembarkingObjectNames.
Reimplemented from DtVrfProcessStateRepository.
| static DtVrfProcessStateRepository* DtVrfOccupancyDirectorPSR::creator | ( | const DtString & | rwName, |
| DtVrfObject * | vrfObject, | ||
| DtReaderWriterRegistry * | parentRegistry | ||
| ) | [static] |
Returns a newly created instance of this class.
| virtual bool DtVrfOccupancyDirectorPSR::init | ( | ) | [protected, virtual] |
Used for virtual construction. This base method simply returns true.
Reimplemented from DtVrfProcessStateRepository.
| virtual void DtVrfOccupancyDirectorPSR::createEmbarkationSlotManager | ( | ) | [protected, virtual] |
Override to create your own type of slot manager and set it to mySlotManager variable.
Called from init() method. Since this is a reader/writer object, make sure to call it with the name "embarkation-slot-manager" and &myRegsitry to have it read correctly from the order of battle file:
mySlotManager = new DtEmbarkationSlotManager("embarkation-slot-manager", &myRegistry);
Referenced by embarkationSlotManager().
| virtual void DtVrfOccupancyDirectorPSR::copyCurrentlyDisembarkingObjectNames | ( | const DtRwStringList & | other | ) | [protected, virtual] |
Copy the saved list of objects to be disembarked.
Referenced by embarkationSlotManager().
The name of the object currently disembarking, when a disembark-all task is being performed.
std::set<DtString> DtVrfOccupancyDirectorPSR::myCurrentlyDisembarkingObjectNames [protected] |
Set of currently objects to be disembarked when a disembark-all task is being performed.
DtRwStringList DtVrfOccupancyDirectorPSR::mySerializableCurrentlyDisembarkingObjectNames [protected] |
Readable writeable list of currently objects to be disembarked.
Valid only immediately after getSelf() has been called. Used to populate the contents of myCurrentlyDisembarkingObjectNames (which is valid for the lifetime of this object). Used in putSelf, in which the contents of myCurrentlyDisembarkingObjectNames is placed in this object before writing to file.