VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtSubsurfaceEntityStateRepository Class Reference

Class: DtSurfaceEntityStateRepository. More...

Inheritance diagram for DtSubsurfaceEntityStateRepository:
Inheritance graph
[legend]

Public Member Functions

 DtSubsurfaceEntityStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 Constructor with parameters to set up read/writability correctly. More...
 
 DtSubsurfaceEntityStateRepository (const DtSubsurfaceEntityStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor More...
 
const
DtSubsurfaceEntityStateRepository
operator= (const DtSubsurfaceEntityStateRepository &orig)
 assignment operator More...
 
virtual ~DtSubsurfaceEntityStateRepository ()
 destructor More...
 
virtual DtString type () const
 
virtual const int vrfMovingObjectStateRepositorySubType () const
 
virtual void place (const DtVector &location, const DtReal heading, bool clampToGroundFlag=true, bool *dataAvailable=0, bool requireAllData=false)
 Overriden from base class to check altitude of location. More...
 
- Public Member Functions inherited from DtVrfMovingObjectStateRepository
 DtVrfMovingObjectStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 Constructor. More...
 
 DtVrfMovingObjectStateRepository (const DtVrfMovingObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 Copy Constructor. More...
 
DtVrfMovingObjectStateRepositoryoperator= (const DtVrfMovingObjectStateRepository &orig)
 Assignment Operator. More...
 
virtual ~DtVrfMovingObjectStateRepository ()
 Destructor. More...
 
virtual void tick ()
 Tick function. More...
 
virtual
DtSimObjectStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 Clone. More...
 
virtual const int vrfObjectStateRepositorySubType () const
 Returns DtVrfObjectStateRepositorySubTypeMoving. More...
 
virtual bool createParameters ()
 
virtual void initializeFromParameters ()
 
virtual void addRangeItem (const DtRangeItem &)
 If this range item is a sensor range item and there is more than one sensor range item, will either add or modify the "Maximum Sensor Range" ring to have the maximum sensor range of all sensors. More...
 
virtual void setRangeItems (const DtRangeItems &)
 
virtual void removeRangeItem (int index)
 
virtual void updateMaximumSensorRangeRing ()
 Updates/adds (as needed) the Maximum Sensor Range ring. More...
 
virtual const
DtMovingObjectParameters
movingObjectParameters () const
 
virtual bool canPivot () const
 
virtual void setCanPivot (const bool canPivot)
 
virtual DtReal maxPivotSpeed () const
 
virtual void setMaxPivotSpeed (DtReal maxPivotSpeed)
 
virtual const
DtGroundInteractionPt
rightSupport () const
 ground contact points More...
 
virtual DtGroundInteractionPtrightSupport ()
 
virtual void setRightSupport (const DtVector &vec)
 
virtual const
DtGroundInteractionPt
leftSupport () const
 
virtual DtGroundInteractionPtleftSupport ()
 
virtual void setLeftSupport (const DtVector &vec)
 
virtual const
DtGroundInteractionPt
otherSupport () const
 
virtual DtGroundInteractionPtotherSupport ()
 
virtual void setOtherSupport (const DtVector &vec)
 
virtual DtReal maxSpeed () const
 
virtual void setMaxSpeed (const DtReal speed)
 
virtual DtReal maxReverseSpeed () const
 
virtual void setMaxReverseSpeed (const DtReal speed)
 
virtual DtReal turningRadius () const
 
virtual void setTurningRadius (const DtReal turningRadius)
 
virtual DtReal maxSlope () const
 
virtual void setMaxSlope (const DtReal slope)
 
virtual DtReal orderedSpeedConstrained () const
 Ordered speed, limited to maximum speed (or maxReverseSpeed if < 0.0). More...
 
virtual void setCurrentPitch (double)
 Sets the pitch of the object into the geometry. More...
 
virtual double currentPitch () const
 
virtual DtReal orderedAltitude () const
 As specified by a setAltitude command, or the Z parameter of a destination waypoint. More...
 
virtual bool orderedAltitudepecified () const
 
virtual void setOrderedAltitude (DtReal orderedAltitude)
 
virtual void setOrderedAltitudeSpecified (bool)
 
virtual DtReal maxAcceleration () const
 
virtual void setMaxAcceleration (const DtReal maxAcceleration)
 
virtual DtReal maxStoppingDeceleration () const
 
virtual void setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration)
 
virtual DtReal maxLateralAcceleration () const
 This factor constrains how quickly an entity can turn while moving at a given speed. More...
 
virtual void setMaxLateralAcceleration (const DtReal maxLateralAcceleration)
 
virtual DtReal fuelEfficiency () const
 
virtual void setFuelEfficiency (const DtReal fuelEfficiency)
 
virtual DtReal inverseStoppingDeceleration () const
 Set by setting maxStoppingDeceleration. More...
 
virtual bool forward () const
 
virtual void setForward (const bool forward)
 
virtual bool amClampedToGround () const
 Specifies whether we're clamped to the ground or not. More...
 
virtual void setAmClampedToGround (const bool clamp)
 
virtual void reclampToGround ()
 Will cause the object to be reclamped to the terrain if it is not already. More...
 
virtual bool usingRailMovement () const
 Specifies the entity's desired movement strategy. More...
 
virtual void setUsingRailMovement (const bool rails)
 
virtual void clampToGround (const DtVector &location, const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
 Place entity on ground at location and heading. More...
 
virtual void clampToGround (const DtVector &location, const DtReal heading, bool gravityAligned, bool *dataAvailable=0, bool requireAllData=false)
 Clamps to ground with/without being aligned to gravity. More...
 
virtual void updateSupportPoints (const DtVector &newPosition, const DtReal newHeading)
 When reading in a scenario, want to make sure the support points get set up properly. More...
 
virtual DtVector parentPosition ()
 Returns parentPosition in kinematic state. More...
 
virtual void place (const DtVector &location, bool *dataAvailable=0, bool requireAllData=false)
 Place entity at 'location', on the ground, keeping its current heading. More...
 
virtual void place (const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
 Give entity the specified 'heading', but stay at its current location. More...
 
virtual void placeAtAltitude (const DtVector &location, const DtReal heading)
 Places entity at altitude regardless of terrain. More...
 
virtual void setDIGuyCharacterState (DtRwDIGuyCharacterState *info)
 Current DI-Guy character data–Our character type, current appearance and current animation the character is performing. More...
 
virtual DtRwDIGuyCharacterStatediGuyCharacterState ()
 
virtual const
DtRwNLengthStringVector
randomAppearancesList () const
 Returns the list of random appearances used by this entity. More...
 
virtual DtReal orderedSpeed () const
 Can be set from a parameter file or by the user with a set speed command, this is not constrained by maximum speed. More...
 
virtual void setOrderedSpeed (const DtReal speed)
 
virtual DtReal maneuverAggressiveness () const
 Indicates the fraction (value between 0 and 1) of maximum acceleration, G forces, etc. More...
 
virtual void setManeuverAggressiveness (const DtReal fraction)
 
virtual bool haveSupplies () const
 Accessor/mutator for myHaveSupplies. More...
 
virtual void setHaveSupplies (const bool doHave)
 
virtual double nextSupplyCheckTime () const
 Accessor/mutator for myNextSupplyCheckTime. More...
 
virtual void setNextSupplyCheckTime (const double time)
 
virtual void setDIGuyCharacter (const DtString &animation)
 The DI-Guy Character string for this entity. More...
 
virtual const DtStringdIGuyCharacter () const
 
virtual void setDIGuyAnimation (const DtString &animation)
 The current DI-Guy animation the entity is displaying. More...
 
virtual const DtStringdIGuyAnimation () const
 
virtual void setDIGuyUsingAnimationOffset (bool usingOffset)
 Whether the current animation should be using an animation offset. More...
 
virtual bool dIGuyUsingAnimationOffset () const
 
virtual void setDIGuyAnimationOffset (const DtVector &offset)
 The current DI-Guy animation offset. More...
 
virtual const DtVectordIGuyAnimationOffset () const
 
virtual void setDIGuyBodyWeight (double w)
 The current DI-Guy body weight. More...
 
virtual double dIGuyBodyWeight () const
 
virtual void setDIGuyAppearance (const DtString &app)
 The current Di-Guy character appearance of the entity. More...
 
virtual const DtStringdIGuyAppearance () const
 
virtual void setDIGuyHandItem (const DtString &app)
 The current Di-Guy character hand item of the entity. More...
 
virtual const DtStringdIGuyHandItem () const
 
virtual void setDIGuyHead (const DtString &app)
 The current Di-Guy character head of the entity. More...
 
virtual const DtStringdIGuyHead () const
 
virtual void addCurrentPitchCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
 Callback that is invoked when the entity's pitch is set. More...
 
virtual void removeCurrentPitchCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
 
virtual void invokeCurrentPitchCallbacks ()
 
- Public Member Functions inherited from DtVrfObjectStateRepository
 DtVrfObjectStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 Constructor. More...
 
 DtVrfObjectStateRepository (const DtVrfObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 Copy Constructor. More...
 
const DtVrfObjectStateRepositoryoperator= (const DtVrfObjectStateRepository &orig)
 Assignment Operator. More...
 
virtual ~DtVrfObjectStateRepository ()
 Destructor. More...
 
virtual const int objectStateRepositorySubType () const
 Returns DtSimObjectStateRepositorySubTypeVrfObject. More...
 
virtual bool init ()
 Our 'virtual' constructor. Calls all the create<>() methods. More...
 
virtual const
DtVrfObjectParameters
vrfParameters () const
 
virtual void setConcealed (bool)
 Sets weather or not this object is concealed. More...
 
virtual void setJoystickMovementControlled (bool)
 If true movement is controlled by joystick so will not be able to be taskable as a subordinate. More...
 
virtual bool joystickMovementControlled () const
 
virtual
DtVrfStateRepositoryUserExtension
userExtension () const
 User extension to state repository class. More...
 
virtual void restoreEntity ()
 Called on a setRestore command, sets destroyed to false and sets resources to initial (parameter file) levels. More...
 
virtual void updateCachedStateProperties ()
 Call to update any cached values that are representative of state properties. More...
 
virtual bool wouldBeRecursiveAttach (DtSimObjectStateRepository *parent) const
 Return true if attaching to this parent would cause a recursive attach. More...
 
virtual void restoreResourcesFromParameters ()
 
virtual bool isContactHostile (DtRwSensorContactInfo *) const
 Given the potential contacts, queries the engagement zone manager to see if that particular contact is hostile. More...
 
virtual bool isContactHostile (const DtVrfObject *) const
 This call will presume the object is of force type other and is only used for the location. More...
 
virtual bool isContactHostile (const DtVector &location, int perceivedForce) const
 Given the location and the perceived force, iterate over all the engagement zones this object is monitoring in order to see if any one of them says this object is hostile. More...
 
virtual bool inSOR (const DtVrfObject *entity) const
 
virtual bool canFireAt (const DtVector &location) const
 Returns true if this entity can fire upon the supplied location given the rules of engagement. More...
 
virtual const DtStringengagementRules () const
 
virtual void setEngagementRules (const DtString &engagementRules)
 
virtual bool isTasked () const
 Returns true if entity is currently executing a task (at least one component must be tasked), false otherwise. More...
 
virtual void clearCurrentTaskMsg (const DtSymbolString &componentName)
 Clear all the tasks with the specified component name. More...
 
virtual void clearCurrentTaskMsg (const DtSymbolString &componentName, int taskId)
 Clear the task with specified taskId and the specified component name. More...
 
virtual const DtTaskStatusListtaskStatusList () const
 
virtual DtTaskStatusListtaskStatusList ()
 
virtual DtSuspendedTaskStatusListsuspendedTaskStatusList ()
 
virtual DtTaskMessagecurrentTaskMsg (const DtSymbolString &componentName) const
 Get the current task message. More...
 
virtual DtTaskMessagecurrentTaskMsg (const DtSymbolString &componentName, int taskId) const
 Get the current task message for the specified component and task ID. More...
 
virtual std::list
< DtTaskMessage * > 
allCurrentTaskMsg (const DtSymbolString &componentName) const
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
 Top level call to write itself to file. More...
 
virtual bool placePoints (const DtAttachedTerrain &attachedTerrain, std::vector< DtGroundInteractionPt * > groundInteractionPts, bool *terrainDataAvailable=0) const
 Positions list of ground interaction points on the terrain surface closest to the specified location. More...
 
virtual const
DtVrfObjectParameters
parameters () const
 
virtual DtVrfObjectParametersmodifiableParameters ()
 A modifiable local copy of parameters. More...
 
virtual void setupParameterInheritance ()
 Called by init(). More...
 
virtual bool createAttachments ()
 Override to create derived DtVrfAttachmentManager. More...
 
DtArticulatedPartStateRepositoryaddPart (DtArtPartType partType)
 These will be replaced by equivalents in the attachment manager. More...
 
void removePart (DtArtPartType partType)
 
DtArticulatedPartStateRepositorypart (DtArtPartType partType)
 
DtArticulatedPartStateRepositoryfindDescendantByType (DtArtPartType childType)
 
virtual void setInvisible (bool)
 Whether or not this item is invisible to sensors, line of sight, etc. More...
 
virtual bool invisible () const
 
virtual void setInvulnerable (bool)
 Whether or not this item is invulnerable. More...
 
virtual bool invulnerable () const
 
virtual void setUndetectable (bool)
 Whether or not this item is undetectable. More...
 
virtual bool undetectable () const
 
virtual void setInvisibleSetByUser (bool)
 Whether or not this item was set invisible by a set command. More...
 
virtual bool invisibleSetByUser () const
 
bool sensorsKilled () const
 Indicates that the entity's sensors have been killed. More...
 
void setSensorsKilled (bool sensorsKilled)
 
bool isEntity () const
 
bool isLocal () const
 
bool isAggregate () const
 
void addSubordinate (const DtVrfObject *subordinateEntity)
 Adds an entity as a subordinate. More...
 
void removeSubordinate (const DtVrfObject *subordinateEntity)
 Removes entity from our list of subordinates. More...
 
virtual DtSharedVrfObjectReference leadEntity () const
 
virtual DtSharedVrfObjectReference firstSubordinate () const
 
virtual DtSharedVrfObjectReference lastSubordinate () const
 
virtual DtSharedVrfObjectReference firstHealthySubordinate () const
 
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived (myNextTickTime <= exerciseClock()->approximateElapsedRealTime()). More...
 
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as More...
 
virtual double minTickPeriod () const
 access the minimum tick period More...
 
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time More...
 
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period More...
 
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally. More...
 
virtual double nextTickTime () const
 access the next tick time More...
 
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...
 
virtual bool createSubordinates ()
 
virtual DtVrfSubordinateManagervrfSubordinates ()
 
virtual const
DtVrfSubordinateManager
vrfSubordinates () const
 
virtual bool createProcessStateRepositoryManager ()
 
virtual const DtTaitBryan & localOrientationWrtDatabase () const
 Euler angles with respect to the local (database) coordinate system, in radians. More...
 
virtual void setLocalOrientationWrtDatabase (const DtTaitBryan &localOrientation)
 
virtual DtVrfWeaponPSRfirstWeaponPSR () const
 This is provided for backward compatibility with setTarget capabilities. More...
 
virtual void processObjectGeometry (const DtList &vertices)
 Processes a list of DtVectors, such as might come in a create or modify message. More...
 
virtual void processObjectGeometry (const DtLocalVertexList &vertices)
 
virtual void processObjectGeometry ()
 This form allows processObjectGeometry()'s bounding volume calculations to be done on it's current geometry (by making a copy first). More...
 
virtual const
DtVrfObjectParameters
vrfBaseParameters () const
 
virtual DtGroundInteractionPtgroundCenter ()
 
virtual const
DtGroundInteractionPt
groundCenter () const
 
virtual void updatePositionFromModelVertices ()
 Note that this is not currently ever called. More...
 
virtual DtReal mass () const
 
virtual void setMass (const DtReal mass)
 
virtual const
DtArticulatedPartCollection * 
artPartList () const
 Get the list of articulated parts specified in the component descriptor. More...
 
virtual void createParts ()
 This causes the art part tree to be created. More...
 
virtual DtTime lastTimeFiredUpon () const
 
virtual void setLastTimeFiredUpon (const DtTime time)
 
virtual bool underFire () const
 
virtual void setUnderFire (bool underFire)
 
virtual bool systemEnabled (const DtString &systemName) const
 
virtual void setSystemEnabled (const DtString &systemName, bool enabled)
 
virtual const
DtRwPriorityTargetListMap
targetPriorityList () const
 Get/set/append to target priority list. More...
 
virtual DtRwPriorityTargetListMaptargetPriorityList ()
 
virtual void setTargetPriorityList (const DtRwPriorityTargetListMap &targetPriorityList)
 
virtual void appendToTargetPriorityList (const DtRwPriorityTargetListMap &targetPriorityList)
 
virtual int targetPriorityLevel (const DtUUID &obj) const
 Returns a positive value of priority if object is in the target priority list Returns DtPriorityLevelInvalid otherwise. More...
 
virtual const DtStringnonLethalDamageEffect () const
 The current non lethal damage type. More...
 
virtual void setNonLethalDamageEffect (const DtString &nonLethalDamageEffect)
 
virtual DtDeadReckonTypes deadReckoningAlgorithm () const
 
virtual void setDeadReckoningAlgorithm (DtDeadReckonTypes deadReckoningAlgorithm)
 
virtual void putData (std::string &fp, int indentLevel=0)
 Override putData to set myParent using the organization manager before saving. More...
 
virtual int nextTaskId ()
 Returns next unique task id for this entity. More...
 
virtual int nextSuspendId ()
 
virtual DtTaskMessagependingSubtask (int subtaskId, DtString &controller) const
 Returns the current subtask with the specified id. More...
 
virtual bool taskedBySuperiorUponTaskComplete () const
 Returns true if entity should automatically resume being tasked by superior upon completion of its current top-level task, false otherwise. More...
 
virtual void setParentWasDestroyedWhenEmbarked (bool)
 
virtual bool parentWasDestroyedWhenEmbarked () const
 
virtual void detachFromParent ()
 
virtual void attachToParent (DtSimObjectStateRepository *parent)
 Adds this state repository to the given parent's list of attached state repositories and updates myAttachedToRepository and myRootSimStateRepository. More...
 
virtual void attachToParent (const DtUUID &parent)
 Looks up the parent state repository using the given echelon ID and puts it in a call to attachToParent. More...
 
virtual void addAttachedTerrain (const DtUUID &parent)
 Asks the sim manager to look up the object model for the requested database. More...
 
virtual void removeAttachedTerrain (const DtUUID &parent)
 Decreases reference count of terrain model by name of object. More...
 
Dt3dBoundingVolume * boundingVolume () const
 Convenience method for accessing entity's bounding volume, stored in myObjectGeometry. More...
 
DtVector localBoundingVolumeCenterPosition () const
 Gets the local coordinates of the bounding volume center. More...
 
DtReal forwardSpeed () const
 
virtual double totalMass () const
 Returns the current total mass of the entity. More...
 
virtual void restoreStateProperties ()
 Restores state properties to their default settings. More...
 
virtual void initStatePropertiesNotToBeRestored ()
 Initializes the list of state properties which should not be restored. More...
 
virtual bool fuelLevelsFrozen ()
 check frozen state of fuel and munition levels More...
 
virtual bool munitionLevelsFrozen ()
 
const DtRangeItemsrangeItems () const
 
DtRangeItemsrangeItems ()
 
virtual void clearRangeItems ()
 
DtAttachedTerrainterrainAttachedTo () const
 
virtual boost::tribool onTerrainSurface () const
 
virtual double sensorSignature (const DtSymbolString &sensorDomain) const
 Returns the current absolute signature for this object in the specified sensor domain. More...
 
virtual std::list< DtSymbolStringsensorSignatureDomains () const
 
virtual DtString stringFromExtendedData (const DtString &) const
 Takes the extended data string, and, if xml, will pretty print and remove the quotes from the created reader/writer else just return the string. More...
 
virtual std::map< DtString,
DtString
unarchivedData () const
 Extended data that is not archived that is currently in the extended data list. More...
 
virtual void appendExtendedData (const std::map< DtString, DtString > &)
 Append extended data to extended data map. More...
 
virtual
DtVrfObjectStateRepository
toVrfObjectStateRepository ()
 
virtual const
DtVrfObjectStateRepository
toVrfObjectStateRepository () const
 
virtual void addRestoredCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
 Callback that is invoked when the entity is about to be removed from the simulation. More...
 
virtual void removeRestoredCallback (DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void *usr)
 
virtual void invokeRestoredCallbacks ()
 
virtual void setExtendedData (const DtString &key, const DtString &value)
 
virtual void clearExtendedData ()
 
virtual void removeExtendedData (const DtString &key)
 
virtual DtString extendedData (const DtString &key) const
 
const ExtendedDataextendedDataMap () const
 
virtual void setExtendedDataMap (const ExtendedData &)
 
virtual void setExtendedDataMap (const std::map< std::string, std::string > &)
 
virtual void setupExtendedDataFromParameterData ()
 If publishing parameter data also include that in the extended data map by name. More...
 
virtual void setExtendedLabel (int, const DtString &value)
 
virtual void clearExtendedLabels ()
 
virtual DtString extendedLabel (int index) const
 
virtual ExtendedLabels extendedLabels () const
 
virtual void setExtendedLabels (const ExtendedLabels &)
 
virtual void addJoystickControls (const DtRwJoystickControls &)
 
virtual const JoystickControlsjoystickControls () const
 
virtual void setActivity (const DtString &)
 
virtual DtString activity () const
 
virtual const
DtObjectResourceManager
objectResourceManager () const
 
virtual DtObjectResourceManagerobjectResourceManager ()
 
virtual const
DtSimResourceManager
oldResourceManager () const
 Returns a reference to our resource manager. More...
 
virtual DtSimResourceManageroldResourceManager ()
 
virtual DtSimResourceoldLookupResource (const DtString &resourceName)
 Gets a pointer to the resource named resourceName. More...
 
virtual const DtSimResourceoldLookupResource (const DtString &resourceName) const
 
virtual void oldAddResource (DtSimResource *resource)
 This does a clone of the resource and puts it on our main list, as well as adding the resource to the hash index. More...
 
virtual void oldRemoveResource (DtSimResource *resource)
 This removes and deletes the specified resource. More...
 
virtual void setNavigationEnabled (bool)
 
virtual bool navigationEnabled () const
 
virtual void setSOR (DtReal center, DtReal size)
 Sector of responsibility. More...
 
virtual DtReal SORSize () const
 
virtual DtReal SORCenter () const
 
virtual const DtSimSectorSOR () const
 
virtual void setRequestTaskNeeded (bool value)
 Set/get whether or not this needs to send a request task needed message. More...
 
virtual bool requestTaskNeeded () const
 
virtual void setTasked (const DtSymbolString &componentName, bool tasked)
 Set/get whether or not a given entity component currently executing a task. More...
 
virtual void setTasked (const DtSymbolString &componentName, int taskID, bool tasked)
 
virtual bool tasked (const DtSymbolString &componentName) const
 
virtual void setCurrentTaskMsg (const DtSymbolString &componentName, const DtTaskMessage &taskMsg)
 Set the current task message. More...
 
virtual void setCurrentTaskMsg (const DtSymbolString &componentName, const DtTaskMessage &taskMsg, int taskId)
 
virtual void setIndependentlyTasked (bool value)
 Set/get whether or not this entity is currently independently tasked (separately from its unit). More...
 
virtual bool independentlyTasked () const
 
virtual const
DtVrfObjectParameters
parameterEntry () const
 If a clone has been created, this call will return the cloned entry as a const pointer, else returns the original pointer. More...
 
virtual void setParameterEntry (DtVrfObjectParameters *parameterEntry)
 
virtual DtForceType forceType () const
 Get/Set the force type (team) of this entity. More...
 
virtual void setForceType (DtForceType force)
 
virtual bool createAppearance ()
 Encapsulates all the appearance related data and methods currently in the entity state repository. More...
 
virtual const DtAppearance * appearance () const
 
virtual DtAppearance * appearance ()
 
virtual void setCapabilities (int cap)
 Gets/sets capabilities of entity This is treated as the DIS capabilities bit field, and does not necessarily change any behaviors of the object. More...
 
virtual int capabilities () const
 
virtual void setDestroyed (bool isDestroyed)
 Destroyed status of entity (whether or not appearance()->damageState() is set to DtDamageDestroyed). More...
 
virtual bool isDestroyed () const
 
virtual void setOccupantsHidden (bool v)
 Whether or not the occupants of an entity are visually hidden. More...
 
virtual bool occupantsHidden () const
 
DtReal healthPct () const
 
void setHealthPct (DtReal pct)
 
bool firePowerKilled () const
 Convenience methods for setting setting entity's appearance bits in DtAppearance. More...
 
void setFirePowerKilled (const bool firePowerKilled)
 
bool mobilityKilled () const
 
void setMobilityKilled (const bool mobilityKilled)
 
bool flaming () const
 
void setFlaming (const bool flaming)
 
bool smoking () const
 
void setSmoking (const bool smoking)
 
virtual DtVrfSubordinateManagersubordinates ()
 
virtual const
DtVrfSubordinateManager
subordinates () const
 
virtual DtSimManagersimManager ()
 
virtual const DtSimManagersimManager () const
 
virtual DtPhysicalWorldphysicalWorld ()
 
virtual const DtPhysicalWorldphysicalWorld () const
 
virtual const
DtVrfProcessStateRepositoryManager
systemProcessStateRepositoryManager () const
 
virtual
DtVrfProcessStateRepositoryManager
systemProcessStateRepositoryManager ()
 
virtual const DtThresholder & deadReckoningThresholder () const
 Dead-reckoning threshold parameters. More...
 
virtual void setDeadReckoningThresholder (const DtThresholder &thresholder)
 
virtual const DtEntityIdentifier & occupyingObjectId () const
 We hold the id of the object we are occupying. More...
 
virtual void setOccupyingObjectId (const DtEntityIdentifier &objId)
 
virtual void setEchelonId (const DtEchelonId &echelonId)
 The echelon ID of this object, if it is an organized object. More...
 
virtual DtEchelonIdechelonId ()
 
virtual const DtEchelonIdechelonId () const
 
virtual void setIsSubordinateOfForceLevel (bool yesNo)
 Indicates if this object's direct superior is a Force level object. More...
 
virtual bool isSubordinateOfForceLevel () const
 
virtual int spawningTaskId (int subtaskId) const
 Functions for manipulating the set of pending subtask Ids for all components in the entity. More...
 
virtual void addPendingSubtaskId (const DtSymbolString &componentName, int subtaskId)
 
virtual void addPendingSubtaskId (const DtSymbolString &componentName, int taskId, int subtaskId)
 
virtual bool findPendingSubtaskId (const DtSymbolString &componentName, int subtaskId)
 
virtual bool isSubtasked (const DtSymbolString &componentName) const
 
virtual bool findPendingSubtaskId (const DtSymbolString &componentName, int taskId, int subtaskId)
 
virtual void removePendingSubtaskId (const DtSymbolString &componentName, int subtaskId)
 
virtual void removePendingSubtaskId (const DtSymbolString &componentName, int taskId, int subtaskId)
 
virtual void removeAllPendingSubtaskIds (const DtSymbolString &componentName)
 
virtual void removeAllPendingSubtaskIds (const DtSymbolString &componentName, int taskId)
 
virtual void removeInactiveSubtaskStatus (const DtSymbolString &componentName)
 
virtual void removeInactiveSubtaskStatus (const DtSymbolString &componentName, int taskId)
 
virtual void printPendingSubtaskIds (const DtSymbolString &componentName) const
 
virtual std::vector< intcurrentPendingSubstaskIds (const DtSymbolString &componentName) const
 
virtual std::vector< intcurrentPendingSubstaskIds (const DtSymbolString &componentName, int taskId) const
 
virtual DtSubtaskStatusEntrypendingSubtaskStatus (const DtSymbolString &componentName, int subtaskId)
 
virtual DtSubtaskStatusEntrypendingSubtaskStatus (const DtSymbolString &componentName, int taskId, int subtaskId)
 
DtReal currentSpeed () const
 Returns magnitude of relative velocity in state repository. More...
 
DtReal currentHeading () const
 Heading in radians. Calls down to DtVrfKinematicState for heading. More...
 
void setCurrentHeading (const DtReal heading)
 
virtual const
DtRwNLengthUUIDVector
engagementZones () const
 Accessor/mutator for engagement zones. More...
 
virtual void setEngagementZones (const DtRwNLengthUUIDVector &)
 
virtual void addPostInitFromParamsCallback (DtPostInitializeFromParametersCallbackFcn fcn, void *usr)
 Add/remove callback function to be invoked immediately following execution of initializeFromParameters. More...
 
virtual void removePostInitFromParamsCallback (DtPostInitializeFromParametersCallbackFcn fcn, void *usr)
 
virtual DtRwPropertiesstateProperties ()
 Accesses to the properties. More...
 
virtual const DtRwPropertiesstateProperties () const
 
virtual DtRwPropertiesparameterProperties ()
 Access to static (parameter) properties. More...
 
virtual const DtRwPropertiesparameterProperties () const
 
virtual DtSensorContactInfoListobjectContactList ()
 Situational awareness of this object. More...
 
virtual const
DtSensorContactInfoList
objectContactList () const
 
virtual suppressionLevels suppressionLevel () const
 
virtual void setSuppressionLevel (const suppressionLevels l)
 
virtual bool isSuppressed () const
 
virtual bool processCompleteAttachment (const DtVrfObject *)
 These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent. More...
 
virtual void processObjectAboutToBeRemovedCallback (const DtVrfObject *vrfObject)
 
virtual void processTaskComplete (const DtVrfObjectMessage *msg)
 
- Public Member Functions inherited from DtSimObjectStateRepository
 DtSimObjectStateRepository (DtVrfObject *simObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
const DtSimObjectStateRepositoryoperator= (const DtSimObjectStateRepository &orig)
 
virtual ~DtSimObjectStateRepository ()
 
virtual const DtObjectTypeobjectType () const
 
virtual void setObjectType (const DtObjectType &objectType)
 
virtual bool createKinematicState ()
 Creates a DtVrfKinematicState. More...
 
virtual DtVrfKinematicStatevrfKinematicState ()
 
virtual const DtVrfKinematicStatevrfKinematicState () const
 
virtual bool createObjectGeometry ()
 
virtual DtVrfObjectGeometryvrfObjectGeometry ()
 
virtual const DtVrfObjectGeometryvrfObjectGeometry () const
 
virtual DtAttachmentManagerattachments ()
 
virtual const DtAttachmentManagerattachments () const
 
virtual DtArticulatedPartManagerarticulatedParts ()
 
virtual const
DtArticulatedPartManager
articulatedParts () const
 
virtual const
DtSimObjectStateRepository
parent () const
 
virtual bool isEmbarkedOn (const DtUUID &parent) const
 
virtual const DtUUIDattachedToRepository () const
 
virtual
DtSimObjectStateRepository
findRootSimStateRepository ()
 
virtual const
DtSimObjectStateRepository
findRootSimStateRepository () const
 
virtual void setOwnedByHostObject (bool)
 When state repositories get added to the attachment manager, the attachment manager assumes it takes ownership of that state repository, and, when it is deleted, it will destroy any state repository that is still attached. More...
 
virtual bool ownedByHostObject () const
 
virtual void ancestorObjectChanged ()
 
virtual void preGetSelf ()
 Hook function called immediately prior to getSelf(). More...
 
virtual void removeRepositoryAboutToBeDeletedCallback (DtSimObjectStateRepositoryAboutToBeDeletedCallbackFcn, void *usr)
 Add/remove callback for notification that this state repository is about to be deleted. More...
 
virtual void addRepositoryAboutToBeDeletedCallback (DtSimObjectStateRepositoryAboutToBeDeletedCallbackFcn, void *usr)
 
virtual void invokeRepositoryAboutToBeDeletedCallbacks ()
 
virtual void processUUIDChanged (const DtVrfObjectUUIDChangedCallbackInfo &)
 
virtual void setCoordinateSystem (const Coordinate_System *coordinateSystem)
 Sets the coordinate system in myObjectGeometry and myKinematicState. More...
 
virtual const DtVrfObjectvrfObject () const
 
virtual void setVrfObject (DtVrfObject *vrfObject)
 
virtual DtSimKinematicStatekinematicState ()
 
virtual const DtSimKinematicStatekinematicState () const
 
virtual DtVrfObjectGeometryobjectGeometry ()
 
virtual const DtVrfObjectGeometryobjectGeometry () const
 
virtual const DtVectorbodyPosition () const
 Now superseded by kinematic state parentCS functions. More...
 
virtual void setBodyPosition (const DtVector &pos)
 Formerly setMeInParent. More...
 
virtual void setBodyPosition (DtFloat64 x, DtFloat64 y, DtFloat64 z)
 
const DtDcm & bodyOrientationMatrix () const
 Formerly meToParent(). More...
 
virtual void embarkOnParent (const DtUUID &parent)
 Embarks this entity on the specified parent. More...
 
virtual bool leftOf (const DtVector &localVector) const
 
virtual bool inside (const DtVector &point) const
 
virtual double distanceToLocalVector (const DtVector &localVector) const
 Returns the distance from a position in local. More...
 
const Coordinate_SystemcoordinateSystem () const
 
virtual void removeVertex (int iIndex)
 These routines simply call down to the kinematic state to get/set the results. More...
 
virtual void addLocalVertex (const DtVector &vertex)
 
virtual void addLocalVertex (const DtVector &vertex, DtVector &newGeometricCenter)
 
virtual void setLocalVertices (const DtLocalVertexList &vertices, DtVector &newGeometricCenter)
 
virtual void setLocalVertices (const DtList &vertices, DtVector &newGeometricCenter)
 
virtual const DtLocalVertexListlocalVertices () const
 
virtual const
DtLocalVectorIterator
localVertexIterator () const
 
virtual void addWorldVertex (const DtVector &vertex, DtVector &newGeometricCenter)
 
virtual void setWorldVertices (const DtVertexList &vertices, DtVector &newGeometricCenter)
 
virtual void setWorldVertices (const DtList &vertices, DtVector &newGeometricCenter)
 
virtual const DtVertexListworldVertices () const
 
virtual const DtRwVectorIteratorworldVertexIterator () const
 
virtual void setRelativeVertices (const DtLocalVertexList &vertices)
 Access/modify vertices relative to to the parent to which this object is attached. More...
 
virtual void setRelativeVertices (const DtList &vertices)
 
virtual const DtLocalVertexListrelativeVertices () const
 
virtual const
DtLocalVectorIterator
relativeVertexIterator () const
 
const DtVectorlocalPosition () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState. More...
 
void setLocalPosition (const DtVector &pos)
 
const DtVectorlocalVelocity () const
 
void setLocalVelocity (const DtVector &vel)
 
const DtVectorlocalAcceleration () const
 
void setLocalAcceleration (const DtVector &acc)
 
const DtVectorrelativeVelocity () const
 
void setRelativeVelocity (const DtVector &vel)
 
const DtVectorrelativeAcceleration () const
 
void setRelativeAcceleration (const DtVector &acc)
 
const DtTaitBryan & localOrientation () const
 
void setLocalOrientation (const DtTaitBryan &angles)
 
const DtVectorworldPosition () const
 
void setWorldPosition (const DtVector &pos)
 
const DtVectorworldVelocity () const
 
void setWorldVelocity (const DtVector &vel)
 
const DtVectorworldAcceleration () const
 
void setWorldAcceleration (const DtVector &acc)
 
const DtTaitBryan & worldOrientation () const
 
void setWorldOrientation (const DtTaitBryan &angles)
 
const DtVectorrotationalVelocity () const
 
void setRotationalVelocity (const DtVector &rotationalVelocity)
 
const DtDcm & localOrientationMatrix () const
 
void setLocalOrientationMatrix (const DtDcm &orient)
 
void setParentPosition (const DtVector &pos)
 
const double lastPositionSetTime () const
 Indicates the last time the position was set, so that a precise position at the current time may be computed. More...
 
void setLastPositionSetTime (const double simTime)
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 Set read-only flag. More...
 
bool isReadonly () const
 
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
virtual std::list
< DtVariableNameType
unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value. More...
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 

Static Public Member Functions

static DtVrfObjectStateRepositorycreator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
 
- Static Public Member Functions inherited from DtVrfMovingObjectStateRepository
static DtVrfObjectStateRepositorycreator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
 
static
DtVrfMovingObjectStateRepository
isVrfMovingObjectStateRepository (DtSimObjectStateRepository *repository)
 
static const
DtVrfMovingObjectStateRepository
isVrfMovingObjectStateRepository (const DtSimObjectStateRepository *repository)
 
- Static Public Member Functions inherited from DtVrfObjectStateRepository
static bool shouldArchiveExtendedAttribute (const DtString &)
 true if the given attribute should be archived. Use static methods to add/remove keywords More...
 
static void doNotArchiveAttribute (const DtString &, bool)
 
static DtVrfObjectStateRepositorycreateRepository (const DtString &name, const DtString &type, DtVrfObject *simObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry=0)
 Creates a new state repository object, using the factory. More...
 
static void addSimObjectStateRepositoryCreatorFcn (const DtString &type, DtSimObjectStateRepositoryCreatorFcn fcn)
 
static DtVrfObjectStateRepositorycreator (const DtString &name, DtVrfObject *simObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
 
static DtVrfObjectStateRepositoryisVrfObjectStateRepository (DtSimObjectStateRepository *repository)
 
static const
DtVrfObjectStateRepository
isVrfObjectStateRepository (const DtSimObjectStateRepository *repository)
 
static
DtSimObjectStateRepositoryFactory
factory ()
 a DtSimObjectStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtSimObjectStateRepositoryFactory *factory)
 
static void objectAboutToBeRemovedCallback (const DtVrfObject *vrfObject, void *usr)
 
static void taskCompleteCallback (const DtVrfObjectMessage *msg, void *usr)
 Handles state changes for the subtask status list. More...
 
- Static Public Member Functions inherited from DtSimObjectStateRepository
static void completeAttachmentCallback (const DtVrfObject *simObject, void *usr)
 These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent. More...
 
static void objectAboutToBeRemovedCallback (const DtVrfObject *simObject, void *usr)
 
static void uuidChangedCallback (const DtVrfObjectUUIDChangedCallbackInfo &, void *usr)
 
static DtSimObjectStateRepositoryisSimObjectStateRepository (DtSimObjectStateRepository *repository)
 
static const
DtSimObjectStateRepository
isSimObjectStateRepository (const DtSimObjectStateRepository *repository)
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 

Protected Member Functions

 DtSubsurfaceEntityStateRepository ()
 default constructor cannot be used More...
 
- Protected Member Functions inherited from DtVrfMovingObjectStateRepository
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Override getSelf to handle mapping of old pre-2.0 oob files. More...
 
virtual void determineDiGuyAppearance ()
 Called during initialization, if there is DI-Guy data, to determine the di-guy appearance. More...
 
virtual void determineVisualMarkingAppearance ()
 Called during initialization to determine visual marking data (if specified) More...
 
virtual DtRwDIGuyCharacterStatecreateDIGuyCharacterState ()
 Used to create the new DI-Guy character state used by this class. More...
 
 DtVrfMovingObjectStateRepository ()
 Default Constructor. Do not use. More...
 
- Protected Member Functions inherited from DtVrfObjectStateRepository
 DtVrfObjectStateRepository ()
 Default Constructor. Do not use. More...
 
virtual void initializeNextTaskId ()
 Initializes myNextTaskId to the next highest integer than the highest subtask Id currently maintained in myTaskStatusList. More...
 
virtual void setOrientationRelativeToParent ()
 If attached to a parent, and a terrain database is present, set orientation relative to parent. More...
 
virtual DtAttachedTerraincreateAttachedTerrain ()
 
virtual void createPartsFromDescriptors (const std::list< DtSimArtPartDescriptor * > &descriptors, bool fromComponentDefaults)
 Creates the articulated parts for an entity from articulated part descriptors. More...
 
virtual void postGetSelf ()
 Hook function called immediately following getSelf(). More...
 
virtual double baseSensorSignature (const DtSymbolString &sensorDomain) const
 
virtual double modifySensorSignature (const DtSymbolString &sensorDomain, double baseSignature) const
 Modifies the supplied baseSignature using the signatureModifiers for the specified sensor domain. More...
 
virtual bool initSignatureEvaluators ()
 Sets up all the sensor signature evaluators in mySignatureEvalMap based on the parameter entry for this entity. More...
 
void clearSignatureEvaluators ()
 Removes and deletes all signature evaluators. More...
 
virtual bool createObjectResourceManager ()
 Creates and sets myObjectResourceManager. More...
 
virtual void invokePostInitFromParamsCallbacks ()
 Invokes all callbacks registered via a call to addPostInitFromParamsCallback. More...
 
- Protected Member Functions inherited from DtSimObjectStateRepository
 DtSimObjectStateRepository (const DtSimObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtSimObjectStateRepository ()
 Default Constructor; not implemented. More...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 

Additional Inherited Members

- Public Types inherited from DtVrfObjectStateRepository
typedef std::map< DtString,
DtString
ExtendedData
 
typedef std::map< int, DtStringExtendedLabels
 
typedef std::map< DtString,
std::map< DtString,
DtRwJoystickControl > > 
JoystickControls
 Controls by function group. More...
 
enum  suppressionLevels { DtNoSuppression = 0, DtSuppressed1 = 1, DtSuppressed2 = 2, DtSuppressed3 = 3 }
 The current suppression level. More...
 
- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
 
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
 
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
 
typedef std::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- Protected Types inherited from DtVrfObjectStateRepository
typedef std::list
< DtSignatureModifierEvaluator * > 
DtSignatureModifierEvalList
 
typedef std::map
< DtSymbolString,
DtSignatureModifierEvalList * > 
DtSignatureModifierEvalMap
 
typedef
tbb::concurrent_hash_map
< unsigned int, double
DtSensorSignatureCacheMap
 
typedef std::pair
< DtPostInitializeFromParametersCallbackFcn,
void * > 
DtPostInitializeFromParametersInfo
 
typedef std::list
< DtPostInitializeFromParametersInfo
DtPostInitializeFromParametersCallbackList
 
- Protected Types inherited from DtSimObjectStateRepository
typedef DtCallbackList
< DtSimObjectStateRepository * > 
DtAboutToBeDeletedCallbacksList
 
- Static Protected Member Functions inherited from DtVrfObjectStateRepository
static bool visibilityFilter (const DtVrfObject *object, void *usr)
 Used by isVisible to determine which objects can block visibility. More...
 
- Protected Attributes inherited from DtVrfMovingObjectStateRepository
DtGroundInteractionPt myLeftSupport
 
DtGroundInteractionPt myRightSupport
 
DtGroundInteractionPt myOtherSupport
 
DtRwReal myOrderedSpeed
 
DtRwReal myManeuverAggressiveness
 
DtRwReal myOrderedAltitude
 
DtRwReal myMaxSpeed
 
DtRwReal myMaxReverseSpeed
 
DtRwReal myTurningRadius
 
DtRwReal myMaxSlope
 
DtRwBoolean myForward
 
DtRwReal myMaxAcceleration
 
DtRwReal myMaxStoppingDeceleration
 
DtRwReal myMaxLateralAcceleration
 
DtRwReal myFuelEfficiency
 
DtRwBoolean myCanPivot
 
DtRwBoolean myClampToGround
 
DtRwBoolean myUsingRailMovement
 If true keeps the entity clamped to the route segment it is on, no steering just follows the segment. More...
 
DtRwReal myMaxPivotSpeed
 
DtRwDIGuyCharacterStatemyDIGuyCharacterState
 DI-Guy state for the entity. More...
 
DtString myDIGuyCharacter
 Stores the character type string for remote entities. More...
 
DtReal myInverseStoppingDeceleration
 Derived quantity (1/myMaxStoppingDeceleration) - no need to make it read-write. More...
 
DtRwBoolean myKeepGroundClampingFlag
 Records whether we should keep ground clamping b/c not all terrain was loaded. More...
 
DtRwBoolean myPitchSet
 Records if the pitch has been set by the user to respect when clamping to ground or setting at altitude. More...
 
DtRwBoolean myHaveSupplies
 Records whether the entity has appropriate supplies to keep it moving. More...
 
DtRwReal myNextSupplyCheckTime
 Records the next time that supplies should be checked (in general, this isn't done every tick. More...
 
DtVrfObjectCallbackList myCurrentPitchCallbacks
 List of callbacks for when this entity sets current pitch. More...
 
- Protected Attributes inherited from DtVrfObjectStateRepository
DtVrfStateRepositoryUserExtensionmyStateRepositoryUserExtension
 
DtRwAppearancemyAppearance
 
DtRwInt myCapabilities
 
DtRwBoolean mySensorsKilled
 
DtRwForceType myForceType
 
DtRwNLengthUUIDVector myEngagementZones
 
DtVrfSubordinateManagermySubordinates
 each of these has_a DtSubObjectManager More...
 
DtRwUUID myParent
 if this object is a subordinate, this is used to write out the name of the parent More...
 
DtVrfProcessStateRepositoryManagermySystemProcessSRManager
 
DtLegacyProcessStateRepositoryManagermyLegacyPSRManager
 Used only to read in scenarios from pre VRF 3.11. More...
 
DtSimManagermySimManager
 
DtGroundInteractionPt myGroundCenter
 
bool myUnderFire
 Under fire parameters. More...
 
DtTime myLastTimeFiredUpon
 
DtRwStringList mySystemsDisabledList
 Systems which have had their default enable state changed to disabled. More...
 
DtRwInt mySuppressionLevel
 The current enumerated level of suppression, derived from the value. More...
 
DtRwString myNonLethalDamageEffect
 The current non lethal damage type (sick, faint, etc.). More...
 
DtReal myMass
 
DtDeadReckonTypes myDeadReckoningAlgorithm
 
DtThresholder myDeadReckoningThresholder
 
DtEntityIdentifier myOccupyingObjectId
 
DtArticulatedPartCollection myArtPartList
 This is created in createParts, and kept around to make setup of the network repository easier. More...
 
DtManagedObjectListConstPtr myVisibilityFilterList
 Shared list of visibility blocking objects. More...
 
DtRwVector myLocalPosition
 For backward compatibility with pre-2.0 VR-Forces oob files Registered as read-only, so they do not get written out to new oob files. More...
 
DtRwTaitBryan myLocalOrientation
 
DtRwBoolean myIsDestroyedFlag
 
DtEchelonId myEchelonId
 
DtRwBoolean myIsSubordinateOfForceLevel
 
DtRwInt myDesignator
 myDesignator is used for reading and writing only and is not valid at runtime. More...
 
DtRwBoolean myIndependentlyTasked
 
DtSimResourceManager myResourceManager
 This resource manager is used for all the top-level resource only. More...
 
DtObjectResourceManagermyObjectResourceManager
 
DtRwString myEngagementRules
 
DtSimSector mySectorOfResponsibility
 These really apply to a single weapon, and should be part of a weapon controller/actuator suite of some sort. More...
 
DtRwBoolean myRequestTaskNeeded
 Moved here from the DtLocalTaskManager class. More...
 
DtTaskStatusList myTaskStatusList
 Contains the myTasked and myCurrentTaskMsg members from the DtTaskControllerComponent class. More...
 
DtSuspendedTaskStatusList mySuspendedTaskStatusList
 
DtRwInt myNextTaskId
 The next available ID that can be assigned to a task for this entity. More...
 
DtRwInt myNextSuspendId
 
DtRwBoolean myParentWasDestroyedWhenEmbarked
 Set to true when the entity is embarked on a destroyed parent so they do not become destroyed. More...
 
DtRwBoolean myNavigationEnabled
 Whether or not this object can navigate in navigation areas. Default is true. More...
 
DtRwPriorityTargetListMap myTargetPriorityList
 Target Priority List. More...
 
const DtVrfObjectParametersmyParameterEntry
 For performance and memory usage reasons, the copy of the parameter entry that used to be made when creating a state repository is no longer made when the state repository is initialized. More...
 
DtVrfObjectParametersmyParameters
 this is the parameter entry that this repository created. More...
 
double myMinTickPeriod
 For variable tick rate support. More...
 
double myMinTickPeriodVariance
 
double myNextTickTime
 
double myLastTickSimTime
 
DtAttachedTerrainmyTerrainAttachedTo
 
DtSignatureModifierEvalMap mySignatureModifierEvalMap
 Map which holds a set of lists of signature modifier evaluators indexed by sensor domain. More...
 
DtSensorSignatureCacheMap myMutableSensorSignatureCacheMap
 Maintains the current sensor signature (indexed by sensor domain) for this entity. More...
 
DtSensorContactInfoList myObjectContactList
 The situational awareness of this object. More...
 
DtPostInitializeFromParametersCallbackList myPostInitFromParamsCallbackList
 
DtRangeItems myRangeItems
 Range item information. More...
 
DtRwProperties myStateProperties
 Additional properties that are part of this state repository. More...
 
DtRwProperties myParameterProperties
 
ExtendedData myExtendedData
 
DtRwStringAttributeList myRwExtendedData
 
bool myUsingTempStateProperties
 
DtRwProperties myTempStateProperties
 
std::vector< DtStringmyStatePropertiesNotToBeRestored
 The list of state properties that should not be updated by restoreStateProperties. More...
 
tbb::mutex myEvaluateSensorSignatureMutex
 
JoystickControls myJoystickControls
 Map of available joystick controls for this particular entity. More...
 
bool myJoystickMovementControlled
 If true movement is controlled by joystick so will not be able to be taskable as a subordinate. More...
 
DtVrfObjectCallbackList myRestoredCallbacks
 List of callbacks for when this entity is restores. More...
 
- Protected Attributes inherited from DtSimObjectStateRepository
DtVrfObjectmySimObject
 
DtRwObjectType myObjectType
 
DtVrfObjectGeometrymyObjectGeometry
 
DtVrfKinematicStatemyKinematicState
 
DtRwReal myLastPositionSetTime
 
DtAttachmentManagermyAttachments
 
DtArticulatedPartManager myArticulatedParts
 
DtSimObjectStateRepositorymyAttachedToRepository
 
DtRwUUID myAttachedToRepositoryUUID
 used for reading & writing the name of myAttachedToRepository More...
 
DtSimObjectStateRepositorymyRootSimStateRepository
 
const Coordinate_SystemmyCoordinateSystemPtr
 Caches pointer to coordinate system so it can set it after myKinematic state is created. More...
 
DtKinematicStateCSmyEmbarkedKinematicState
 
DtAboutToBeDeletedCallbacksList myRepositoryAboutToBeRemovedCallbacksList
 
tbb::spin_rw_mutex myRepositoryAboutToBeRemovedCallbacksListMutex
 
bool myOwnedByHostObject
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 
- Static Protected Attributes inherited from DtVrfObjectStateRepository
static
DtSimObjectStateRepositoryFactory
theFactory
 
static std::set< DtStringtheDoNotArchiveAttributes
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Detailed Description

Class: DtSurfaceEntityStateRepository.

Used to override place method to correctly ground clamp or not depending on requested placed position

Constructor & Destructor Documentation

DtSubsurfaceEntityStateRepository::DtSubsurfaceEntityStateRepository ( )
protected

default constructor cannot be used

DtSubsurfaceEntityStateRepository::DtSubsurfaceEntityStateRepository ( DtVrfObject vrfObject,
const DtObjectType objectType,
DtVrfObjectParameters parameters,
const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)

Constructor with parameters to set up read/writability correctly.

DtSubsurfaceEntityStateRepository::DtSubsurfaceEntityStateRepository ( const DtSubsurfaceEntityStateRepository orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

virtual DtSubsurfaceEntityStateRepository::~DtSubsurfaceEntityStateRepository ( )
virtual

destructor

Member Function Documentation

static DtVrfObjectStateRepository* DtSubsurfaceEntityStateRepository::creator ( const DtString name,
DtVrfObject vrfObject,
const DtObjectType objectType,
DtVrfObjectParameters parameters,
DtReaderWriterRegistry parentRegistry 
)
static
const DtSubsurfaceEntityStateRepository& DtSubsurfaceEntityStateRepository::operator= ( const DtSubsurfaceEntityStateRepository orig)

assignment operator

virtual DtString DtSubsurfaceEntityStateRepository::type ( ) const
virtual
Returns
The string type of the repository, as defined in vrfSRTypes.h.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtSubsurfaceEntityStateRepository::vrfMovingObjectStateRepositorySubType ( ) const
virtual
Returns
DtVrfMovingObjectStateRepositorySubTypeSurface.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual void DtSubsurfaceEntityStateRepository::place ( const DtVector location,
const DtReal  heading,
bool  clampToGroundFlag = true,
bool dataAvailable = 0,
bool  requireAllData = false 
)
virtual

Overriden from base class to check altitude of location.

If altitude is within a certain buffer of the ground polygon (or nearest polygon) then clamp else do not clamp and set the myClampToGround flag as false. If this is a subsurface type then also clamp if trying to place in air, else let the placement go (as in torpedoes can be air launched).

Reimplemented from DtVrfMovingObjectStateRepository.


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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)