VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtEntityStateRepository Class Reference

Instances of DtEntityStateRepository are used to maintain attributes and state of entity objects in a protocol independent way. More...

+ Inheritance diagram for DtEntityStateRepository:
+ Collaboration diagram for DtEntityStateRepository:

Public Member Functions

 DtEntityStateRepository ()
 Default CTOR. More...
 
 DtEntityStateRepository (const DtEntityStateRepository &orig)
 Copy CTOR. More...
 
virtual ~DtEntityStateRepository ()
 Virtual DTOR. More...
 
DtEntityStateRepositoryoperator= (const DtEntityStateRepository &orig)
 Assignment operator. More...
 
virtual DtStateRepositoryclone (bool copy=false) const
 Return a copy/empty object of the same type as this. More...
 
virtual void setForceId (DtForceType force)
 Set the force type. More...
 
virtual DtForceType forceId () const
 Get the force type. More...
 
virtual void setGuise (const DtEntityType &type)
 Set the alternate entity type or guise. More...
 
virtual const DtEntityTypeguise () const
 Get the alternate entity type or guise. More...
 
virtual void setMarkingCharSet (int charSet)
 Set the character set used for the marking. More...
 
virtual int markingCharSet () const
 The character set used for the marking. More...
 
virtual void setMarkingText (const char *text)
 Set the marking text attribute. More...
 
virtual const char * markingText () const
 Get the marking text attribute. More...
 
virtual void setInfraRedSigRepIndex (DtU16 value)
 Set infra-red signature representation index. More...
 
virtual DtU16 infraRedSigRepIndex () const
 Get infra-red signature representation index. More...
 
virtual void setAcousticSigRepIndex (DtU16 value)
 Set acoustic signature representation index. More...
 
virtual DtU16 acousticSigRepIndex () const
 Get acoustic signature representation index. More...
 
virtual void setRadarSigRepIndex (DtU16 value)
 Set radar signature representation index. More...
 
virtual DtU16 radarSigRepIndex () const
 Get radar signature representation index. More...
 
virtual void setCapabilities (DtU32 cap)
 Set the capabilities field. More...
 
virtual DtU32 capabilities () const
 Get the capabilities field. More...
 
virtual void setMeasuredSpeed (DtU16 value)
 Set measured speed. More...
 
virtual DtU16 measuredSpeed () const
 Get measured speed. More...
 
void setNumPropulsionSystems (DtU16 value)
 Set number of propulsion systems (Non-virtual - Used in CTOR). More...
 
DtU16 numPropulsionSystems () const
 Get number of propulsion systems (Non-virtual - Used in CTOR). More...
 
void setNumNozzleSystems (DtU16 value)
 Set number of nozzle systems (Non-virtual - Used in CTOR). More...
 
DtU16 numNozzleSystems () const
 Get number of nozzle systems (Non-virtual - Used in CTOR). More...
 
bool setPropulsionSystem (int index, const DtPropulsionSystem &record)
 Set a propulsion system data record (Non-virtual - Used in CTOR). More...
 
bool getPropulsionSystem (int index, DtPropulsionSystem &record) const
 Get a propulsion system data record (Non-virtual - Used in CTOR). More...
 
bool setNozzleSystem (int index, const DtVectoringNozzleSystem &record)
 Set a vectoring nozzle system data record (Non-virtual - Used in CTOR). More...
 
bool getNozzleSystem (int index, DtVectoringNozzleSystem &record) const
 Get a vectoring nozzle system data record (Non-virtual - Used in CTOR). More...
 
virtual void setClock (DtClock *clock)
 Overrides DtBaseEntityStateRepository's setClock method. More...
 
virtual void printData () const
 Print the state data to the DtInfo stream. More...
 
virtual void printDataToStream (std::ostream &stream) const
 prints the state data to the specified stream. More...
 
Appearance attributes describe visual properties of an object.

Appearance attributes are optional, and describe the appearance of an object.

Not all attributes apply to all entity types. Many non RPR Based FOMs do not contain these attributes, users should keep this in mind when using a FOM Mapper.

virtual void setAppearance (DtU32 app)
 Set the appearance bit field, use with care. More...
 
virtual DtU32 appearance () const
 Return the appearance bit field, use this with care. More...
 
virtual void setAppearanceAttribute (const DtAppearAttribute attr, const DtAppearAttrVal val)
 Set an appearance attribute. More...
 
virtual DtAppearAttrVal appearanceAttribute (const DtAppearAttribute attr) const
 Get an appearance attribute. More...
 
virtual void setFrozen (bool onOff)
 Set the frozen state of the entity. More...
 
virtual bool frozen () const
 Get the frozen state of the entity. More...
 
virtual void setPowerPlantOn (bool onOff)
 Set whether entity's power plant is on or not. More...
 
virtual bool powerPlantOn () const
 Get whether entity's power plant is on or not. More...
 
virtual void setDamageState (DtDamageState s)
 Set the damage state. More...
 
virtual DtDamageState damageState () const
 Get the damage state. More...
 
virtual void setEngineSmokeOn (bool onOff)
 Set whether engine smoke is on or not. More...
 
virtual bool engineSmokeOn () const
 Get whether engine smoke is on or not. More...
 
virtual void setFlamesPresent (bool onOff)
 Set whether flames are present or not. More...
 
virtual bool flamesPresent () const
 Get whether flames are present or not. More...
 
virtual void setHasFuelSupplyCap (bool onOff)
 Set whether entity has fuel supplying capability. More...
 
virtual bool hasFuelSupplyCap () const
 Get whether entity has fuel supplying capability. More...
 
virtual void setHasRecoveryCap (bool onOff)
 Set whether entity has recovery capability. More...
 
virtual bool hasRecoveryCap () const
 Get whether entity has recovery capability. More...
 
virtual void setHasRepairCap (bool onOff)
 Set whether entity has repair capability. More...
 
virtual bool hasRepairCap () const
 Get whether entity has repair capability. More...
 
virtual void setHatchState (DtHatchState s)
 Set the entity's hatch state. More...
 
virtual DtHatchState hatchState () const
 Get the entity's hatch state. More...
 
virtual void setImmobilized (bool onOff)
 Set whether the entity is immobilized or not. More...
 
virtual bool immobilized () const
 Get whether the entity is immobilized or not. More...
 
virtual void setLifeformState (DtLifeformState s)
 Set entity life form state. More...
 
virtual DtLifeformState lifeformState () const
 Get entity life form state. More...
 
virtual void setLightState (DtLightType s, bool onOff)
 Set light state of entity. More...
 
virtual bool lightState (DtLightType s) const
 Get light state of entity. More...
 
virtual void setLightState (DtLightState s)
 Set light state of entity. More...
 
virtual DtLightState lightState () const
 Get light state of entity. More...
 
virtual void setDensity (DtDensityType dens)
 Set density state of entity (Environment entities). More...
 
virtual DtDensityType density () const
 Get density state of entity (Environment entities). More...
 
virtual void setRampDeployed (bool onOff)
 Set whether entity has ramp deployed or not. More...
 
virtual bool rampDeployed () const
 Get whether entity has ramp deployed or not. More...
 
virtual void setSmokePlumePresent (bool onOff)
 Set whether a smoke plume is present or not. More...
 
virtual bool smokePlumePresent () const
 Get whether a smoke plume is present or not. More...
 
virtual void setTentDeployed (bool onOff)
 Set whether a tent is deployed or not. More...
 
virtual bool tentDeployed () const
 Get whether a tent is deployed or not. More...
 
virtual void setTrailState (DtTrailState s)
 Set trailing effect state. More...
 
virtual DtTrailState trailState () const
 Get trailing effect state. More...
 
virtual void setCamouflageType (DtCamouflageType type)
 Set camouflage type. More...
 
virtual DtCamouflageType camouflageType () const
 Get camouflage type. More...
 
virtual void setFirePowerDisabled (bool onOff)
 Set whether entity is fire power disabled or not. More...
 
virtual bool firePowerDisabled () const
 Get whether entity is fire power disabled or not. More...
 
virtual void setIsConcealed (bool onOff)
 Set whether entity is concealed or not. More...
 
virtual bool isConcealed () const
 Get whether entity is concealed or not. More...
 
virtual void setAfterburnerOn (bool onOff)
 Set whether entity has after burner on or not. More...
 
virtual bool afterburnerOn () const
 Get whether entity has after burner on or not. More...
 
virtual void setHasAmmunitionSupplyCap (bool onOff)
 Set whether entity has ammunition supply capability or not. More...
 
virtual bool hasAmmunitionSupplyCap () const
 Get whether entity has ammunition supply capability or not. More...
 
virtual void setLauncherRaised (bool onOff)
 Set whether entity has launcher raised or not. More...
 
virtual bool launcherRaised () const
 Get whether entity has launcher raised or not. More...
 
virtual void setLauncherFlashPresent (bool onOff)
 Set whether launcher flash is present or not. More...
 
virtual bool launcherFlashPresent () const
 Get whether launcher flash is present or not. More...
 
virtual void setPrimaryWeaponState (DtWeaponState s)
 Set primary weapon deployment state. More...
 
virtual DtWeaponState primaryWeaponState () const
 Get primary weapon deployment state. More...
 
virtual void setSecondaryWeaponState (DtWeaponState s)
 Set secondary weapon deployment state. More...
 
virtual DtWeaponState secondaryWeaponState () const
 Get secondary weapon deployment state. More...
 
virtual void setComplianceState (DtComplianceState s)
 Set life form compliance state. More...
 
virtual DtComplianceState complianceState () const
 Get life form compliance state. More...
 
virtual void setAntennaRaised (bool upDown)
 Set Antenna Raised status. More...
 
virtual bool antennaRaised () const
 Get Antenna Raised status. More...
 
virtual void setMissionKill (bool yesNo)
 Set Mission Kill status. More...
 
virtual bool missionKill () const
 Get Mission Kill status. More...
 
virtual void setInternalHeatSource (bool onOff)
 Set internal Heat Source status. More...
 
virtual bool internalHeatSource () const
 Get internal Heat Source status. More...
 
virtual void setMaskedCloaked (bool onOff)
 Set masked/cloaked appearance bit (introduced in DIS enums 2005 doc). More...
 
virtual bool maskedCloaked () const
 Get masked/cloaked appearance bit (introduced in DIS enums 2005 doc). More...
 
Articulated parts list accessors.
virtual const
DtArticulatedPartCollection
artPartList () const
 
virtual
DtArticulatedPartCollection
artPartList ()
 
Attached parts list accessors.
virtual const
DtAttachedPartCollection
attPartList () const
 
virtual DtAttachedPartCollectionattPartList ()
 
Variable parameter list accessors.

This does not include articulated parts even though those are technically also VPs.

Only available in DIS version 7 or higher.

virtual const std::vector
< DtVPRecord * > * 
variableParameterList () const
 
virtual std::vector
< DtVPRecord * > * 
variableParameterList ()
 
DI GUY attribute extensions.

In HLA 2010 going forward, the extensions are conveyed through a separate DIGuyObject instance.

virtual void setEntityId (const DtEntityIdentifier &id)
 Set the entity's identifier. More...
 
virtual void setDiGuyStateRepository (DtDIGuyObjectStateRepository *diGuyStateRep)
 Set the DIGuy state repository containing the DIGuy attribute extensions. More...
 
virtual const
DtDIGuyObjectStateRepository
diGuyStateRepository () const
 Get the DIGuy state repository containing the DIGuy attribute extensions. More...
 
virtual
DtDIGuyObjectStateRepository
diGuyStateRepository ()
 Set the entity's identifier. More...
 
virtual void enableDiGuyObject (bool enable=true)
 Enable the creation and use of the DIGuy object. More...
 
virtual bool isEnabledDiGuyObject ()
 Signals if we will be using the DIGuy object. More...
 
virtual void setDiGuyAppearance (const DtString &val)
 Set the DIGuy appearance (body appearance in DI-Guy 13 or later). More...
 
virtual const DtStringdiGuyAppearance () const
 Get the DIGuy appearance (body appearance in DI-Guy 13 or later). More...
 
virtual void setDiGuyArc (const std::vector< char > &val)
 Set the DIGuy appearance (not supported in DI-Guy 13 and later). More...
 
virtual const std::vector< char > & diGuyArc () const
 Get the DIGuy appearance (not supported in DI-Guy 13 and later). More...
 
virtual void setDiGuyParent (const DtEntityIdentifier &val)
 Set the DIGuy parent (not supported in DI-Guy 13 and later). More...
 
virtual const DtEntityIdentifierdiGuyParent () const
 Get the DIGuy parent (not supported in DI-Guy 13 and later). More...
 
virtual void setDiGuyType (const DtString &newDiGuyType, const DtString &newDiGuyAppearance)
 Set/Get the DIGuy type. More...
 
virtual void setDiGuyType (const DtString &val)
 Set the entity's identifier. More...
 
virtual const DtStringdiGuyType () const
 Get the DIGuy type. More...
 
virtual void setDiGuyBodyAppearance (const DtString &val)
 Set the DIGuy body appearance (only supported in DI-Guy 13 and later). More...
 
virtual const DtStringdiGuyBodyAppearance () const
 Get the DIGuy body appearance (only supported in DI-Guy 13 and later). More...
 
virtual void setDiGuyBodyWeight (double val)
 Set the DIGuy body weight. More...
 
virtual double diGuyBodyWeight () const
 Get the DIGuy body weight. More...
 
virtual void setDiGuyHeadAppearance (const DtString &val)
 Set the DIGuy head appearance (only supported in DI-Guy 13 and later). More...
 
virtual const DtStringdiGuyHeadAppearance () const
 Get the DIGuy head appearance (only supported in DI-Guy 13 and later). More...
 
virtual void setDiGuyItemAppearance (const DtString &val)
 Set the DIGuy item appearance (only supported in DI-Guy 13 and later). More...
 
virtual const DtStringdiGuyItemAppearance () const
 Get the DIGuy item appearance (only supported in DI-Guy 13 and later). More...
 
virtual bool setDiGuyAccessoryAppearance (unsigned int index, const DtString &val)
 Set the DIGuy accessory appearance (only supported in DI-Guy 13 and later). More...
 
virtual const DtStringdiGuyAccessoryAppearance (unsigned int index) const
 Get the DIGuy accessory appearance (only supported in DI-Guy 13 and later). More...
 
virtual void setDiGuyAccessoryAppearanceCount (unsigned int index)
 Set the DIGuy accessory appearance count (only supported in DI-Guy 13 and later). More...
 
virtual unsigned int diGuyAccessoryAppearanceCount () const
 Get the DIGuy accessory appearance count (only supported in DI-Guy 13 and later). More...
 
virtual void setDiGuyAction (const DtString &val)
 Set the DIGuy action. More...
 
virtual void setDiGuyAction (const DtString &val, bool paused, double speed=0.0, bool useActionPositioning=false, const DtVector &offset=DtVector(0, 0, 0), double transitionSpeed=1.0)
 Set the DIGuy action, paused state, and speed with optional offset, useActionPositioning flag, and transition speed for the action. More...
 
virtual const DtStringdiGuyAction () const
 Get the DIGuy action. More...
 
virtual const DtStringdiGuyAction (bool &paused) const
 Get the DIGuy action and paused status. More...
 
virtual void setDiGuyActionPaused (bool paused)
 Set DIGuy action paused. More...
 
virtual bool isDiGuyActionPaused () const
 Get DIGuy action paused. More...
 
virtual void setDiGuyActionSpeed (double speed)
 Set DIGuy action speed. More...
 
virtual double diGuyActionSpeed () const
 Get DIGuy action speed. More...
 
virtual void setDiGuyVisible (bool visibile)
 Set DIGuy visible status (only supported in DI-Guy 13 and later). More...
 
virtual bool isDiGuyVisible () const
 Get DIGuy visible status (only supported in DI-Guy 13 and later). More...
 
virtual void setDiGuyCharacterScale (const DtVector &scale)
 Set DIGuy character scale (only supported in DI-Guy 13 and later). More...
 
virtual const DtVectordiGuyCharacterScale () const
 Get DIGuy character scale (only supported in DI-Guy 13 and later). More...
 
DIGuy shape variation modifiers and accessors.

Only supported in DI-Guy 13 and later.

virtual void addDiGuyShapeVariation (unsigned int linkIndex, unsigned int shapeIndex, const DtDiGuyPixelData &pixelData)
 
virtual void removeDiGuyShapeVariation (unsigned int linkIndex, unsigned int shapeIndex)
 
virtual const DtDiGuyPixelDatadiGuyShapeVariation (unsigned int linkIndex, unsigned int shapeIndex, bool &dataIsValid) const
 
virtual bool getDiGuyShapeVariation (unsigned int linkIndex, unsigned int shapeIndex, DtDiGuyPixelData &pixelData) const
 
virtual void setDiGuyShapeVariations (const DtDiGuyLinkShapeMap &shapeVariations)
 
virtual const DtDiGuyLinkShapeMapdiGuyShapeVariations () const
 
DIGuy patches modifiers and accessors

Only supported in DI-Guy 13.4.1 and later

virtual void setDiGuyUnit (const DtPatchIdentifier &patchId)
 
virtual const DtPatchIdentifierdiGuyUnit () const
 
virtual void setDiGuyPersonalUnit (const DtPatchIdentifier &patchId)
 
virtual const DtPatchIdentifierdiGuyPersonalUnit () const
 
virtual void setDiGuyRank (const DtPatchIdentifier &patchId)
 
virtual const DtPatchIdentifierdiGuyRank () const
 
virtual void setDiGuyName (const DtString &val)
 
virtual const DtStringdiGuyName () const
 
- Public Member Functions inherited from DtBaseEntityStateRepository
 DtBaseEntityStateRepository ()
 default constructor More...
 
virtual ~DtBaseEntityStateRepository ()
 destructor More...
 
 DtBaseEntityStateRepository (const DtBaseEntityStateRepository &orig)
 copy constructor More...
 
DtBaseEntityStateRepositoryoperator= (const DtBaseEntityStateRepository &orig)
 assignment operator More...
 
void setTimeStampType (DtTimeStampType type)
 Set/Get flag indicating whether we're using absolute timestamps for dead reckoning. More...
 
DtTimeStampType timeStampType () const
 
virtual void setDisObjectManager (DtDisObjectManager *mgr)
 Set the HLA/DIS object manager. More...
 
virtual void setAmAsSeenByRemote (bool val)
 Mark this state repository as an AsSeenByRemote copy. More...
 
virtual const DtDcmbodyToGeoc (DtTime aTime) const
 Get the body to geocentric coordinate matrix. More...
 
virtual const DtDcmbodyToGeoc () const
 Get the body to geocentric coordinate matrix. More...
 
virtual const DtDcmrelativeBodyToHost (DtTime aTime) const
 Get the body to host DCM. More...
 
virtual const DtDcmrelativeBodyToHost () const
 Get the body to host DCM. More...
 
virtual const DtEntityIdentifierentityId () const
 The entity's identifier. More...
 
virtual void setEntityType (const DtEntityType &type)
 Set the entity type. More...
 
virtual const DtEntityTypeentityType () const
 The entity type. More...
 
virtual void useDeadReckoner (DtDeadReckoner *dr)
 Tells the DtBaseEntity to use dr as its DtApproximator, and to notify it when DR algorithm changes. More...
 
virtual void useRelativeDeadReckoner (DtDeadReckoner *dr)
 Tells the DtBaseEntity to use dr as its DtApproximator, and to notify it when DR algorithm changes. More...
 
virtual void useDeadReckoner (bool yesNo=true)
 Create and use a new (private) dead-reckoner as our approximator. More...
 
virtual void useRelativeDeadReckoner (bool yesNo=true)
 Create and use a new (private) dead-reckoner as our approximator. More...
 
virtual DtDeadReckonerusingDeadReckoner ()
 If the ESR is using a dead reckoner, returns it. Else returns NULL. More...
 
virtual DtDeadReckonerusingRelativeDeadReckoner ()
 If the ESR is using a dead reckoner, returns it. Else returns NULL. More...
 
virtual void useSmoother (DtSmoother *sm)
 Tells the ESR to use sm as its approximator, and to notify it when DR algorithm changes. More...
 
virtual void useRelativeSmoother (DtSmoother *sm)
 Tells the ESR to use sm as its approximator, and to notify it when DR algorithm changes. More...
 
virtual void useSmoother (bool yesNo=true)
 Create and use a new (private) smoother as our approximator. More...
 
virtual void useRelativeSmoother (bool yesNo=true)
 Create and use a new (private) smoother as our approximator. More...
 
virtual DtSmootherusingSmoother ()
 If the ESR is using a smoother, returns it. Else returns NULL. More...
 
virtual DtSmootherusingRelativeSmoother ()
 If the ESR is using a smoother, returns it. Else returns NULL. More...
 
virtual DtThresholderthresholder ()
 Returns the SR's thresholder, which contains thresholds needed for encoding. More...
 
virtual const DtThresholderthresholder () const
 Returns a const reference the SR's thresholder, which contains thresholds needed for encoding. More...
 
virtual DtClockclock () const
 The clock being used for dead reckoning calculations. More...
 
virtual void setTimeForSets (DtTime time)
 
virtual DtTime timeForSets () const
 
void computeSpatialFromRelativeSpatial ()
 If this unit has a host, update the esr to reflect the current state of the host. More...
 
DtBaseEntityStateRepositoryhostEsr () const
 Returns null if there isn't a host. More...
 
virtual void setAll (const DtVector &loc, const DtVector32 &vel, const DtTaitBryan &ori, const DtVector32 &acc, const DtVector32 &rotVel, DtTime t)
 Coherently set all DR parameters, thus avoiding DR computations associated with a partial set. More...
 
virtual void setAll (const DtVector &loc, const DtVector32 &vel, const DtTaitBryan &ori, const DtVector32 &acc, const DtVector32 &rotVel)
 Coherently set all DR parameters, thus avoiding DR computations associated with a partial set. More...
 
virtual void setLocation (const DtVector &location, DtTime aTime)
 Set the location of the center of mass in geocentric world coordinates at aTime. More...
 
virtual void setLocation (const DtVector &location)
 Set the location of the center of mass in geocentric world coordinates at current simulation time, as set in clock()->simTime(). More...
 
virtual const DtVectorlocation (DtTime aTime) const
 The location in geocentric world coordinates at aTime. More...
 
virtual const DtVectorlocation () const
 The location in geocentric world coordinates at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtVectorlastSetLocation () const
 Return the value last passed to setLocation, regardless of whether we have an approximator. More...
 
virtual void setVelocity (const DtVector32 &Velocity, DtTime aTime)
 Set the velocity in meters per second at aTime. More...
 
virtual void setVelocity (const DtVector32 &Velocity)
 The velocity in meters per second at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtVector32velocity (DtTime aTime) const
 The velocity in meters per second at aTime. More...
 
virtual const DtVector32velocity () const
 The velocity at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtVector32lastSetVelocity () const
 Return the value last passed to setVelocity, regardless of whether we have an approximator. More...
 
virtual void setAcceleration (const DtVector32 &Acceleration, DtTime aTime)
 Sets the acceleration at aTime. More...
 
virtual void setAcceleration (const DtVector32 &Acceleration)
 Sets the acceleration at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtVector32acceleration (DtTime aTime) const
 Return the acceleration at aTime. More...
 
virtual const DtVector32acceleration () const
 The acceleration at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtVector32lastSetAcceleration () const
 The value last passed to setAcceleration, regardless of whether we have an approximator. More...
 
virtual void setOrientation (const DtTaitBryan &orient, DtTime aTime)
 Set the orientation at aTime. More...
 
virtual void setOrientation (const DtTaitBryan &orient)
 Set the orientation at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtTaitBryanorientation (DtTime aTime) const
 The orientation at the passed time. More...
 
virtual const DtTaitBryanorientation () const
 The orientation at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtTaitBryanlastSetOrientation () const
 The value last passed to setOrientation, regardless of whether we have an approximator. More...
 
virtual void setRotationalVelocity (const DtVector32 &BodyRates, DtTime aTime)
 Set the rotational velocity of an entity at aTime. More...
 
virtual void setRotationalVelocity (const DtVector32 &BodyRates)
 Set the rotational velocity of an entity at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtVector32rotationalVelocity (DtTime aTime) const
 The rotational velocity of an entity at aTime. More...
 
virtual const DtVector32rotationalVelocity () const
 The rotational velocity of an entity at the current simulation time, as set in clock()->simTime(). More...
 
virtual const DtVector32lastSetRotationalVelocity () const
 Return the value last passed to setRotationalVelocity, regardless of whether we have an approximator. More...
 
virtual void setAlgorithm (DtDeadReckonTypes alg)
 Set the dead reckoning algorithm. More...
 
virtual DtDeadReckonTypes algorithm () const
 The dead reckoning algorithm. More...
 
virtual void setRelativeLocation (const DtVector &location, DtTime aTime)
 Set the location of the center of mass in world coordinates at the given time. More...
 
virtual void setRelativeLocation (const DtVector &location)
 Set the location of the center of mass in world coordinates at the simTime as set by clock()->simTime(). More...
 
virtual const DtVectorrelativeLocation (DtTime aTime) const
 The relativeLocation of the entity with respect to the hostGlobalId() or "Host" at the given time. More...
 
virtual const DtVectorrelativeLocation () const
 The relativeLocation of the entity with respect to the hostGlobalId() or "Host" at simTime as set by clock()->simTime(). More...
 
virtual const DtVectorlastSetRelativeLocation () const
 Return the value last passed to setLocation, regardless of whether we have an approximator. More...
 
virtual void setRelativeVelocity (const DtVector32 &Velocity, DtTime aTime)
 Set the relative velocity of the entity in meters per second with respect to the host at aTime. More...
 
virtual void setRelativeVelocity (const DtVector32 &Velocity)
 Set the relative velocity of the entity in meters per second with respect to the host at simTime. More...
 
virtual const DtVector32relativeVelocity (DtTime aTime) const
 The relative velocity of the entity with respect to the host at aTime. More...
 
virtual const DtVector32relativeVelocity () const
 The relative velocity of the entity with respect to the host at simTime. More...
 
virtual const DtVector32lastSetRelativeVelocity () const
 Return the value last passed to setVelocity, regardless of whether we have an approximator. More...
 
virtual void setRelativeAcceleration (const DtVector32 &Acceleration, DtTime aTime)
 Set the relative acceleration of the entity with respect to the host at aTime. More...
 
virtual void setRelativeAcceleration (const DtVector32 &Acceleration)
 Set the relative acceleration of the entity with respect to the host at simTime. More...
 
virtual const DtVector32relativeAcceleration (DtTime aTime) const
 The relativeAcceleration of the entity with respect to the host at aTime. More...
 
virtual const DtVector32relativeAcceleration () const
 The relativeAcceleration of the entity with respect to the host at simTime. More...
 
virtual const DtVector32lastSetRelativeAcceleration () const
 Return the value last passed to setAcceleration, regardless of whether we have an approximator. More...
 
virtual void setRelativeOrientation (const DtTaitBryan &orient, DtTime aTime)
 Set the relative orientation of the entity with respect to the host. More...
 
virtual void setRelativeOrientation (const DtTaitBryan &orient)
 Set the relative orientation of the entity with respect to the host. More...
 
virtual const DtTaitBryanrelativeOrientation (DtTime aTime) const
 The relative orientation of the entity with respect to the host. More...
 
virtual const DtTaitBryanrelativeOrientation () const
 The relative orientation of the entity with respect to the host. More...
 
virtual const DtTaitBryanlastSetRelativeOrientation () const
 Return the value last passed to setOrientation, regardless of whether we have an approximator. More...
 
virtual void setRelativeRotationalVelocity (const DtVector32 &BodyRates, DtTime aTime)
 Set the relative rotational velocity. More...
 
virtual void setRelativeRotationalVelocity (const DtVector32 &BodyRates)
 Set the relative rotational velocity. More...
 
virtual const DtVector32relativeRotationalVelocity (DtTime aTime) const
 The relative rotational velocity. More...
 
virtual const DtVector32relativeRotationalVelocity () const
 The relative rotational velocity. More...
 
virtual const DtVector32lastSetRelativeRotationalVelocity () const
 Return the value last passed value to setRotationalVelocity, regardless of whether we have an approximator. More...
 
virtual void setRelativeFrozen (bool onOff)
 Set relative frozen. More...
 
virtual bool relativeFrozen () const
 Returns if the entity is frozen. More...
 
virtual void setRelativeAlgorithm (DtDeadReckonTypes alg)
 Set the dead reckoning algorithm. More...
 
virtual DtDeadReckonTypes relativeAlgorithm () const
 The dead reckoning algorithm. More...
 
virtual const
DtGlobalObjectDesignator
hostGlobalId () const
 Returns the globalID of the attached host. More...
 
virtual void setHostGlobalId (const DtGlobalObjectDesignator &id)
 Sets the globalId of the attached host. More...
 
virtual void clearHostGlobalId ()
 Unattaches this entity from its host. More...
 
virtual const DtNaturenature () const
 The nature of this entity to the host. More...
 
virtual void setNature (const DtNature newVal)
 Sets the nature of this entity to the host. More...
 
virtual const DtPositionpartPosition () const
 The Part Position this entity is preforming on the host. More...
 
virtual void setPartPosition (const DtPosition newVal)
 Sets the Part Position this entity is preforming on the host. More...
 
virtual const DtStationNamestationName () const
 The station name this entity is assigned to on the host. More...
 
virtual void setStationName (const DtStationName newVal)
 Sets the station name this entity is assigned to on the host. More...
 
virtual const DtU16stationNumber () const
 The station number this entity is assigned to on the host. More...
 
virtual void setStationNumber (const DtU16 newVal)
 Sets the station number this entity is assigned to on the host. More...
 
virtual const DtVectorrelativePosition () const
 The relative position on the host. More...
 
virtual void setRelativePosition (const DtVector &newVal)
 Set the relative position on the host. More...
 
virtual const DtFloat32range () const
 The range to the host. More...
 
virtual void setRange (const DtFloat32 newVal)
 Set the range to the host. More...
 
virtual const DtFloat32bearing () const
 The bearing to host. More...
 
virtual void setBearing (const DtFloat32 newVal)
 Set the bearing to host. More...
 
virtual void setApproximator (DtApproximator *approx)
 Get and set the approximator used to provide approximated position and orientation information for the entity. More...
 
virtual DtApproximatorapproximator () const
 Get and set the approximator used to provide approximated position and orientation information for the entity. More...
 
virtual void setRelativeApproximator (DtApproximator *approx)
 Get and set the approximator used to provide approximated position and orientation information for the entity. More...
 
virtual DtApproximatorrelativeApproximator () const
 Get and set the approximator used to provide approximated position and orientation information for the entity. More...
 
- Public Member Functions inherited from DtStateRepository
 DtStateRepository ()
 default constructor More...
 
 DtStateRepository (const DtStateRepository &orig)
 copy constructor More...
 
virtual ~DtStateRepository ()
 destructor More...
 
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator More...
 
virtual void setGlobalId (const DtGlobalObjectDesignator &id)
 Get/Set global identifier, or name. More...
 
virtual const
DtGlobalObjectDesignator
globalId () const
 
virtual unsigned int numberOfAttributeRecords () const
 
virtual void setAttributeRecords (const DtAttributeRecordSet &records)
 The following functions are related to the extendability part of DIS 7. More...
 
virtual void setAttributeRecords (const DtStandardVariableRecordPtrVector &records)
 Replace the attribute record set with the records in the given vector. More...
 
virtual const
DtAttributeRecordSet
attributeRecordSet () const
 Return the attribute record set. More...
 
virtual DtAttributeRecordSetattributeRecordSet ()
 Return the attribute record set. More...
 
virtual const
DtStandardVariableRecordPtrVector
attributeRecords () const
 Return the attribute records Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual const
DtStandardVariableRecordPtrVector
attributeRecords (unsigned int recordType) const
 Return the attribute records of the given type (all records if type is 0) Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual DtStandardVariableRecordattributeRecord (unsigned int recordType) const
 Return the (first) attribute record of the given type (first record if type is 0) Any changes to the returned record will modify the record in the recordSet. More...
 
virtual int removeAttributeRecord (unsigned int recordType, bool removeAll=true)
 Remove and discard the first record of the given record type (if there is one) or all them. More...
 
virtual
DtStandardVariableRecordPtrVector
getAttributeRecords (unsigned int recordType, DtStandardVariableRecordPtrVector &vec) const
 Get the attribute records of the given type (all if type is 0) Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual
DtStandardVariableRecordPtrVector
getAttributeRecords (DtStandardVariableRecordPtrVector &vec) const
 Get the attribute records Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual void addAttributeRecord (DtStandardVariableRecord *record)
 Add a clone of given record to the attribute record set. More...
 
virtual void addAttributeRecord (std::auto_ptr< DtStandardVariableRecord > record)
 Add the given record to the attribute record set. More...
 
virtual void clearAttributeRecords ()
 Clear all records. More...
 
virtual
DtStateRepositoryExtension
stateRepositoryExtension (DtString srExtName) const
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 
virtual std::vector< DtStringstateRepositoryExtensionNames () const
 Returns a set of the registered state repository extension names. More...
 
virtual void setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 
virtual const std::map
< DtString,
DtStateRepositoryExtension * > 
stateRepositoryExtensions () const
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 

Static Public Member Functions

static DtEntityStateRepositorycreate ()
 Static create method. More...
 
- Static Public Member Functions inherited from DtBaseEntityStateRepository
static void setDefaultDeadReckoner (DtDeadReckoner *val)
 Static variable that sets the default dead reckoner if none is chosen. More...
 
static void setDefaultSmoother (DtSmoother *val)
 Static variable that sets the default smoother if none is chosen. By default this is DtSmoother. More...
 
static void setDefaultRelativeDeadReckoner (DtDeadReckoner *val)
 Static variable that sets the default relative dead reckoner if none is chosen. More...
 
static void setDefaultRelativeSmoother (DtSmoother *val)
 Static variable that sets the default relative smoother if none is chosen. More...
 
- Static Public Member Functions inherited from DtStateRepository
static bool addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
 The following functions are for extending state repositories through State Repository Extension classes. More...
 

Protected Member Functions

DtEntityStateRepositoryself () const
 Cast off const-ness for trivial internal change. More...
 
void internalSetMarkingText (const char *text)
 Set the marking text. More...
 
virtual void createDiGuyStateRep ()
 Create a DIGuy SR when needed. More...
 
- Protected Member Functions inherited from DtBaseEntityStateRepository
DtBaseEntityStateRepositoryself () const
 Cast off const-ness for trivial internal change. More...
 

Protected Attributes

DtArticulatedPartCollection myArtPartList
 
DtAttachedPartCollection myAttPartList
 
std::vector< DtVPRecord * > myVPRecordCollection
 
DtForceType myForceId
 
DtEntityType myGuise
 
DtU32 myAppearance
 
int myMarkingCharSet
 The char set used for marking text. Defaults to 1. More...
 
DtString myMarkingText
 myMarkingText is an array of theMaxMarkingSize. More...
 
DtU32 myCapabilities
 
DtU16 myLiveEntityMeasuredSpeed
 
DtU16 myAcousticsSignatureIndex
 
DtU16 myInfaredSignatureIndex
 
DtU16 myRadarCrossSectionSignatureIndex
 
int myNumPropulsionSystemsData
 
int myNumVectoringNozzleSystemData
 
DtPropulsionSystemmyPropulsionSystemsDataList
 
DtVectoringNozzleSystemmyVectoringNozzleSystemDataList
 
std::vector< char > myDiGuyArc
 Legacy DIGuy extension attributes. More...
 
DtEntityIdentifier myDiGuyParent
 
DtDIGuyObjectStateRepositorymyDiGuyStateRep
 
bool myUseDiGuyObject
 
- Protected Attributes inherited from DtBaseEntityStateRepository
DtClockmyClock
 Clock to be used for dead reckoning calculations – it is set to the same clock used by the exConn. More...
 
DtApproximatormyApproximator
 Holds what's currently being used as our approximator. More...
 
DtApproximatormyRelativeApproximator
 
DtDeadReckonermyDeadReckoner
 Holds what was most recently passed to useDeadReckoner. More...
 
DtDeadReckonermyRelativeDeadReckoner
 
DtSmoothermySmoother
 Holds what was most recently passed to useSmoother. More...
 
DtSmoothermyRelativeSmoother
 
DtVector myLocation
 spatial attributes More...
 
DtVector32 myVelocity
 
DtVector32 myAcceleration
 
DtTaitBryan myOrientation
 
DtVector32 myRotationalVelocity
 
DtDeadReckonTypes myAlgorithm
 
bool myFrozen
 
DtVector myRelativeLocation
 relativeSpatial attributes More...
 
DtVector32 myRelativeVelocity
 
DtVector32 myRelativeAcceleration
 
DtTaitBryan myRelativeOrientation
 
DtVector32 myRelativeRotationalVelocity
 
DtDeadReckonTypes myRelativeAlgorithm
 
bool myRelativeFrozen
 
DtGlobalObjectDesignator myHostGlobalId
 isPartOf attributes Never set myHostGlobalId outside of the mutator function setHostGlobalId() this will invalidate myHostGlobalIdSetFlag which is used to determine if myHostGlobalId is valid, when it contains a 0:0:0 entityID. More...
 
bool myHostGlobalIdSetFlag
 
DtNature myNature
 
DtPosition myPartPosition
 
DtStationName myStationName
 
DtU16 myStationNumber
 
DtVector myRelativePosition
 
DtFloat32 myRange
 
DtFloat32 myBearing
 
DtDisObjectManagermyObjectManager
 others More...
 
bool myAmAsSeenByRemote
 This flag is checked by the spatial attribute accessors and if it's false, calls computeSpatialFromRelativeSpatial() More...
 
DtVector myLastSetLocation
 place holder variables for spatial data. More...
 
DtVector32 myLastSetVelocity
 
DtVector32 myLastSetAcceleration
 
DtTaitBryan myLastSetOrientation
 
DtVector32 myLastSetRotationalVelocity
 
DtVector myLastSetRelativeLocation
 place holder variables for relative spatial data. More...
 
DtVector32 myLastSetRelativeVelocity
 
DtVector32 myLastSetRelativeAcceleration
 
DtTaitBryan myLastSetRelativeOrientation
 
DtVector32 myLastSetRelativeRotationalVelocity
 
DtDcm myBodyToGeoc
 
bool myBodyToGeocDirty
 
DtDcm myRelativeBodyToHost
 
bool myRelativeBodyToHostDirty
 
DtTimeStampType myTimeStampType
 
DtEntityIdentifier myEntityId
 
DtEntityType myEntityType
 
DtThresholder myThresholder
 
DtTime myTimeForSets
 

Additional Inherited Members

- Public Types inherited from DtStateRepository
typedef std::map< DtString,
DtStateRepositoryExtension * > 
DtStateRepositoryExtensionMap
 
- Public Attributes inherited from DtStateRepository
DtGlobalObjectDesignator myGlobalId
 
DtAttributeRecordSet myAttributeRecords
 
DtStandardVariableRecordPtrVector myReturnedRecords
 
DtStateRepositoryExtensionMap myStateRepositoryExtensionMap
 
- Static Public Attributes inherited from DtStateRepository
static std::map< DtString,
DtSrExtCreatorFnc
theStateRepositoryExtensionCreatorMap
 
- Static Protected Attributes inherited from DtBaseEntityStateRepository
static DtDeadReckonertheDfltDeadReckoner
 Static defaults. More...
 
static DtSmoothertheDfltSmoother
 
static DtDeadReckonertheDfltRelativeDeadReckoner
 
static DtSmoothertheDfltRelativeSmoother
 

Detailed Description

Instances of DtEntityStateRepository are used to maintain attributes and state of entity objects in a protocol independent way.

It provides a fat interface which covers various types of entities. As a result, individual fields may not apply depending on the type of entity. TSPI information is found in the parent class DtBaseEntityStateRepository.

Examples

Constructor & Destructor Documentation

DtEntityStateRepository::DtEntityStateRepository ( )

Default CTOR.

DtEntityStateRepository::DtEntityStateRepository ( const DtEntityStateRepository orig)

Copy CTOR.

virtual DtEntityStateRepository::~DtEntityStateRepository ( )
virtual

Virtual DTOR.

Member Function Documentation

DtU16 DtEntityStateRepository::acousticSigRepIndex ( ) const
inlinevirtual

Get acoustic signature representation index.

References myAcousticsSignatureIndex.

virtual void DtEntityStateRepository::addDiGuyShapeVariation ( unsigned int  linkIndex,
unsigned int  shapeIndex,
const DtDiGuyPixelData pixelData 
)
virtual
virtual bool DtEntityStateRepository::afterburnerOn ( ) const
virtual

Get whether entity has after burner on or not.

virtual bool DtEntityStateRepository::antennaRaised ( ) const
virtual

Get Antenna Raised status.

virtual DtU32 DtEntityStateRepository::appearance ( ) const
virtual

Return the appearance bit field, use this with care.

This is an alternate method of getting individual appearance settings.

virtual DtAppearAttrVal DtEntityStateRepository::appearanceAttribute ( const DtAppearAttribute  attr) const
virtual

Get an appearance attribute.

attr is the appearance bitfield mask val is the hex number to be or'ed in.

const DtArticulatedPartCollection * DtEntityStateRepository::artPartList ( ) const
inlinevirtual

References myArtPartList.

DtArticulatedPartCollection * DtEntityStateRepository::artPartList ( )
inlinevirtual

References myArtPartList.

const DtAttachedPartCollection * DtEntityStateRepository::attPartList ( ) const
inlinevirtual

References myAttPartList.

DtAttachedPartCollection * DtEntityStateRepository::attPartList ( )
inlinevirtual

References myAttPartList.

virtual DtCamouflageType DtEntityStateRepository::camouflageType ( ) const
virtual

Get camouflage type.

DtU32 DtEntityStateRepository::capabilities ( ) const
inlinevirtual

Get the capabilities field.

References myCapabilities.

virtual DtStateRepository* DtEntityStateRepository::clone ( bool  copy = false) const
virtual

Return a copy/empty object of the same type as this.

Reimplemented from DtBaseEntityStateRepository.

virtual DtComplianceState DtEntityStateRepository::complianceState ( ) const
virtual

Get life form compliance state.

static DtEntityStateRepository* DtEntityStateRepository::create ( )
static

Static create method.

virtual void DtEntityStateRepository::createDiGuyStateRep ( )
protectedvirtual

Create a DIGuy SR when needed.

virtual DtDamageState DtEntityStateRepository::damageState ( ) const
virtual

Get the damage state.

virtual DtDensityType DtEntityStateRepository::density ( ) const
virtual

Get density state of entity (Environment entities).

virtual const DtString& DtEntityStateRepository::diGuyAccessoryAppearance ( unsigned int  index) const
virtual

Get the DIGuy accessory appearance (only supported in DI-Guy 13 and later).

virtual unsigned int DtEntityStateRepository::diGuyAccessoryAppearanceCount ( ) const
virtual

Get the DIGuy accessory appearance count (only supported in DI-Guy 13 and later).

virtual const DtString& DtEntityStateRepository::diGuyAction ( ) const
virtual

Get the DIGuy action.

virtual const DtString& DtEntityStateRepository::diGuyAction ( bool paused) const
virtual

Get the DIGuy action and paused status.

virtual double DtEntityStateRepository::diGuyActionSpeed ( ) const
virtual

Get DIGuy action speed.

virtual const DtString& DtEntityStateRepository::diGuyAppearance ( ) const
virtual

Get the DIGuy appearance (body appearance in DI-Guy 13 or later).

virtual const std::vector<char>& DtEntityStateRepository::diGuyArc ( ) const
virtual

Get the DIGuy appearance (not supported in DI-Guy 13 and later).

virtual const DtString& DtEntityStateRepository::diGuyBodyAppearance ( ) const
virtual

Get the DIGuy body appearance (only supported in DI-Guy 13 and later).

virtual double DtEntityStateRepository::diGuyBodyWeight ( ) const
virtual

Get the DIGuy body weight.

virtual const DtVector& DtEntityStateRepository::diGuyCharacterScale ( ) const
virtual

Get DIGuy character scale (only supported in DI-Guy 13 and later).

virtual const DtString& DtEntityStateRepository::diGuyHeadAppearance ( ) const
virtual

Get the DIGuy head appearance (only supported in DI-Guy 13 and later).

virtual const DtString& DtEntityStateRepository::diGuyItemAppearance ( ) const
virtual

Get the DIGuy item appearance (only supported in DI-Guy 13 and later).

virtual const DtString& DtEntityStateRepository::diGuyName ( ) const
virtual
virtual const DtEntityIdentifier& DtEntityStateRepository::diGuyParent ( ) const
virtual

Get the DIGuy parent (not supported in DI-Guy 13 and later).

virtual const DtPatchIdentifier& DtEntityStateRepository::diGuyPersonalUnit ( ) const
virtual
virtual const DtPatchIdentifier& DtEntityStateRepository::diGuyRank ( ) const
virtual
virtual const DtDiGuyPixelData& DtEntityStateRepository::diGuyShapeVariation ( unsigned int  linkIndex,
unsigned int  shapeIndex,
bool dataIsValid 
) const
virtual
virtual const DtDiGuyLinkShapeMap& DtEntityStateRepository::diGuyShapeVariations ( ) const
virtual
virtual const DtDIGuyObjectStateRepository* DtEntityStateRepository::diGuyStateRepository ( ) const
virtual

Get the DIGuy state repository containing the DIGuy attribute extensions.

virtual DtDIGuyObjectStateRepository* DtEntityStateRepository::diGuyStateRepository ( )
virtual

Set the entity's identifier.

Overridden to pass the ID to the DIGuy SR.

virtual const DtString& DtEntityStateRepository::diGuyType ( ) const
virtual

Get the DIGuy type.

virtual const DtPatchIdentifier& DtEntityStateRepository::diGuyUnit ( ) const
virtual
virtual void DtEntityStateRepository::enableDiGuyObject ( bool  enable = true)
virtual

Enable the creation and use of the DIGuy object.

The alternative is for the DIGuy information to be integrated into the entity object

virtual bool DtEntityStateRepository::engineSmokeOn ( ) const
virtual

Get whether engine smoke is on or not.

virtual bool DtEntityStateRepository::firePowerDisabled ( ) const
virtual

Get whether entity is fire power disabled or not.

virtual bool DtEntityStateRepository::flamesPresent ( ) const
virtual

Get whether flames are present or not.

DtForceType DtEntityStateRepository::forceId ( ) const
inlinevirtual

Get the force type.

References myForceId.

virtual bool DtEntityStateRepository::frozen ( ) const
virtual

Get the frozen state of the entity.

Reimplemented from DtBaseEntityStateRepository.

virtual bool DtEntityStateRepository::getDiGuyShapeVariation ( unsigned int  linkIndex,
unsigned int  shapeIndex,
DtDiGuyPixelData pixelData 
) const
virtual
bool DtEntityStateRepository::getNozzleSystem ( int  index,
DtVectoringNozzleSystem record 
) const

Get a vectoring nozzle system data record (Non-virtual - Used in CTOR).

Returns false if the record does not exist.

bool DtEntityStateRepository::getPropulsionSystem ( int  index,
DtPropulsionSystem record 
) const

Get a propulsion system data record (Non-virtual - Used in CTOR).

Returns false if the record does not exist.

const DtEntityType & DtEntityStateRepository::guise ( ) const
inlinevirtual

Get the alternate entity type or guise.

References myGuise.

virtual bool DtEntityStateRepository::hasAmmunitionSupplyCap ( ) const
virtual

Get whether entity has ammunition supply capability or not.

virtual bool DtEntityStateRepository::hasFuelSupplyCap ( ) const
virtual

Get whether entity has fuel supplying capability.

virtual bool DtEntityStateRepository::hasRecoveryCap ( ) const
virtual

Get whether entity has recovery capability.

virtual bool DtEntityStateRepository::hasRepairCap ( ) const
virtual

Get whether entity has repair capability.

virtual DtHatchState DtEntityStateRepository::hatchState ( ) const
virtual

Get the entity's hatch state.

virtual bool DtEntityStateRepository::immobilized ( ) const
virtual

Get whether the entity is immobilized or not.

DtU16 DtEntityStateRepository::infraRedSigRepIndex ( ) const
inlinevirtual

Get infra-red signature representation index.

References myInfaredSignatureIndex.

virtual bool DtEntityStateRepository::internalHeatSource ( ) const
virtual

Get internal Heat Source status.

void DtEntityStateRepository::internalSetMarkingText ( const char *  text)
inlineprotected

Set the marking text.

Non-virtual since meant to be used by constructor.

References myMarkingText.

Referenced by setMarkingText().

virtual bool DtEntityStateRepository::isConcealed ( ) const
virtual

Get whether entity is concealed or not.

virtual bool DtEntityStateRepository::isDiGuyActionPaused ( ) const
virtual

Get DIGuy action paused.

virtual bool DtEntityStateRepository::isDiGuyVisible ( ) const
virtual

Get DIGuy visible status (only supported in DI-Guy 13 and later).

virtual bool DtEntityStateRepository::isEnabledDiGuyObject ( )
virtual

Signals if we will be using the DIGuy object.

The alternative is for the DIGuy information to be integrated into the entity object

virtual bool DtEntityStateRepository::launcherFlashPresent ( ) const
virtual

Get whether launcher flash is present or not.

virtual bool DtEntityStateRepository::launcherRaised ( ) const
virtual

Get whether entity has launcher raised or not.

virtual DtLifeformState DtEntityStateRepository::lifeformState ( ) const
virtual

Get entity life form state.

In the RPR FOM this is called the Stance State.

virtual bool DtEntityStateRepository::lightState ( DtLightType  s) const
virtual

Get light state of entity.

virtual DtLightState DtEntityStateRepository::lightState ( ) const
virtual

Get light state of entity.

This is for <= vrlink3.4 compatibility.

int DtEntityStateRepository::markingCharSet ( ) const
inlinevirtual

The character set used for the marking.

References myMarkingCharSet.

const char * DtEntityStateRepository::markingText ( ) const
inlinevirtual

Get the marking text attribute.

This is typically used as the vehicle bumper number, though some applications may use it as a unique identifier.

References DtString::c_str(), and myMarkingText.

virtual bool DtEntityStateRepository::maskedCloaked ( ) const
virtual

Get masked/cloaked appearance bit (introduced in DIS enums 2005 doc).

DtU16 DtEntityStateRepository::measuredSpeed ( ) const
inlinevirtual

Get measured speed.

References myLiveEntityMeasuredSpeed.

virtual bool DtEntityStateRepository::missionKill ( ) const
virtual

Get Mission Kill status.

DtU16 DtEntityStateRepository::numNozzleSystems ( ) const

Get number of nozzle systems (Non-virtual - Used in CTOR).

DtU16 DtEntityStateRepository::numPropulsionSystems ( ) const

Get number of propulsion systems (Non-virtual - Used in CTOR).

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

Assignment operator.

virtual bool DtEntityStateRepository::powerPlantOn ( ) const
virtual

Get whether entity's power plant is on or not.

virtual DtWeaponState DtEntityStateRepository::primaryWeaponState ( ) const
virtual

Get primary weapon deployment state.

virtual void DtEntityStateRepository::printData ( ) const
virtual

Print the state data to the DtInfo stream.

Reimplemented from DtBaseEntityStateRepository.

virtual void DtEntityStateRepository::printDataToStream ( std::ostream &  stream) const
virtual

prints the state data to the specified stream.

Reimplemented from DtBaseEntityStateRepository.

DtU16 DtEntityStateRepository::radarSigRepIndex ( ) const
inlinevirtual

Get radar signature representation index.

References myRadarCrossSectionSignatureIndex.

virtual bool DtEntityStateRepository::rampDeployed ( ) const
virtual

Get whether entity has ramp deployed or not.

virtual void DtEntityStateRepository::removeDiGuyShapeVariation ( unsigned int  linkIndex,
unsigned int  shapeIndex 
)
virtual
virtual DtWeaponState DtEntityStateRepository::secondaryWeaponState ( ) const
virtual

Get secondary weapon deployment state.

DtEntityStateRepository * DtEntityStateRepository::self ( ) const
inlineprotected

Cast off const-ness for trivial internal change.

Non-virtual since can't override on return type.

void DtEntityStateRepository::setAcousticSigRepIndex ( DtU16  value)
inlinevirtual

Set acoustic signature representation index.

References myAcousticsSignatureIndex.

virtual void DtEntityStateRepository::setAfterburnerOn ( bool  onOff)
virtual

Set whether entity has after burner on or not.

virtual void DtEntityStateRepository::setAntennaRaised ( bool  upDown)
virtual

Set Antenna Raised status.

virtual void DtEntityStateRepository::setAppearance ( DtU32  app)
virtual

Set the appearance bit field, use with care.

This is an alternate method of setting individual appearance settings.

virtual void DtEntityStateRepository::setAppearanceAttribute ( const DtAppearAttribute  attr,
const DtAppearAttrVal  val 
)
virtual

Set an appearance attribute.

attr is the appearance bitfield mask val is the hex number to be or'ed in.

virtual void DtEntityStateRepository::setCamouflageType ( DtCamouflageType  type)
virtual

Set camouflage type.

void DtEntityStateRepository::setCapabilities ( DtU32  cap)
inlinevirtual

Set the capabilities field.

References myCapabilities.

virtual void DtEntityStateRepository::setClock ( DtClock clock)
virtual

Overrides DtBaseEntityStateRepository's setClock method.

Reimplemented from DtBaseEntityStateRepository.

virtual void DtEntityStateRepository::setComplianceState ( DtComplianceState  s)
virtual

Set life form compliance state.

virtual void DtEntityStateRepository::setDamageState ( DtDamageState  s)
virtual

Set the damage state.

virtual void DtEntityStateRepository::setDensity ( DtDensityType  dens)
virtual

Set density state of entity (Environment entities).

virtual bool DtEntityStateRepository::setDiGuyAccessoryAppearance ( unsigned int  index,
const DtString val 
)
virtual

Set the DIGuy accessory appearance (only supported in DI-Guy 13 and later).

If the index is larger than the count, this will do nothing and return false.

virtual void DtEntityStateRepository::setDiGuyAccessoryAppearanceCount ( unsigned int  index)
virtual

Set the DIGuy accessory appearance count (only supported in DI-Guy 13 and later).

virtual void DtEntityStateRepository::setDiGuyAction ( const DtString val)
virtual

Set the DIGuy action.

virtual void DtEntityStateRepository::setDiGuyAction ( const DtString val,
bool  paused,
double  speed = 0.0,
bool  useActionPositioning = false,
const DtVector offset = DtVector(0, 0, 0),
double  transitionSpeed = 1.0 
)
virtual

Set the DIGuy action, paused state, and speed with optional offset, useActionPositioning flag, and transition speed for the action.

virtual void DtEntityStateRepository::setDiGuyActionPaused ( bool  paused)
virtual

Set DIGuy action paused.

virtual void DtEntityStateRepository::setDiGuyActionSpeed ( double  speed)
virtual

Set DIGuy action speed.

virtual void DtEntityStateRepository::setDiGuyAppearance ( const DtString val)
virtual

Set the DIGuy appearance (body appearance in DI-Guy 13 or later).

virtual void DtEntityStateRepository::setDiGuyArc ( const std::vector< char > &  val)
virtual

Set the DIGuy appearance (not supported in DI-Guy 13 and later).

virtual void DtEntityStateRepository::setDiGuyBodyAppearance ( const DtString val)
virtual

Set the DIGuy body appearance (only supported in DI-Guy 13 and later).

virtual void DtEntityStateRepository::setDiGuyBodyWeight ( double  val)
virtual

Set the DIGuy body weight.

virtual void DtEntityStateRepository::setDiGuyCharacterScale ( const DtVector scale)
virtual

Set DIGuy character scale (only supported in DI-Guy 13 and later).

virtual void DtEntityStateRepository::setDiGuyHeadAppearance ( const DtString val)
virtual

Set the DIGuy head appearance (only supported in DI-Guy 13 and later).

virtual void DtEntityStateRepository::setDiGuyItemAppearance ( const DtString val)
virtual

Set the DIGuy item appearance (only supported in DI-Guy 13 and later).

virtual void DtEntityStateRepository::setDiGuyName ( const DtString val)
virtual
virtual void DtEntityStateRepository::setDiGuyParent ( const DtEntityIdentifier val)
virtual

Set the DIGuy parent (not supported in DI-Guy 13 and later).

virtual void DtEntityStateRepository::setDiGuyPersonalUnit ( const DtPatchIdentifier patchId)
virtual
virtual void DtEntityStateRepository::setDiGuyRank ( const DtPatchIdentifier patchId)
virtual
virtual void DtEntityStateRepository::setDiGuyShapeVariations ( const DtDiGuyLinkShapeMap shapeVariations)
virtual
virtual void DtEntityStateRepository::setDiGuyStateRepository ( DtDIGuyObjectStateRepository diGuyStateRep)
virtual

Set the DIGuy state repository containing the DIGuy attribute extensions.

Responsibility for the deleting the DIGuy SR is passed to this entity SR instance.

virtual void DtEntityStateRepository::setDiGuyType ( const DtString newDiGuyType,
const DtString newDiGuyAppearance 
)
virtual

Set/Get the DIGuy type.

When updating DiGuy type, it will typically make sense to also update the DiGuy Appearance. Prefer the setDiGuyType form that also updates appearance.

virtual void DtEntityStateRepository::setDiGuyType ( const DtString val)
virtual

Set the entity's identifier.

Overridden to pass the ID to the DIGuy SR.

virtual void DtEntityStateRepository::setDiGuyUnit ( const DtPatchIdentifier patchId)
virtual
virtual void DtEntityStateRepository::setDiGuyVisible ( bool  visibile)
virtual

Set DIGuy visible status (only supported in DI-Guy 13 and later).

virtual void DtEntityStateRepository::setEngineSmokeOn ( bool  onOff)
virtual

Set whether engine smoke is on or not.

virtual void DtEntityStateRepository::setEntityId ( const DtEntityIdentifier id)
virtual

Set the entity's identifier.

Overridden to pass the ID to the DIGuy SR.

Reimplemented from DtBaseEntityStateRepository.

virtual void DtEntityStateRepository::setFirePowerDisabled ( bool  onOff)
virtual

Set whether entity is fire power disabled or not.

virtual void DtEntityStateRepository::setFlamesPresent ( bool  onOff)
virtual

Set whether flames are present or not.

void DtEntityStateRepository::setForceId ( DtForceType  force)
inlinevirtual

Set the force type.

References myForceId.

virtual void DtEntityStateRepository::setFrozen ( bool  onOff)
virtual

Set the frozen state of the entity.

Reimplemented from DtBaseEntityStateRepository.

void DtEntityStateRepository::setGuise ( const DtEntityType type)
inlinevirtual

Set the alternate entity type or guise.

References myGuise.

virtual void DtEntityStateRepository::setHasAmmunitionSupplyCap ( bool  onOff)
virtual

Set whether entity has ammunition supply capability or not.

virtual void DtEntityStateRepository::setHasFuelSupplyCap ( bool  onOff)
virtual

Set whether entity has fuel supplying capability.

virtual void DtEntityStateRepository::setHasRecoveryCap ( bool  onOff)
virtual

Set whether entity has recovery capability.

virtual void DtEntityStateRepository::setHasRepairCap ( bool  onOff)
virtual

Set whether entity has repair capability.

virtual void DtEntityStateRepository::setHatchState ( DtHatchState  s)
virtual

Set the entity's hatch state.

virtual void DtEntityStateRepository::setImmobilized ( bool  onOff)
virtual

Set whether the entity is immobilized or not.

void DtEntityStateRepository::setInfraRedSigRepIndex ( DtU16  value)
inlinevirtual

Set infra-red signature representation index.

References myInfaredSignatureIndex.

virtual void DtEntityStateRepository::setInternalHeatSource ( bool  onOff)
virtual

Set internal Heat Source status.

virtual void DtEntityStateRepository::setIsConcealed ( bool  onOff)
virtual

Set whether entity is concealed or not.

virtual void DtEntityStateRepository::setLauncherFlashPresent ( bool  onOff)
virtual

Set whether launcher flash is present or not.

virtual void DtEntityStateRepository::setLauncherRaised ( bool  onOff)
virtual

Set whether entity has launcher raised or not.

virtual void DtEntityStateRepository::setLifeformState ( DtLifeformState  s)
virtual

Set entity life form state.

In the RPR FOM this is called the Stance State.

virtual void DtEntityStateRepository::setLightState ( DtLightType  s,
bool  onOff 
)
virtual

Set light state of entity.

virtual void DtEntityStateRepository::setLightState ( DtLightState  s)
virtual

Set light state of entity.

This is for <= vrlink3.4 compatibility.

void DtEntityStateRepository::setMarkingCharSet ( int  charSet)
inlinevirtual

Set the character set used for the marking.

References myMarkingCharSet.

void DtEntityStateRepository::setMarkingText ( const char *  text)
inlinevirtual

Set the marking text attribute.

This is typically used as the vehicle bumper number, though some applications may use it as a unique identifier.

References internalSetMarkingText().

virtual void DtEntityStateRepository::setMaskedCloaked ( bool  onOff)
virtual

Set masked/cloaked appearance bit (introduced in DIS enums 2005 doc).

void DtEntityStateRepository::setMeasuredSpeed ( DtU16  value)
inlinevirtual

Set measured speed.

References myLiveEntityMeasuredSpeed.

virtual void DtEntityStateRepository::setMissionKill ( bool  yesNo)
virtual

Set Mission Kill status.

bool DtEntityStateRepository::setNozzleSystem ( int  index,
const DtVectoringNozzleSystem record 
)

Set a vectoring nozzle system data record (Non-virtual - Used in CTOR).

Returns false if the record does not exist.

void DtEntityStateRepository::setNumNozzleSystems ( DtU16  value)

Set number of nozzle systems (Non-virtual - Used in CTOR).

void DtEntityStateRepository::setNumPropulsionSystems ( DtU16  value)

Set number of propulsion systems (Non-virtual - Used in CTOR).

virtual void DtEntityStateRepository::setPowerPlantOn ( bool  onOff)
virtual

Set whether entity's power plant is on or not.

virtual void DtEntityStateRepository::setPrimaryWeaponState ( DtWeaponState  s)
virtual

Set primary weapon deployment state.

bool DtEntityStateRepository::setPropulsionSystem ( int  index,
const DtPropulsionSystem record 
)

Set a propulsion system data record (Non-virtual - Used in CTOR).

Returns false if the record does not exist.

void DtEntityStateRepository::setRadarSigRepIndex ( DtU16  value)
inlinevirtual

Set radar signature representation index.

References myRadarCrossSectionSignatureIndex.

virtual void DtEntityStateRepository::setRampDeployed ( bool  onOff)
virtual

Set whether entity has ramp deployed or not.

virtual void DtEntityStateRepository::setSecondaryWeaponState ( DtWeaponState  s)
virtual

Set secondary weapon deployment state.

virtual void DtEntityStateRepository::setSmokePlumePresent ( bool  onOff)
virtual

Set whether a smoke plume is present or not.

virtual void DtEntityStateRepository::setTentDeployed ( bool  onOff)
virtual

Set whether a tent is deployed or not.

virtual void DtEntityStateRepository::setTrailState ( DtTrailState  s)
virtual

Set trailing effect state.

virtual bool DtEntityStateRepository::smokePlumePresent ( ) const
virtual

Get whether a smoke plume is present or not.

virtual bool DtEntityStateRepository::tentDeployed ( ) const
virtual

Get whether a tent is deployed or not.

virtual DtTrailState DtEntityStateRepository::trailState ( ) const
virtual

Get trailing effect state.

const std::vector< DtVPRecord * > * DtEntityStateRepository::variableParameterList ( ) const
inlinevirtual

References myVPRecordCollection.

std::vector< DtVPRecord * > * DtEntityStateRepository::variableParameterList ( )
inlinevirtual

References myVPRecordCollection.

Member Data Documentation

DtU16 DtEntityStateRepository::myAcousticsSignatureIndex
protected
DtU32 DtEntityStateRepository::myAppearance
protected
DtArticulatedPartCollection DtEntityStateRepository::myArtPartList
protected

Referenced by artPartList().

DtAttachedPartCollection DtEntityStateRepository::myAttPartList
protected

Referenced by attPartList().

DtU32 DtEntityStateRepository::myCapabilities
protected

Referenced by capabilities(), and setCapabilities().

std::vector<char> DtEntityStateRepository::myDiGuyArc
protected

Legacy DIGuy extension attributes.

These will only be used in HLA, and only if the DIGuy PhysicalEntity extensions appear in the FOM

DtEntityIdentifier DtEntityStateRepository::myDiGuyParent
protected
DtDIGuyObjectStateRepository* DtEntityStateRepository::myDiGuyStateRep
protected
DtForceType DtEntityStateRepository::myForceId
protected

Referenced by forceId(), and setForceId().

DtEntityType DtEntityStateRepository::myGuise
protected

Referenced by guise(), and setGuise().

DtU16 DtEntityStateRepository::myInfaredSignatureIndex
protected
DtU16 DtEntityStateRepository::myLiveEntityMeasuredSpeed
protected

Referenced by measuredSpeed(), and setMeasuredSpeed().

int DtEntityStateRepository::myMarkingCharSet
protected

The char set used for marking text. Defaults to 1.

Referenced by markingCharSet(), and setMarkingCharSet().

DtString DtEntityStateRepository::myMarkingText
protected

myMarkingText is an array of theMaxMarkingSize.

String length is theMaxMarkingSize - 1 (doesn't include NULL).

Referenced by internalSetMarkingText(), and markingText().

int DtEntityStateRepository::myNumPropulsionSystemsData
protected
int DtEntityStateRepository::myNumVectoringNozzleSystemData
protected
DtPropulsionSystem* DtEntityStateRepository::myPropulsionSystemsDataList
protected
DtU16 DtEntityStateRepository::myRadarCrossSectionSignatureIndex
protected
bool DtEntityStateRepository::myUseDiGuyObject
protected
DtVectoringNozzleSystem* DtEntityStateRepository::myVectoringNozzleSystemDataList
protected
std::vector<DtVPRecord*> DtEntityStateRepository::myVPRecordCollection
protected

Referenced by variableParameterList().


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

Document ID: Generated on Mon Apr 25 03:39:01 EDT 2022 from SVN revision 242502
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)