VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtFixedWingEntityStateRepository Class Reference

This repository holds all information that is common to all the forms of local fixed wing entities within the system. More...

Inheritance diagram for DtFixedWingEntityStateRepository:
Inheritance graph
[legend]

Public Member Functions

 DtFixedWingEntityStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 Constructor with parameters to set up read/writability correctly.
 DtFixedWingEntityStateRepository (const DtFixedWingEntityStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const
DtFixedWingEntityStateRepository
operator= (const DtFixedWingEntityStateRepository &orig)
 assignment operator
virtual ~DtFixedWingEntityStateRepository ()
 destructor
virtual bool init ()
 Our 'virtual' constructor. Calls all the create<>() methods.
virtual DtString type () const
 Returns the string type of the repository, as defined in vrfSRTypes.h.
virtual const int vrfMovingObjectStateRepositorySubType () const
 Returns DtVrfMovingObjectStateRepositorySubTypeFixedWing.
virtual const int fixedWingEntityStateRepositorySubType () const
 Returns DtFixedWingEntityStateRepositorySubTypeBase.
virtual bool createParameters ()
virtual void initializeFromParameters ()
virtual const
DtFixedWingEntityParameters
fixedWingEntityParameters () const
virtual DtReal AOA () const
 Current angle of attack.
virtual void setAOA (DtReal aoa)
virtual DtReal minLiftSpeed () const
 Parameters: Min-lift-speed - below this speed no lift is generated.
virtual void setMinLiftSpeed (DtReal minLiftSpeed)
virtual DtReal maxAltitude () const
 Max-altitude - above this altitude no lift is generated.
virtual void setMaxAltitude (DtReal maxAltitude)
virtual DtReal maxYawRate () const
 Max-yaw-rate - the maximum, in rad/s, this plane can rotate about its Z axis (due to pedal).
virtual void setMaxYawRate (DtReal maxYawRate)
virtual DtReal maxPitchRate () const
 Max-pitch-rate - the maximum rate this plane can pitch down or up about its Y axis (due to stick).
virtual void setMaxPitchRate (DtReal maxPitchRate)
virtual DtReal maxRollRate () const
 Max-roll-rate - the maximum rate this plane can rotate about its X axis (due to stick).
virtual void setMaxRollRate (DtReal maxRollRate)
virtual DtReal maxClimbRate () const
 Max-Angle-Of-Attack - above this AOA, no lift is generated.
virtual void setMaxClimbRate (DtReal maxClimbRate)
virtual DtReal orderedAltitude () const
 As specifeed by a setAltitude command, or the Z parameter of a destination waypoint.
virtual void setOrderedAltitude (DtReal orderedAltitude)
virtual DtReal orderedGroundSpeed () const
virtual void setOrderedGroundSpeed (DtReal orderedGroundSpeed)
virtual DtReal maxGroundSpeed () const
virtual void setMaxGroundSpeed (DtReal maxGroundSpeed)
virtual DtReal maxGroundStoppingDeceleration () const
virtual void setMaxGroundStoppingDeceleration (DtReal maxGroundStoppingDeceleration)
virtual DtReal groundTurningRadius () const
virtual void setGroundTurningRadius (DtReal groundTurningRadius)
virtual DtReal maxGroundSlope () const
virtual void setMaxGroundSlope (DtReal maxGroundSlope)
virtual bool onGround () const
 The specifies whether or not the entity is on the ground.
virtual void setOnGround (bool onGround)
 NOTE: Calls updateCurrentStateVars() automatically every time this is called in order to ensure the current state variables match the current state of the plane.
virtual void setCurrentOrderedSpeed (const double currentOrderedSpeed)
 These variables are the "current state variables." They represent what the properties of the entity are for the appropriate state, on the ground or in the air.
virtual const double currentOrderedSpeed () const
virtual void setCurrentMaxSpeed (const double currentMaxSpeed)
virtual const double currentMaxSpeed () const
virtual void setCurrentMaxStoppingDeceleration (const double currentMaxStoppingDeceleration)
virtual const double currentMaxStoppingDeceleration () const
virtual void setCurrentTurningRadius (const double currentTurningRadius)
virtual const double currentTurningRadius () const
virtual void setCurrentMaxSlope (const double currentMaxSlope)
virtual const double currentMaxSlope () const
virtual void setOnGroundTolerance (double)
virtual double onGroundTolerance () const
virtual void place (const DtVector &location, const DtReal heading, bool clampToGroundFlag=true, bool *dataAvailable=0, bool requireAllData=false)
 Places the entity at the specified location and heading.
virtual void placeAtAltitude (const DtVector &location, const DtReal heading)
 Places entity at altitude regardless of terrain.
virtual void updateCurrentStateVars ()
 Sets the proper values for the "current..." state vars depending on whether or not the plane is on the ground.
virtual const
DtGroundInteractionPt
noseSupport () const
 These are used to alias the base class otherSupport member - to help remind modelers that the 3rd support point for an air vehicle is supposed to represent the nose wheel.
virtual DtGroundInteractionPtnoseSupport ()
virtual void setNoseSupport (const DtVector &noseSupport)
virtual void restoreEntity ()
 Override to set default altitude when restored.
virtual void updateAppearanceFromState ()
 Updates attributes based on entity state.
- Public Member Functions inherited from DtVrfMovingObjectStateRepository
 DtVrfMovingObjectStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 Constructor.
 DtVrfMovingObjectStateRepository (const DtVrfMovingObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 Copy Constructor.
DtVrfMovingObjectStateRepositoryoperator= (const DtVrfMovingObjectStateRepository &orig)
 Assignment Operator.
virtual ~DtVrfMovingObjectStateRepository ()
 Destructor.
virtual
DtSimObjectStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 Clone.
virtual const int vrfObjectStateRepositorySubType () const
 Returns DtVrfObjectStateRepositorySubTypeMoving.
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
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 orderedSpeed () const
 Can be set from a parameter file or by the user with a set speed command.
virtual void setOrderedSpeed (const DtReal speed)
virtual DtReal maxAcceleration () const
virtual void setMaxAcceleration (const DtReal maxAcceleration)
virtual DtReal maxStoppingDeceleration () const
virtual void setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration)
virtual DtReal fuelEfficiency () const
virtual void setFuelEfficiency (const DtReal fuelEfficiency)
virtual DtReal inverseStoppingDeceleration () const
 Set by setting maxStoppingDeceleration.
virtual bool forward () const
virtual void setForward (const bool forward)
virtual bool amClampedToGround () const
 Specifies whether we're clamped to the ground or not.
virtual void setAmClampedToGround (const bool clamp)
virtual bool usingRailMovement () const
 Specifies the entity's desired movement strategy.
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.
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.
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.
virtual DtVector parentPosition ()
 Returns parentPosition in kinematic state.
virtual void place (const DtVector &location, bool *dataAvailable=0, bool requireAllData=false)
 Place entity at 'location', on the ground, keeping its current heading.
virtual void place (const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
 Give entity the specified 'heading', but stay at its current location.
virtual void setDIGuyCharacterInfo (DtRwDIGuyCharacterInfo *info)
 Current DI-Guy character data–Our character type, current appearance and.
virtual DtRwDIGuyCharacterInfodiGuyCharacterInfo ()
virtual void setDIGuyCharacter (const DtString &character)
 The DI-Guy Character string for this entity.
virtual const DtStringdIGuyCharacter () const
 The DI-Guy Character string for this entity.
virtual void setDIGuyAnimation (const DtString &animation)
 The current DI-Guy animation the entity is displaying.
virtual const DtStringdIGuyAnimation () const
 The current DI-Guy animation the entity is displaying.
virtual void setDIGuyAppearance (const DtString &app)
 The current Di-Guy character appearance of the entity.
virtual const DtStringdIGuyAppearance () const
 The current Di-Guy character appearance of the entity.
- Public Member Functions inherited from DtVrfObjectStateRepository
 DtVrfObjectStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 Constructor.
 DtVrfObjectStateRepository (const DtVrfObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 Copy Constructor.
const DtVrfObjectStateRepositoryoperator= (const DtVrfObjectStateRepository &orig)
 Assignment Operator.
virtual ~DtVrfObjectStateRepository ()
 Destructor.
virtual const int objectStateRepositorySubType () const
 Returns DtSimObjectStateRepositorySubTypeVrfObject.
virtual const
DtVrfObjectParameters
vrfParameters () const
virtual
DtVrfStateRepositoryUserExtension
userExtension () const
 User extension to state repository class.
virtual void restoreResourcesFromParameters ()
virtual bool inSOR (const DtVrfObject *entity) const
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.
virtual void clearCurrentTaskMsg (const DtString &componentName)
 Clear all the tasks with the specified component name.
virtual void clearCurrentTaskMsg (const DtString &componentName, int taskId)
 Clear the task with specified taskId and the specified component name.
virtual const DtTaskStatusListtaskStatusList () const
virtual DtTaskMessagecurrentTaskMsg (const DtString &componentName) const
 Get the current task message.
virtual DtTaskMessagecurrentTaskMsg (const DtString &componentName, int taskId) const
 Get the current task message for the specified component and task ID.
virtual std::list
< DtTaskMessage * > 
allCurrentTaskMsg (const DtString &componentName) const
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
 Top level call to write itself to file.
virtual bool placePoints (DtAttachedTerrain &attachedTerrain, std::vector< DtGroundInteractionPt * > groundInteractionPts, bool *terrainDataAvailable=0)
 Positions list of ground interaction points on the terrain surface closest to the specified location.
virtual const
DtVrfObjectParameters
parameters () const
virtual DtVrfObjectParametersmodifiableParameters ()
 A modifiable local copy of parameters.
virtual void setupParameterInheritance ()
 Called by init().
virtual bool createAttachments ()
 Override to create derived DtVrfAttachmentManager.
void addPart (DtArticulatedPartStateRepository *part)
 These will be replaced by equivalents in the attachment manager.
void removePart (DtArticulatedPartStateRepository *part)
DtArticulatedPartStateRepositorypart (DtArtPartType partType)
DtArticulatedPartStateRepositoryfindDescendantByType (DtArtPartType childType)
bool isEntity () const
bool isLocal () const
bool isAggregate () const
void addSubordinate (DtVrfObject *subordinateEntity)
 Adds an entity as a subordinate.
void removeSubordinate (DtVrfObject *subordinateEntity)
 Removes entity from our list of subordinates.
virtual DtVrfObjectleadEntity () const
virtual const DtStringfirstSubordinate () const
virtual const DtStringlastSubordinate () const
virtual const DtStringfirstHealthySubordinate () const
virtual void tick ()
 This method is called each simulation frame, and may include any processing that needs to be done on this object state each tick.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived (myNextTickTime <= exerciseClock()->approximateElapsedRealTime()).
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
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.
virtual void setLocalOrientationWrtDatabase (const DtTaitBryan &localOrientation)
virtual DtVrfWeaponPSRfirstWeaponPSR () const
 This is provided for backward compatibility with setTarget capabilities.
virtual void processObjectGeometry (const DtList &vertices)
 Processes a list of DtVectors, such as might come in a create or modify message.
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).
virtual const
DtVrfObjectParameters
vrfBaseParameters () const
virtual DtGroundInteractionPtgroundCenter ()
virtual const
DtGroundInteractionPt
groundCenter () const
virtual const DtVectorgetPartAttachPoint (const int partType) const
virtual void updatePositionFromModelVertices ()
 Note that this is not currently ever called.
virtual void updateBVolFromModelVertices ()
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.
virtual void createParts ()
 This causes the art part tree to be created.
virtual DtTime lastTimeFiredUpon () const
virtual void setLastTimeFiredUpon (const DtTime time)
virtual bool underFire () const
virtual void setUnderFire (bool underFire)
virtual DtDeadReckonTypes deadReckoningAlgorithm () const
virtual void setDeadReckoningAlgorithm (DtDeadReckonTypes deadReckoningAlgorithm)
virtual void putData (FILE *fp, int indentLevel=0)
 Override putData to set myParentName using the organization manager before saving.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Override getSelf to handle mapping of old pre-2.0 oob files.
virtual int nextTaskId ()
 Returns next unique task id for this VR-Forces back-end.
virtual DtTaskMessagependingSubtask (int subtaskId, DtString &controller) const
 Returns the current subtask with the specified id.
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.
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.
virtual void attachToParent (DtString parent)
 Looks up the parent state repository using the given echelon ID and puts it in a call to attachToParent.
virtual void addAttachedTerrain (const DtString &parent)
 Asks the sim manager to look up the object model for the requested database.
virtual void removeAttachedTerrain (const DtString &parent)
 Decreases reference count of terrain model by name of object.
Dt3dBoundingVolume * boundingVolume () const
 Convenience method for accessing entity's bounding volume, stored in myObjectGeometry.
DtReal forwardSpeed () const
virtual void addRangeItem (const DtRangeItem &)
 Adds, removes and returns items in the range item list.
virtual void removeRangeItem (int index)
virtual void setRangeItems (const DtRangeItems &)
const DtRangeItemsrangeItems () const
DtRangeItemsrangeItems ()
virtual void clearRangeItems ()
DtAttachedTerrainterrainAttachedTo () const
virtual double sensorSignature (const DtSymbolString &sensorDomain) const
 Returns the current absolute signature for this object in the specified sensor domain.
virtual std::list< DtSymbolStringsensorSignatureDomains () const
virtual
DtVrfObjectStateRepository
toVrfObjectStateRepository ()
virtual const
DtVrfObjectStateRepository
toVrfObjectStateRepository () const
virtual const
DtObjectResourceManager
objectResourceManager () const
virtual DtObjectResourceManagerobjectResourceManager ()
virtual const
DtSimResourceManager
oldResourceManager () const
 Returns a reference to our resource manager.
virtual DtSimResourceManageroldResourceManager ()
 Returns a reference to our resource manager.
virtual DtSimResourceoldLookupResource (const DtString &resourceName)
 Gets a pointer to the resource named resourceName.
virtual const DtSimResourceoldLookupResource (const DtString &resourceName) const
 Returns a reference to our resource manager.
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.
virtual void oldRemoveResource (DtSimResource *resource)
 This removes and deletes the specified resource.
virtual void setSOR (DtReal center, DtReal size)
 Sector of responsibility.
virtual DtReal SORSize () const
 Sector of responsibility.
virtual DtReal SORCenter () const
 Sector of responsibility.
virtual const DtSimSectorSOR () const
 Sector of responsibility.
virtual void setRequestTaskNeeded (bool value)
 Set/get whether or not this needs to send a request task needed message.
virtual bool requestTaskNeeded () const
 Set/get whether or not this needs to send a request task needed message.
virtual void setTasked (const DtString &componentName, bool tasked)
 Set/get whether or not a given entity component currently executing a task.
virtual bool tasked (const DtString &componentName) const
 Set/get whether or not a given entity component currently executing a task.
virtual void setCurrentTaskMsg (const DtString &componentName, const DtTaskMessage &taskMsg)
 Set the current task message.
virtual void setCurrentTaskMsg (const DtString &componentName, const DtTaskMessage &taskMsg, int taskId)
 Set the current task message.
virtual void setIndependentlyTasked (bool value)
 Set/get whether or not this entity is currently independently tasked (separately from its unit).
virtual bool independentlyTasked () const
 Set/get whether or not this entity is currently independently tasked (separately from its unit).
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.
virtual void setParameterEntry (DtVrfObjectParameters *parameterEntry)
 If a clone has been created, this call will return the cloned entry as a const pointer, else returns the original pointer.
virtual DtForceType forceType () const
 Get/Set the force type (team) of this entity.
virtual void setForceType (DtForceType force)
 Get/Set the force type (team) of this entity.
virtual bool createAppearance ()
 Encapsulates all the appearance related data and methods currently in the entity state repository.
virtual const DtAppearance * appearance () const
 Encapsulates all the appearance related data and methods currently in the entity state repository.
virtual DtAppearance * appearance ()
 Encapsulates all the appearance related data and methods currently in the entity state repository.
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.
virtual int capabilities () const
 Gets/sets capabilities of entity This is treated as the DIS capabilities bit field, and does not necessarily change any behaviors of the object.
void setDestroyed (bool isDestroyed)
 Destroyed status of entity (whether or not appearance()->damageState() is set to DtDamageDestroyed).
bool isDestroyed () const
 Destroyed status of entity (whether or not appearance()->damageState() is set to DtDamageDestroyed).
DtReal healthPct () const
void setHealthPct (DtReal pct)
bool firePowerKilled () const
 Convenience methods for setting setting entity's appearance bits in DtAppearance.
void setFirePowerKilled (const bool firePowerKilled)
 Convenience methods for setting setting entity's appearance bits in DtAppearance.
bool mobilityKilled () const
 Convenience methods for setting setting entity's appearance bits in DtAppearance.
void setMobilityKilled (const bool mobilityKilled)
 Convenience methods for setting setting entity's appearance bits in DtAppearance.
bool flaming () const
 Convenience methods for setting setting entity's appearance bits in DtAppearance.
void setFlaming (const bool flaming)
 Convenience methods for setting setting entity's appearance bits in DtAppearance.
bool smoking () const
 Convenience methods for setting setting entity's appearance bits in DtAppearance.
void setSmoking (const bool smoking)
 Convenience methods for setting setting entity's appearance bits in DtAppearance.
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.
virtual void setDeadReckoningThresholder (const DtThresholder &thresholder)
 Dead-reckoning threshold parameters.
virtual const DtEntityIdentifier & occupyingObjectId () const
 We hold the id of the object we are occupying.
virtual void setOccupyingObjectId (const DtEntityIdentifier &objId)
 We hold the id of the object we are occupying.
virtual void setEchelonId (const DtEchelonId &echelonId)
 The echelon ID of this object, if it is an organized object.
virtual DtEchelonIdechelonId ()
 The echelon ID of this object, if it is an organized object.
virtual const DtEchelonIdechelonId () const
 The echelon ID of this object, if it is an organized object.
virtual void setIsSubordinateOfForceLevel (bool yesNo)
 Indicates if this object's direct superior is a Force level object.
virtual bool isSubordinateOfForceLevel () const
 Indicates if this object's direct superior is a Force level object.
virtual void addPendingSubtaskId (const DtString &componentName, int subtaskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void addPendingSubtaskId (const DtString &componentName, int taskId, int subtaskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual bool findPendingSubtaskId (const DtString &componentName, int subtaskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual bool findPendingSubtaskId (const DtString &componentName, int taskId, int subtaskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void removePendingSubtaskId (const DtString &componentName, int subtaskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void removePendingSubtaskId (const DtString &componentName, int taskId, int subtaskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void removeAllPendingSubtaskIds (const DtString &componentName)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void removeAllPendingSubtaskIds (const DtString &componentName, int taskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void printPendingSubtaskIds (const DtString &componentName) const
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual std::vector< int > currentPendingSubstaskIds (const DtString &componentName) const
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual std::vector< int > currentPendingSubstaskIds (const DtString &componentName, int taskId) const
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual DtSubtaskStatusEntrypendingSubtaskStatus (const DtString &componentName, int subtaskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual DtSubtaskStatusEntrypendingSubtaskStatus (const DtString &componentName, int taskId, int subtaskId)
 Functions for manipulating the set of pending subtask Ids for all components in the entity.
DtReal currentSpeed () const
 Returns magnitude of relative velocity in state repository.
DtReal currentHeading () const
 Heading in radians. Calls down to DtVrfKinematicState for heading.
void setCurrentHeading (const DtReal heading)
 Heading in radians. Calls down to DtVrfKinematicState for heading.
virtual void addPostInitFromParamsCallback (DtPostInitializeFromParametersCallbackFcn fcn, void *usr)
 Add/remove callback function to be invoked immediately following execution of initializeFromParameters.
virtual void removePostInitFromParamsCallback (DtPostInitializeFromParametersCallbackFcn fcn, void *usr)
 Add/remove callback function to be invoked immediately following execution of initializeFromParameters.
virtual DtSensorContactInfoListobjectContactList ()
 Situational awareness of this object.
virtual const
DtSensorContactInfoList
objectContactList () const
 Situational awareness of this object.
virtual void processObjectAddedCallback (DtVrfObject *vrfObject)
 These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
virtual void processObjectAboutToBeRemovedCallback (DtVrfObject *vrfObject)
 These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
virtual void processTaskComplete (const DtVrfObjectMessage *msg)
 Handles state changes for the subtask status list.
- 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.
virtual DtVrfKinematicStatevrfKinematicState ()
virtual const DtVrfKinematicStatevrfKinematicState () const
virtual bool createObjectGeometry ()
virtual DtVrfObjectGeometryvrfObjectGeometry ()
virtual const DtVrfObjectGeometryvrfObjectGeometry () const
virtual DtAttachmentManagerattachments ()
virtual const DtAttachmentManagerattachments () const
virtual
DtSimObjectStateRepository
parent ()
virtual const
DtSimObjectStateRepository
parent () const
virtual bool isEmbarkedOn (const DtString &parent) const
virtual const DtStringattachedToRepositoryName ()
virtual
DtSimObjectStateRepository
findRootSimStateRepository ()
virtual const
DtSimObjectStateRepository
findRootSimStateRepository () const
virtual void ancestorObjectChanged ()
virtual void preGetSelf ()
 Hook function called immediately prior to getSelf().
virtual void postGetSelf ()
 Hook function called immediately following getSelf().
virtual void setCoordinateSystem (const Coordinate_System *coordinateSystem)
 Sets the coordinate system in myObjectGeometry and myKinematicState.
virtual DtVrfObjectvrfObject ()
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.
virtual void setBodyPosition (const DtVector &pos)
 Formerly setMeInParent.
virtual void setBodyPosition (DtFloat64 x, DtFloat64 y, DtFloat64 z)
const DtDcm & bodyOrientationMatrix () const
 Formerly meToParent().
virtual void embarkOnParent (const DtString &parent)
 Embarks this entity on the specified parent.
virtual bool leftOf (const DtVector &localVector) const
virtual bool inside (const DtVector &point) const
virtual void removeVertex (int iIndex)
 These routines simply call down to the kinematic state to get/set the results.
virtual void addLocalVertex (const DtVector &vertex)
 These routines simply call down to the kinematic state to get/set the results.
virtual void addLocalVertex (const DtVector &vertex, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual void setLocalVertices (const DtLocalVertexList &vertices, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual void setLocalVertices (const DtList &vertices, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual const DtLocalVertexListlocalVertices () const
 These routines simply call down to the kinematic state to get/set the results.
virtual const
DtLocalVectorIterator
localVertexIterator () const
 These routines simply call down to the kinematic state to get/set the results.
virtual void addWorldVertex (const DtVector &vertex, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual void setWorldVertices (const DtVertexList &vertices, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual void setWorldVertices (const DtList &vertices, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual const DtVertexListworldVertices () const
 These routines simply call down to the kinematic state to get/set the results.
virtual const DtRwVectorIteratorworldVertexIterator () const
 These routines simply call down to the kinematic state to get/set the results.
virtual void setRelativeVertices (const DtLocalVertexList &vertices)
 Access/modify vertices relative to to the parent to which this object is attached.
virtual void setRelativeVertices (const DtList &vertices)
 Access/modify vertices relative to to the parent to which this object is attached.
virtual const DtLocalVertexListrelativeVertices () const
 Access/modify vertices relative to to the parent to which this object is attached.
virtual const
DtLocalVectorIterator
relativeVertexIterator () const
 Access/modify vertices relative to to the parent to which this object is attached.
const DtVectorlocalPosition () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalPosition (const DtVector &pos)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorlocalVelocity () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalVelocity (const DtVector &vel)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorlocalAcceleration () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalAcceleration (const DtVector &acc)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorrelativeVelocity () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setRelativeVelocity (const DtVector &vel)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorrelativeAcceleration () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setRelativeAcceleration (const DtVector &acc)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtTaitBryan & localOrientation () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalOrientation (const DtTaitBryan &angles)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorworldPosition () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setWorldPosition (const DtVector &pos)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorworldVelocity () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setWorldVelocity (const DtVector &vel)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorworldAcceleration () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setWorldAcceleration (const DtVector &acc)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtTaitBryan & worldOrientation () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setWorldOrientation (const DtTaitBryan &angles)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorrotationalVelocity () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setRotationalVelocity (const DtVector &rotationalVelocity)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtDcm & localOrientationMatrix () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalOrientationMatrix (const DtDcm &orient)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void writeSelf (FILE *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.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
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.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions

static DtVrfObjectStateRepositorycreator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
static
DtFixedWingEntityStateRepository
isFixedWingEntityStateRepository (DtSimObjectStateRepository *repository)
 Returns a the pointer the repository, if the repository passed in is of type DtFixedWingEntityStateRepository, 0 if not.
static const
DtFixedWingEntityStateRepository
isFixedWingEntityStateRepository (const DtSimObjectStateRepository *repository)
- Static Public Member Functions inherited from DtVrfMovingObjectStateRepository
static
DtVrfMovingObjectStateRepository
isVrfMovingObjectStateRepository (DtSimObjectStateRepository *repository)
static const
DtVrfMovingObjectStateRepository
isVrfMovingObjectStateRepository (const DtSimObjectStateRepository *repository)
- Static Public Member Functions inherited from DtVrfObjectStateRepository
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.
static void addSimObjectStateRepositoryCreatorFcn (const DtString &type, DtSimObjectStateRepositoryCreatorFcn fcn)
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.
static void setFactory (DtSimObjectStateRepositoryFactory *factory)
 a DtSimObjectStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void objectAddedCallback (DtVrfObject *vrfObject, void *usr)
 These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
static void objectAboutToBeRemovedCallback (DtVrfObject *vrfObject, void *usr)
 These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
static void taskCompleteCallback (const DtVrfObjectMessage *msg, void *usr)
 Handles state changes for the subtask status list.
- Static Public Member Functions inherited from DtSimObjectStateRepository
static DtSimObjectStateRepositoryisSimObjectStateRepository (DtSimObjectStateRepository *repository)
static const
DtSimObjectStateRepository
isSimObjectStateRepository (const DtSimObjectStateRepository *repository)
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.

Protected Member Functions

 DtFixedWingEntityStateRepository ()
 default constructor cannot be used
- Protected Member Functions inherited from DtVrfMovingObjectStateRepository
 DtVrfMovingObjectStateRepository ()
 Default Constructor. Do not use.
- Protected Member Functions inherited from DtVrfObjectStateRepository
 DtVrfObjectStateRepository ()
 Default Constructor. Do not use.
virtual void initializeNextTaskId ()
 Initializes myNextTaskId to the next highest integer than the highest subtask Id currently maintained in myTaskStatusList.
virtual void setOrientationRelativeToParent ()
 If attached to a parent, and a terrain database is present, set orientation relative to parent.
virtual DtAttachedTerraincreateAttachedTerrain ()
virtual
DtArticulatedPartStateRepository
createArtPartStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString())
 Returns new instance of a DtArticulatedPartStateRepository.
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.
virtual bool initSignatureEvaluators ()
 Sets up all the sensor signature evaluators in mySignatureEvalMap based on the parameter entry for this entity.
void clearSignatureEvaluators ()
 Removes and deletes all signature evaluators.
virtual bool createObjectResourceManager ()
 Creates and sets myObjectResourceManager.
virtual void invokePostInitFromParamsCallbacks ()
 Invokes all callbacks registered via a call to addPostInitFromParamsCallback.
- Protected Member Functions inherited from DtSimObjectStateRepository
 DtSimObjectStateRepository (const DtSimObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 DtSimObjectStateRepository ()
 Default Constructor; not implemented.
const Coordinate_SystemcoordinateSystem () const
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
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.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.

Protected Attributes

DtRwReal myAOA
DtRwReal myMinLiftSpeed
DtRwReal myMaxAltitude
DtRwReal myOrderedAltitude
DtRwReal myMaxClimbRate
DtRwReal myMaxYawRate
DtRwReal myMaxPitchRate
DtRwReal myMaxRollRate
DtRwReal myOrderedGroundSpeed
DtRwReal myMaxGroundSpeed
DtRwReal myMaxGroundStoppingDeceleration
DtRwReal myGroundTurningRadius
DtRwReal myMaxGroundSlope
DtRwBoolean myOnGround
DtRwReal myCurrentOrderedSpeed
 These variables are used to represent the values for the current state of the FWE - for flying or driving on the ground.
DtRwReal myCurrentMaxSpeed
DtRwReal myCurrentMaxStoppingDeceleration
DtRwReal myCurrentTurningRadius
DtRwReal myCurrentMaxSlope
DtRwReal myOnGroundTolerance
 The value (in meters) that if a fixed wing is within this tolerance and the ground, it is considered on ground.
- Protected Attributes inherited from DtVrfMovingObjectStateRepository
DtGroundInteractionPt myLeftSupport
DtGroundInteractionPt myRightSupport
DtGroundInteractionPt myOtherSupport
DtRwReal myOrderedSpeed
DtRwReal myMaxSpeed
DtRwReal myMaxReverseSpeed
DtRwReal myTurningRadius
DtRwReal myMaxSlope
DtRwBoolean myForward
DtRwReal myMaxAcceleration
DtRwReal myMaxStoppingDeceleration
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.
DtRwReal myMaxPivotSpeed
DtRwDIGuyCharacterInfomyDIGuyCharacterInfo
DtReal myInverseStoppingDeceleration
 Derived quantity (1/myMaxStoppingDeceleration) - no need to make it read-write.
- Protected Attributes inherited from DtVrfObjectStateRepository
DtVrfStateRepositoryUserExtensionmyStateRepositoryUserExtension
DtRwAppearancemyAppearance
DtRwInt myCapabilities
DtRwForceType myForceType
DtVrfSubordinateManagermySubordinates
 each of these has_a DtSubObjectManager
DtRwString myParentName
 if this object is a subordinate, this is used to write out the name of the parent
DtVrfProcessStateRepositoryManagermySystemProcessSRManager
DtLegacyProcessStateRepositoryManagermyLegacyPSRManager
 Used only to read in scenarios from pre VRF 3.11.
DtSimManagermySimManager
DtGroundInteractionPt myGroundCenter
bool myUnderFire
 Under fire parameters.
DtTime myLastTimeFiredUpon
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.
DtManagedObjectListConstPtr myVisibilityFilterList
 Shared list of visibility blocking objects.
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.
DtRwTaitBryan myLocalOrientation
DtRwBoolean myIsDestroyedFlag
DtEchelonId myEchelonId
DtRwBoolean myIsSubordinateOfForceLevel
DtRwInt myDesignator
 myDesignator is used for reading and writing only and is not valid at runtime.
DtRwBoolean myIndependentlyTasked
DtSimResourceManager myResourceManager
 This resource manager is used for all the top-level resource only.
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.
DtRwBoolean myRequestTaskNeeded
 Moved here from the DtLocalTaskManager class.
DtTaskStatusList myTaskStatusList
 Contains the myTasked and myCurrentTaskMsg members from the DtTaskControllerComponent class.
DtRwInt myNextTaskId
 The next available ID that can be assigned to a task for this entity.
DtRwBoolean myParentWasDestroyedWhenEmbarked
 Set to true when the entity is embarked on a destroyed parent so they do not become destroyed.
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.
DtVrfObjectParametersmyParameters
 this is the parameter entry that this repository created.
double myMinTickPeriod
 For variable tick rate support.
double myMinTickPeriodVariance
double myNextTickTime
double myLastTickSimTime
DtAttachedTerrainmyTerrainAttachedTo
DtSignatureModifierEvalMap mySignatureModifierEvalMap
 Map which holds a set of lists of signature modifier evaluators indexed by sensor domain.
DtSensorSignatureCacheMap myMutableSensorSignatureCacheMap
 Maintains the current sensor signature (indexed by sensor domain) for this entity.
DtSensorContactInfoList myObjectContactList
 The situational awareness of this object.
DtPostInitializeFromParametersCallbackList myPostInitFromParamsCallbackList
DtRangeItems myRangeItems
 Range item information.
- Protected Attributes inherited from DtSimObjectStateRepository
DtVrfObjectmySimObject
DtRwObjectType myObjectType
DtVrfObjectGeometrymyObjectGeometry
DtVrfKinematicStatemyKinematicState
DtAttachmentManagermyAttachments
DtSimObjectStateRepositorymyAttachedToRepository
DtRwString myAttachedToRepositoryName
 used for reading & writing the name of myAttachedToRepository
DtSimObjectStateRepositorymyRootSimStateRepository
const Coordinate_SystemmyCoordinateSystemPtr
 Caches pointer to coordinate system so it can set it after myKinematic state is created.
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

Additional Inherited Members

- 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::pair
< DtSymbolString, DtString
DtVariableNameType
- Protected Types inherited from DtVrfObjectStateRepository
typedef std::list
< DtSignatureModifierEvaluator * > 
DtSignatureModifierEvalList
typedef std::map
< DtSymbolString,
DtSignatureModifierEvalList * > 
DtSignatureModifierEvalMap
typedef std::map
< DtSymbolString, double > 
DtSensorSignatureCacheMap
typedef std::pair
< DtPostInitializeFromParametersCallbackFcn,
void * > 
DtPostInitializeFromParametersInfo
typedef std::list
< DtPostInitializeFromParametersInfo
DtPostInitializeFromParametersCallbackList
- 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.
- Static Protected Attributes inherited from DtVrfObjectStateRepository
static
DtSimObjectStateRepositoryFactory
theFactory

Detailed Description

This repository holds all information that is common to all the forms of local fixed wing entities within the system.

It contains a pointer to the fixed wing entity parameters, and provides accessors and mutators for all parameter values.

Constructor & Destructor Documentation

DtFixedWingEntityStateRepository::DtFixedWingEntityStateRepository ( )
protected

default constructor cannot be used

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

Constructor with parameters to set up read/writability correctly.

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

copy constructor

virtual DtFixedWingEntityStateRepository::~DtFixedWingEntityStateRepository ( )
virtual

destructor

Member Function Documentation

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

assignment operator

virtual bool DtFixedWingEntityStateRepository::init ( )
virtual

Our 'virtual' constructor. Calls all the create<>() methods.

Reimplemented from DtVrfObjectStateRepository.

virtual DtString DtFixedWingEntityStateRepository::type ( ) const
virtual

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

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtFixedWingEntityStateRepository::vrfMovingObjectStateRepositorySubType ( ) const
virtual

Returns DtVrfMovingObjectStateRepositorySubTypeFixedWing.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtFixedWingEntityStateRepository::fixedWingEntityStateRepositorySubType ( ) const
virtual

Returns DtFixedWingEntityStateRepositorySubTypeBase.

virtual bool DtFixedWingEntityStateRepository::createParameters ( )
virtual

Reimplemented from DtVrfMovingObjectStateRepository.

virtual void DtFixedWingEntityStateRepository::initializeFromParameters ( )
virtual

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const DtFixedWingEntityParameters* DtFixedWingEntityStateRepository::fixedWingEntityParameters ( ) const
virtual
virtual DtReal DtFixedWingEntityStateRepository::AOA ( ) const
virtual

Current angle of attack.

virtual void DtFixedWingEntityStateRepository::setAOA ( DtReal  aoa)
virtual
virtual DtReal DtFixedWingEntityStateRepository::minLiftSpeed ( ) const
virtual

Parameters: Min-lift-speed - below this speed no lift is generated.

virtual void DtFixedWingEntityStateRepository::setMinLiftSpeed ( DtReal  minLiftSpeed)
virtual
virtual DtReal DtFixedWingEntityStateRepository::maxAltitude ( ) const
virtual

Max-altitude - above this altitude no lift is generated.

virtual void DtFixedWingEntityStateRepository::setMaxAltitude ( DtReal  maxAltitude)
virtual
virtual DtReal DtFixedWingEntityStateRepository::maxYawRate ( ) const
virtual

Max-yaw-rate - the maximum, in rad/s, this plane can rotate about its Z axis (due to pedal).

virtual void DtFixedWingEntityStateRepository::setMaxYawRate ( DtReal  maxYawRate)
virtual
virtual DtReal DtFixedWingEntityStateRepository::maxPitchRate ( ) const
virtual

Max-pitch-rate - the maximum rate this plane can pitch down or up about its Y axis (due to stick).

virtual void DtFixedWingEntityStateRepository::setMaxPitchRate ( DtReal  maxPitchRate)
virtual
virtual DtReal DtFixedWingEntityStateRepository::maxRollRate ( ) const
virtual

Max-roll-rate - the maximum rate this plane can rotate about its X axis (due to stick).

virtual void DtFixedWingEntityStateRepository::setMaxRollRate ( DtReal  maxRollRate)
virtual
virtual DtReal DtFixedWingEntityStateRepository::maxClimbRate ( ) const
virtual

Max-Angle-Of-Attack - above this AOA, no lift is generated.

virtual void DtFixedWingEntityStateRepository::setMaxClimbRate ( DtReal  maxClimbRate)
virtual
virtual DtReal DtFixedWingEntityStateRepository::orderedAltitude ( ) const
virtual

As specifeed by a setAltitude command, or the Z parameter of a destination waypoint.

virtual void DtFixedWingEntityStateRepository::setOrderedAltitude ( DtReal  orderedAltitude)
virtual
virtual DtReal DtFixedWingEntityStateRepository::orderedGroundSpeed ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setOrderedGroundSpeed ( DtReal  orderedGroundSpeed)
virtual
virtual DtReal DtFixedWingEntityStateRepository::maxGroundSpeed ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setMaxGroundSpeed ( DtReal  maxGroundSpeed)
virtual
virtual DtReal DtFixedWingEntityStateRepository::maxGroundStoppingDeceleration ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setMaxGroundStoppingDeceleration ( DtReal  maxGroundStoppingDeceleration)
virtual
virtual DtReal DtFixedWingEntityStateRepository::groundTurningRadius ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setGroundTurningRadius ( DtReal  groundTurningRadius)
virtual
virtual DtReal DtFixedWingEntityStateRepository::maxGroundSlope ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setMaxGroundSlope ( DtReal  maxGroundSlope)
virtual
virtual bool DtFixedWingEntityStateRepository::onGround ( ) const
virtual

The specifies whether or not the entity is on the ground.

It does NOT specify whether or not the entity is at the same altitude as the terrain or below it or at 0 altitude.

virtual void DtFixedWingEntityStateRepository::setOnGround ( bool  onGround)
virtual

NOTE: Calls updateCurrentStateVars() automatically every time this is called in order to ensure the current state variables match the current state of the plane.

virtual void DtFixedWingEntityStateRepository::setCurrentOrderedSpeed ( const double  currentOrderedSpeed)
virtual

These variables are the "current state variables." They represent what the properties of the entity are for the appropriate state, on the ground or in the air.

They are updated appropriately when setOnGround is called.

virtual const double DtFixedWingEntityStateRepository::currentOrderedSpeed ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setCurrentMaxSpeed ( const double  currentMaxSpeed)
virtual
virtual const double DtFixedWingEntityStateRepository::currentMaxSpeed ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setCurrentMaxStoppingDeceleration ( const double  currentMaxStoppingDeceleration)
virtual
virtual const double DtFixedWingEntityStateRepository::currentMaxStoppingDeceleration ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setCurrentTurningRadius ( const double  currentTurningRadius)
virtual
virtual const double DtFixedWingEntityStateRepository::currentTurningRadius ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setCurrentMaxSlope ( const double  currentMaxSlope)
virtual
virtual const double DtFixedWingEntityStateRepository::currentMaxSlope ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::setOnGroundTolerance ( double  )
virtual
virtual double DtFixedWingEntityStateRepository::onGroundTolerance ( ) const
virtual
virtual void DtFixedWingEntityStateRepository::place ( const DtVector location,
const DtReal  heading,
bool  clampToGroundFlag = true,
bool dataAvailable = 0,
bool  requireAllData = false 
)
virtual

Places the entity at the specified location and heading.

If the location is within, or less than, myOnGroundTolerance of the height of the terrain, or it is the first time place is being called, the entity is clamped to the ground. Otherwise, it will place it in the air by calling placeAtAltitude in which case #dataAvailable is always set to true (as there will be no terrain intersections which might block). If the altitude is greater than the maximum altitude then it will clamp it to the maximum altitude. It will also ensure all ground/air state is set appropriately. Current speed will be set appropriately for the entity, depending on state change. Air -> ground Current speed is clamped to be no more than 1 less than the minimum lift speed or the ordered ground speed, whichever is lower. Ground -> Air Current speed is set to be the greater of the minimum lift speed or the ordered speed (ordered air speed).

Parameters
Output
dataAvailableprevents the call from blocking due to terrain paging and will get a true value if the terrain intersections are successful. See DtVrfMovingObjectStateRepository::clampToGround for more information.
requireAllDataif dataAvailable is set and requireAllData is true, when the result of any terrain intersection causes dataAvailable to be set to false no changes will be made to the object.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual void DtFixedWingEntityStateRepository::placeAtAltitude ( const DtVector location,
const DtReal  heading 
)
virtual

Places entity at altitude regardless of terrain.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual void DtFixedWingEntityStateRepository::updateCurrentStateVars ( )
virtual

Sets the proper values for the "current..." state vars depending on whether or not the plane is on the ground.

virtual const DtGroundInteractionPt* DtFixedWingEntityStateRepository::noseSupport ( ) const
virtual

These are used to alias the base class otherSupport member - to help remind modelers that the 3rd support point for an air vehicle is supposed to represent the nose wheel.

virtual DtGroundInteractionPt* DtFixedWingEntityStateRepository::noseSupport ( )
virtual
virtual void DtFixedWingEntityStateRepository::setNoseSupport ( const DtVector noseSupport)
virtual
static DtVrfObjectStateRepository* DtFixedWingEntityStateRepository::creator ( const DtString name,
DtVrfObject vrfObject,
const DtObjectType objectType,
DtVrfObjectParameters parameters,
DtReaderWriterRegistry parentRegistry 
)
static

Reimplemented from DtVrfMovingObjectStateRepository.

static DtFixedWingEntityStateRepository* DtFixedWingEntityStateRepository::isFixedWingEntityStateRepository ( DtSimObjectStateRepository repository)
static

Returns a the pointer the repository, if the repository passed in is of type DtFixedWingEntityStateRepository, 0 if not.

static const DtFixedWingEntityStateRepository* DtFixedWingEntityStateRepository::isFixedWingEntityStateRepository ( const DtSimObjectStateRepository repository)
static
virtual void DtFixedWingEntityStateRepository::restoreEntity ( )
virtual

Override to set default altitude when restored.

Reimplemented from DtVrfObjectStateRepository.

virtual void DtFixedWingEntityStateRepository::updateAppearanceFromState ( )
virtual

Updates attributes based on entity state.

Currently called when ground state changes. Will set landing light on if on ground, else do not

Member Data Documentation

DtRwReal DtFixedWingEntityStateRepository::myAOA
protected
DtRwReal DtFixedWingEntityStateRepository::myMinLiftSpeed
protected
DtRwReal DtFixedWingEntityStateRepository::myMaxAltitude
protected
DtRwReal DtFixedWingEntityStateRepository::myOrderedAltitude
protected
DtRwReal DtFixedWingEntityStateRepository::myMaxClimbRate
protected
DtRwReal DtFixedWingEntityStateRepository::myMaxYawRate
protected
DtRwReal DtFixedWingEntityStateRepository::myMaxPitchRate
protected
DtRwReal DtFixedWingEntityStateRepository::myMaxRollRate
protected
DtRwReal DtFixedWingEntityStateRepository::myOrderedGroundSpeed
protected
DtRwReal DtFixedWingEntityStateRepository::myMaxGroundSpeed
protected
DtRwReal DtFixedWingEntityStateRepository::myMaxGroundStoppingDeceleration
protected
DtRwReal DtFixedWingEntityStateRepository::myGroundTurningRadius
protected
DtRwReal DtFixedWingEntityStateRepository::myMaxGroundSlope
protected
DtRwBoolean DtFixedWingEntityStateRepository::myOnGround
protected
DtRwReal DtFixedWingEntityStateRepository::myCurrentOrderedSpeed
protected

These variables are used to represent the values for the current state of the FWE - for flying or driving on the ground.

They should be updated at EVERY state change to ensure they are correct.

DtRwReal DtFixedWingEntityStateRepository::myCurrentMaxSpeed
protected
DtRwReal DtFixedWingEntityStateRepository::myCurrentMaxStoppingDeceleration
protected
DtRwReal DtFixedWingEntityStateRepository::myCurrentTurningRadius
protected
DtRwReal DtFixedWingEntityStateRepository::myCurrentMaxSlope
protected
DtRwReal DtFixedWingEntityStateRepository::myOnGroundTolerance
protected

The value (in meters) that if a fixed wing is within this tolerance and the ground, it is considered on ground.

This value defaults to 10


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)