VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtVrfProcessStateRepository Class Reference

Class DtVrfProcessStateRepository: Abstract base class for all process state repositories. More...

Inherits DtReaderWriter.

Inherited by BHAVE::DtKynapsePSR, BHAVE::DtSpawnControllerPSR, DtAggregatedMoveAlongPSR, DtAggregatedMoveToPSR, DtAggregatedPatrolPSR, DtAggregatedResolutionPSR, DtAggregateMoveAlongPSR, DtAggregateMoveToLocationPSR, DtAggregateMoveToPSR, DtAggregatePatrolAlongPSR, DtAggregatePatrolBetweenPSR, DtAutomotivePSR, DtComponentSystemPSR, DtConvoyPSR, DtCruiseMissileLaunchControllerPSR, DtDIGuyControllerPSR, DtEmitterPSR, DtFixedWingFlightPSR, DtFormationPSR, DtGroundMovementChooserPSR, DtHumanCollisionAvoidancePSR, DtHumanFollowPSR, DtHumanMoveAlongPSR, DtHumanMoveToPSR, DtHumanPatrolPSR, DtHumanPosturePSR, DtIndirectArtilleryPSR, DtLaserDetectorPSR, DtLaserLauncherPSR, DtLaserTrackerPSR, DtLasingPSR, DtLaunchExpendableResourcePSR, DtLimitExistencePSR, DtLocalEntitySetControllerPSR, DtMissileDistractionPSR, DtMissileFlightPSR, DtMultipleHitDamagePSR, DtObjectSensorPSR, DtObstructionSensorPSR, DtPathMovementControllerPSR, DtPseudoAggregateMovementPSR, DtRailMovementControllerPSR, DtRailPathControllerPSR, DtRotaryWingFlightPSR, DtSpotReportGeneratorControllerPSR, DtSurfaceMovementPSR, DtSwingingPartActuatorPSR, DtSwitchSystemComponentPSR, DtTargetSelectionControllerPSR, DtTimeKeeperPSR, DtTurnAndMoveControllerPSR, DtVrfEmbarkationPSR, DtVrfFixedWingLandingPSR, DtVrfFixedWingTakeoffPSR, DtVrfIffPSR, DtVrfOccupancyDirectorPSR, DtVrfWeaponPSR, DtWaitingPSR, DtWarheadDetonationActuatorPSR, DtWeaponComponentInterface, and vrfLua::DtScriptPSR.

List of all members.

Public Member Functions

 DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepositoryoperator= (const DtVrfProcessStateRepository &orig)
virtual ~DtVrfProcessStateRepository ()
virtual
DtVrfProcessStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const =0
virtual bool init ()
 Used for virtual construction. This base method simply returns true.
virtual DtString type () const =0
 Returns the string type of the repository, as defined in procSRTypes.h.
virtual bool loadedFromMTL () const
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)

Static Public Member Functions

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.

Protected Member Functions

 DtVrfProcessStateRepository ()

Protected Attributes

DtVrfObjectmyVrfObject
bool myLoadedFromMTL

Static Protected Attributes

static
DtVrfProcessStateRepositoryFactory
theFactory

Detailed Description

Class DtVrfProcessStateRepository: Abstract base class for all process state repositories.

Process state repositories represent (potentially) shared, savable information for one or more components functioning together to achieve some process or set of processes; such as aiming and firing a weapon; moving an object; or just waiting a specified amount of time.

Each DtVrfObjectStateRepository maintains a list of the process states used by that object (via a DtVrfProcessStateRepositoryManager), and all the components that use the process state rep maintain pointers to it. Eventually, the proposed sub-system mechanism will be used to create and delete these process state repositories, but for now, one of the components participating in the process (typically an actuator if one exists) will create and delete these repositories.

Examples

Constructor & Destructor Documentation

DtVrfProcessStateRepository::DtVrfProcessStateRepository ( DtVrfObject vrfObject,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
DtVrfProcessStateRepository::DtVrfProcessStateRepository ( const DtVrfProcessStateRepository orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

Member Function Documentation

const DtVrfProcessStateRepository& DtVrfProcessStateRepository::operator= ( const DtVrfProcessStateRepository orig)
virtual DtVrfProcessStateRepository* DtVrfProcessStateRepository::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const [pure virtual]

Implemented in DtPseudoAggregateMovementPSR, DtVrfEmbarkationPSR, DtVrfBalGunPSR, DtLaserDetectorPSR, DtLaserTrackerPSR, DtLaserLauncherPSR, DtRailMovementControllerPSR, DtAutomotivePSR, DtMissileFlightPSR, DtWeaponComponentInterface, DtAggregateMoveAlongPSR, DtRotaryWingFlightPSR, DtVrfFixedWingLandingPSR, DtRailPathControllerPSR, DtFixedWingFlightPSR, DtVrfWeaponPSR, DtWaitingPSR, BHAVE::DtKynapsePSR, DtConvoyPSR, DtVrfFixedWingTakeoffPSR, DtLasingPSR, DtSurfaceMovementPSR, DtAggregatedResolutionPSR, DtHumanCollisionAvoidancePSR, DtVrfIndirectFirePSR, DtVrfOccupancyDirectorPSR, DtWarheadDetonationActuatorPSR, DtAggregatedMoveAlongPSR, DtAggregatedMoveToPSR, DtDIGuyControllerPSR, DtHumanMoveAlongPSR, DtHumanMoveToPSR, DtObjectSensorPSR, BHAVE::DtSpawnControllerPSR, DtComponentSystemPSR, DtFormationPSR, DtPathMovementControllerPSR, DtVrfTurretedBalGunPSR, DtAggregateMoveToLocationPSR, DtAggregateMoveToPSR, DtMissileDistractionPSR, DtCruiseMissileLaunchControllerPSR, DtHumanFollowPSR, DtIndirectArtilleryPSR, DtLocalEntitySetControllerPSR, DtObstructionSensorPSR, DtAggregatedPatrolPSR, DtEmitterPSR, DtVrfIffPSR, DtLaunchExpendableResourcePSR, DtAggregatePatrolAlongPSR, DtAggregatePatrolBetweenPSR, DtHumanPatrolPSR, DtHumanPosturePSR, DtMultipleHitDamagePSR, DtSwingingPartActuatorPSR, DtTimeKeeperPSR, vrfLua::DtScriptPSR, DtGroundMovementChooserPSR, DtRadarObjectSensorPSR, DtSwitchSystemComponentPSR, DtTargetSelectionControllerPSR, DtTurnAndMoveControllerPSR, DtLimitExistencePSR, DtRotaryWingFlightCommandControllerPSR, and DtSpotReportGeneratorControllerPSR.

virtual bool DtVrfProcessStateRepository::init ( ) [virtual]

Used for virtual construction. This base method simply returns true.

Reimplemented in DtVrfOccupancyDirectorPSR, DtObjectSensorPSR, DtMissileDistractionPSR, and DtObstructionSensorPSR.

virtual DtString DtVrfProcessStateRepository::type ( ) const [pure virtual]

Returns the string type of the repository, as defined in procSRTypes.h.

Implemented in DtPseudoAggregateMovementPSR, DtVrfEmbarkationPSR, DtVrfTurretedBalGunPSR, DtVrfBalGunPSR, DtLaserDetectorPSR, DtLaserTrackerPSR, DtLaserLauncherPSR, DtRailMovementControllerPSR, DtAutomotivePSR, DtMissileFlightPSR, DtAggregateMoveAlongPSR, DtRotaryWingFlightPSR, DtWeaponComponentInterface, DtVrfFixedWingLandingPSR, DtFixedWingFlightPSR, DtRailPathControllerPSR, DtWaitingPSR, DtVrfWeaponPSR, DtConvoyPSR, DtVrfFixedWingTakeoffPSR, BHAVE::DtKynapsePSR, DtLasingPSR, DtSurfaceMovementPSR, DtAggregatedResolutionPSR, DtHumanCollisionAvoidancePSR, DtVrfOccupancyDirectorPSR, DtAggregatedMoveAlongPSR, DtAggregatedMoveToPSR, DtHumanMoveAlongPSR, DtHumanMoveToPSR, DtVrfIndirectFirePSR, DtWarheadDetonationActuatorPSR, DtDIGuyControllerPSR, DtAggregateMoveToLocationPSR, DtFormationPSR, DtObjectSensorPSR, BHAVE::DtSpawnControllerPSR, DtAggregateMoveToPSR, DtComponentSystemPSR, DtObstructionSensorPSR, DtPathMovementControllerPSR, DtHumanFollowPSR, DtLocalEntitySetControllerPSR, DtMissileDistractionPSR, DtAggregatedPatrolPSR, DtCruiseMissileLaunchControllerPSR, DtEmitterPSR, DtVrfIffPSR, DtIndirectArtilleryPSR, DtAggregatePatrolAlongPSR, DtAggregatePatrolBetweenPSR, DtHumanPatrolPSR, DtHumanPosturePSR, DtLaunchExpendableResourcePSR, DtMultipleHitDamagePSR, DtSwingingPartActuatorPSR, DtTimeKeeperPSR, vrfLua::DtScriptPSR, DtGroundMovementChooserPSR, DtRadarObjectSensorPSR, DtSwitchSystemComponentPSR, DtTargetSelectionControllerPSR, DtLimitExistencePSR, DtTurnAndMoveControllerPSR, DtRotaryWingFlightCommandControllerPSR, and DtSpotReportGeneratorControllerPSR.

virtual bool DtVrfProcessStateRepository::loadedFromMTL ( ) const [virtual]
virtual void DtVrfProcessStateRepository::getSelf ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [virtual]

a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.

The DtSimCreator deletes this pointer when it is deleted. This is done this way because we don't allow static initialization

Reimplemented from DtReaderWriter.

static DtVrfProcessStateRepository* DtVrfProcessStateRepository::createRepository ( const DtString name,
const DtString type,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry = 0 
) [static]

Creates a new state repository object, using the factory.


Member Data Documentation

Reimplemented from DtReaderWriter.


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)