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

The moving-object-param parameter type is used to configure rotary-wing type of entities. More...

Inheritance diagram for DtRotaryWingEntityParameters:
Inheritance graph
[legend]

Public Member Functions

 DtRotaryWingEntityParameters (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 constructor with parameters to set up read/writability correctly
const
DtRotaryWingEntityParameters
operator= (const DtRotaryWingEntityParameters &orig)
virtual ~DtRotaryWingEntityParameters ()
 destructor
virtual DtVrfObjectParametersclone (const DtSymbolString &rwName, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtVrfObjectParametersclone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString type () const
 Should return the type of entity this is a parameter block for.
virtual bool inheritValues (const DtVrfObjectParameters *benefactor)
 Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (
virtual void inheritValuesFromThisType (const DtRotaryWingEntityParameters *benefactor)
virtual void setDefaults ()
 Sets all the default values for flight and rotary wing parameters.
virtual void copyValues (const DtRotaryWingEntityParameters &orig)
 Used by copy constructor and = operator to copy all member values.
virtual DtReal maxYawAcceleration () const
virtual void setMaxYawAcceleration (const DtReal val)
virtual DtReal maxPitchAcceleration () const
virtual void setMaxPitchAcceleration (const DtReal val)
virtual DtReal maxRollAcceleration () const
virtual void setMaxRollAcceleration (const DtReal val)
virtual DtReal zeroCollectiveLiftAcceleration () const
virtual void setZeroCollectiveLiftAcceleration (const DtReal val)
virtual DtReal fullCollectiveLiftAcceleration () const
virtual void setFullCollectiveLiftAcceleration (const DtReal val)
virtual const DtVectornoseSupport () const
 Offset in body coordinates to forward support point.
virtual void setNoseSupport (const DtVector &noseSupport)
 Offset in body coordinates to forward support point.
virtual DtReal maxAltitude () const
 Accessor/mutator for myMaxAltitude.
virtual void setMaxAltitude (DtReal maxAltitude)
 Accessor/mutator for myMaxAltitude.
virtual bool isCheckingTerrainDistance () const
 Accessor/mutator for myIsCheckingTerrainDistance.
virtual void setIsCheckingTerrainDistance (const bool val)
 Accessor/mutator for myIsCheckingTerrainDistance.
virtual DtReal altitude () const
 Accessor/mutator for altitude in meters.
virtual void setAltitude (const DtReal val)
 Accessor/mutator for altitude in meters.
virtual void setJoystickControl (const bool val)
 Accessor/mutator for myJoystickControl.
virtual bool joystickControl () const
 Accessor/mutator for myJoystickControl.
virtual DtReal maxClimbRate () const
 Accessor/mutator for myMaxClimbRate.
virtual void setMaxClimbRate (DtReal maxClimbRate)
 Accessor/mutator for myMaxClimbRate.
virtual DtReal maxYawRate () const
 Accessor/mutator for myMaxYawRate.
virtual void setMaxYawRate (DtReal maxYawRate)
 Accessor/mutator for myMaxYawRate.
virtual DtReal maxPitchRate () const
 Accessor/mutator for myMaxPitchRate.
virtual void setMaxPitchRate (DtReal maxPitchRate)
 Accessor/mutator for myMaxPitchRate.
virtual DtReal maxRollRate () const
 Accessor/mutator for myMaxRollRate.
virtual void setMaxRollRate (DtReal maxRollRate)
 Accessor/mutator for myMaxRollRate.
- Public Member Functions inherited from DtMovingObjectParameters
 DtMovingObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 constructor with parameters to set up read/writability correctly
 DtMovingObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtMovingObjectParameters ()
 destructor
const DtMovingObjectParametersoperator= (const DtMovingObjectParameters &orig)
 assignment operator
virtual void inheritValuesFromThisType (const DtMovingObjectParameters *benefactor)
virtual bool canPivot () const
 Accessor/mutator for myCanPivot.
virtual void setCanPivot (bool newValue)
 Accessor/mutator for myCanPivot.
virtual DtReal maxPivotSpeed () const
 Accessor/mutator for myMaxPivotSpeed.
virtual void setMaxPivotSpeed (DtReal maxSpeed)
 Accessor/mutator for myMaxPivotSpeed.
virtual const DtVectorleftSupport () const
 Accessor/mutator for myLeftSupport.
virtual void setLeftSupport (const DtVector &newLeftSupport)
 Accessor/mutator for myLeftSupport.
virtual const DtVectorrightSupport () const
 Accessor/mutator for myRightSupport.
virtual void setRightSupport (const DtVector &newRightSupport)
 Accessor/mutator for myRightSupport.
virtual const DtVectorotherSupport () const
 Accessor/mutator for myOtherSupport.
virtual void setOtherSupport (const DtVector &newOtherSupport)
 Accessor/mutator for myOtherSupport.
virtual DtReal maxSpeed () const
 Accessor/mutator for myMaxSpeed.
virtual void setMaxSpeed (DtReal speed)
 Accessor/mutator for myMaxSpeed.
virtual DtReal maxReverseSpeed () const
 Accessor/mutator for myMaxReverseSpeed.
virtual void setMaxReverseSpeed (DtReal speed)
 Accessor/mutator for myMaxReverseSpeed.
virtual DtReal turningRadius () const
 Accessor/mutator for myTurningRadius.
virtual void setTurningRadius (DtReal turningRadius)
 Accessor/mutator for myTurningRadius.
virtual DtReal maxSlope () const
 Accessor/mutator for myMaxSlope.
virtual void setMaxSlope (DtReal slope)
 Accessor/mutator for myMaxSlope.
virtual DtReal orderedSpeed () const
 Accessor/mutator for myOrderedSpeed.
virtual void setOrderedSpeed (DtReal speed)
 Accessor/mutator for myOrderedSpeed.
virtual DtReal maxAcceleration () const
 Accessor/mutator for myMaxAcceleration.
virtual void setMaxAcceleration (const DtReal maxAcceleration)
 Accessor/mutator for myMaxAcceleration.
virtual DtReal maxStoppingDeceleration () const
 Accessor/mutator for myMaxStoppingDeceleration.
virtual void setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration)
 Accessor/mutator for myMaxStoppingDeceleration.
virtual DtReal fuelEfficiency () const
 Accessor/mutator for myFuelEfficiency.
virtual void setFuelEfficiency (const DtReal efficiency)
 Accessor/mutator for myFuelEfficiency.
virtual const DtStringobjectGeometryFile () const
 Accessor/mutator for myObjectGeometryFile.
virtual void setObjectGeometryFile (const DtFilename &)
 Accessor/mutator for myObjectGeometryFile.
virtual void setDIGuyCharacterInfo (const DtRwDIGuyCharacterInfo &info)
 Accessor/mutator for #myDIGuyCharacter.
virtual const
DtRwDIGuyCharacterInfo
diGuyCharacterInfo () const
 Accessor/mutator for #myDIGuyCharacter.
virtual void setMaxDisaggregationDistance (DtReal distance)
 Maximum disaggregation distance in meters.
virtual DtReal maxDisaggregationDistance () const
 Maximum disaggregation distance in meters.
virtual void setUsingRailMovement (bool rails)
 Accessor/mutator for myUsingRailMovement.
virtual bool usingRailMovement () const
 Accessor/mutator for myUsingRailMovement.
- Public Member Functions inherited from DtVrfObjectParameters
 DtVrfObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 Constructor with parameters to set up read/writability correctly.
 DtVrfObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtVrfObjectParameters ()
 destructor
DtVrfObjectParametersoperator= (const DtVrfObjectParameters &orig)
 assignment operator
virtual bool init ()
 Invoked when created so that deriving classes may do virtual allocation as necessary.
virtual void inheritValuesFromThisType (const DtVrfObjectParameters *benefactor)
virtual bool createLocalSubComponentTypes ()
 Creates a DtVrfObjectSubComponentTypes type of composed object type.
virtual bool createRemoteSubComponentTypes ()
 Creates a DtVrfObjectSubComponentTypes type of composed object type.
virtual
DtVrfObjectSubComponentTypes
localVrfSubComponentTypes () const
 Get local sub-component types.
virtual
DtVrfObjectSubComponentTypes
remoteVrfSubComponentTypes () const
 Get remote sub-component types.
virtual void setMinTickPeriod (DtReal minTickPeriod)
 Set the minimum tick period for this object (individual components and the network interface may override)
virtual DtReal minTickPeriod () const
 get the minimum tick period for this component (individual components and the network interface may override)
virtual void setMinTickPeriodVariance (DtReal minTickPeriodVariance)
 Set the minimum tick period variance for this component (individual components and the network interface may override)
virtual DtReal minTickPeriodVariance () const
 Get the minimum tick period variance for this component (individual components and the network interface may override)
virtual DtForceType forceType () const
 Currently unused.
virtual void setForceType (const DtForceType force)
virtual const DtStringcategory () const
 Accessor/mutator for myCategory.
virtual void setCategory (const DtString &category)
virtual bool categorySpecified () const
 Returns true of the category was specified in the file.
virtual const DtStringechelonLevel () const
 Accessor/mutator for myEchelonLevel.
virtual void setEchelonLevel (const DtString &echelonLevel)
virtual bool echelonLevelSpecified () const
 Returns true of the echelon level was specified in the file.
virtual bool organized () const
 Accessor/mutator for myOrganized.
virtual void setOrganized (bool organized)
virtual const
DtComponentDescriptorList
sensorDescriptorList () const
 Accessor/mutator for mySensorDescriptorList.
virtual DtComponentDescriptorListsensorDescriptorList ()
virtual void setSensorDescriptorList (const DtComponentDescriptorList &list)
virtual const
DtComponentDescriptorList
controllerDescriptorList () const
 Accessor/mutator for myControllerDescriptorList.
virtual DtComponentDescriptorListcontrollerDescriptorList ()
virtual void setControllerDescriptorList (const DtComponentDescriptorList &list)
virtual const
DtComponentDescriptorList
actuatorDescriptorList () const
 Accessor/mutator for myActuatorDescriptorList.
virtual DtComponentDescriptorListactuatorDescriptorList ()
virtual void setActuatorDescriptorList (const DtComponentDescriptorList &list)
virtual const
DtConnectionDescriptorList
connectionDescriptorList () const
 Accessor/mutator for myConnectionDescriptorList.
virtual
DtConnectionDescriptorList
connectionDescriptorList ()
virtual void setConnectionDescriptorList (const DtConnectionDescriptorList &list)
virtual DtDeadReckonTypes deadReckoningAlgorithm () const
 Accessor/mutator for myDeadReckoningAlgorithm.
virtual void setDeadReckoningAlgorithm (DtDeadReckonTypes deadReckoningAlgorithm)
virtual const
DtRwDeadReckonThresholds
deadReckoningThresholds () const
 Accessor/mutator for myDeadReckoningThresholds.
virtual void setDeadReckoningThresholds (const DtRwDeadReckonThresholds &deadReckoningThresholds)
virtual DtReal mass () const
 Accessor/mutator for myMass.
virtual void setMass (const DtReal mass)
virtual const
DtRwSensorSignatureList
sensorSignatureList () const
 Accessor/mutator for mySensorSignatureList.
virtual DtRwSensorSignatureListsensorSignatureList ()
virtual const
DtVrfSubObjectParameterList
subordinateObjects () const
 List of subordinates objects to create if fully instantiating from the parameter entry (ignored when object is being created by an AggregateAs message, eg.)
virtual void setSubordinateObjects (const DtVrfSubObjectParameterList &subordinateObjects)
virtual const
DtVrfSubObjectParameterList
attachedObjects () const
 Note that attached objects are not fully supported yet (still need to modify our network interfaces to support the new VR-Link / RPR mechanism for publishing attached objects) and so this list is currently ignored.
virtual void setAttachedObjects (const DtVrfSubObjectParameterList &attachedObjects)
virtual
DtVrfObjectSubComponentTypes
localSubComponentTypes () const
 Get local sub-component types.
virtual
DtVrfObjectSubComponentTypes
remoteSubComponentTypes () const
 Get remote sub-component types.
virtual void putData (FILE *fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual const Dt3dBoundingVolume * boundingVolume () const
 Set/get the bounding volume of the object.
virtual void setBoundingVolume (const Dt3dBoundingVolume &newBoundingVolume)
 Set the bounding volume of the object.
virtual void setBoundingVolume (const DtVector &localBvolDiagonal, const DtVector &offset=DtVector::zero())
 Set the bounding volume from its components.
virtual
DtSimBoundingGeometry::DtSimBoundingGeometryType 
boundingGeometryType () const
 Set/get the bounding geometry type of the object.
virtual void setBoundingGeometryType (DtSimBoundingGeometry::DtSimBoundingGeometryType type)
virtual DtAggregateFormation formation () const
 Accessor/mutator for myFormationType.
virtual void setFormation (DtAggregateFormation formation)
virtual const DtStringengagementRules () const
 Accessor/mutator for myEngagementRules.
virtual void setEngagementRules (const DtString &engagementRules)
virtual const
DtSimResourceManager
resourceManager () const
 Accessor/mutator for myResourceManager.
virtual void setResourceManager (const DtSimResourceManager &resourceManager)
virtual void setStateRepositoryUserExtensionType (const DtString &type)
 Accessor/mutator for myStateRepositoryUserExtensionType.
virtual const DtStringstateRepositoryUserExtensionType () const
virtual DtObjectType objectType () const
 Accessor/mutator for myObjectType.
virtual void setObjectType (const DtObjectType &objectType)
virtual bool taskedBySuperiorUponTaskComplete () const
 Flag indicating whether or not entity should always go into a 'tasked by superior' state upon completion of a top-level task (a non-subtask task).
virtual void setTaskedBySuperiorUponTaskComplete (bool trueOrFalse)
void setParameterType (const DtString &)
 Sets/gets type of parameter.
const DtStringparameterType () const
virtual void setStateRepositoryUserExtension (const DtVrfStateRepositoryUserExtension &userExtension)
 State repository user extension data (extensible at the base class DtVrfObjectStateRepository).
virtual
DtVrfStateRepositoryUserExtension
stateRepositoryUserExtension () const
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Override so we can figure out what kind of DtVrfStateRepositoryUserExtension to instantiate before calling down to base class version to actually load the parameters.
virtual DtTime underFireTime () const
virtual void setUnderFireTime (DtTime time)
virtual bool underFireTimeSpecified () const
virtual DtReal underFireDistance () const
virtual void setUnderFireDistance (DtReal underFireDistance)
virtual bool underFireDistanceSpecified () const
virtual const std::list
< DtSimArtPartDescriptor * > * 
completeArtPartList () const
virtual const
DtComponentSystemDescriptorList
systemDescriptorList () const
 See mySystemDescriptorList.
virtual
DtComponentSystemDescriptorList
systemDescriptorList ()
 See mySystemDescriptorList.
virtual void setSystemDescriptorList (const DtComponentSystemDescriptorList &list)
 See mySystemDescriptorList.
virtual const DtRwBoolean deadReckoningAllowGuiOverrides () const
 Accessor/mutator for myDeadReckoningAllowGuiOverrides.
virtual void setDeadReckoningAllowGuiOverrides (bool allow)
 Accessor/mutator for myDeadReckoningAllowGuiOverrides.
virtual const
DtRadioDescriptorList
radioDescriptorList () const
 See myRadioDescriptorList.
virtual DtRadioDescriptorListradioDescriptorList ()
 See myRadioDescriptorList.
virtual const DtSimSectorinitialSectorOfResponsibility () const
virtual void setInitialSectorOfResponsibility (const DtSimSector &sor)
virtual DtTaskExecutionRulestaskExecutionRules ()
virtual const
DtTaskExecutionRules
taskExecutionRules () const
virtual void setTaskExecutionRulesFilename (const DtFilename &)
virtual const DtReaderWriterFiletaskExecutionRulesFilename () const
- 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 putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
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 DtVrfObjectParameterscreator ()
 

Protected Member Functions

 DtRotaryWingEntityParameters (const DtRotaryWingEntityParameters &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
- Protected Member Functions inherited from DtMovingObjectParameters
 DtMovingObjectParameters (const DtMovingObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor. Use clone instead...
 DtMovingObjectParameters (const DtMovingObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
- Protected Member Functions inherited from DtVrfObjectParameters
 DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor. Use clone instead.
 DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual
DtVrfSubObjectParameterList
createSubordinateObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const
 Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot mySubordinateObjects in init().
virtual
DtVrfSubObjectParameterList
createAttachedObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const
 Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot myAttachedObjects in init().
virtual void rebuildArtPartList ()
 Clears out and rebuilds myCompleteArtPartList.
virtual void addArtPartsFromSystem (DtComponentSystemDescriptor *systemDesc, std::list< DtSimArtPartDescriptor * > &artPartList)
 Adds any art parts defined within a system to the list.
- 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.

Protected Attributes

DtReal myAltitude
Parameters

These parameters are available for setting in the OPD files.

DtRwReal myMaxAltitude
 Parameter Name: max-altitude Parameter Description: Above this altitude no lift is generated.
DtRwBoolean myJoystickControl
 Parameter Name: joystick-control Parameter Description: Specifies whether or not you can use a joystick to control rotary-wing entities.
DtRwBoolean myIsCheckingTerrainDistance
 Parameter Name: terrain-check
Parameter Description:
Parameter Default Value:
.
DtRwReal myMaxClimbRate
 Parameter Name: max-climb-rate
Parameter Description:
Parameter Default Value: 50.
DtRwReal myMaxYawRate
 Parameter Name: max-yaw-rate
Parameter Description: Maximum rate this plane can pitch down or up about its Y axis (due to stick).
DtRwReal myMaxPitchRate
 Parameter Name: max-pitch-rate
Parameter Description:
Parameter Default Value: 0.7854 (45.
DtRwReal myMaxRollRate
 Parameter Name: max-roll-rate
Parameter Description: Maximum rate this plane can rotate about its X axis (due to stick).
DtRwReal myMaxYawAcceleration
 Parameter Name: max-yaw-acceleration
Parameter Description: The maximum rotational acceleration around the body Z axis (due to pedal).
DtRwReal myMaxPitchAcceleration
 Parameter Name: max-pitch-acceleration
Parameter Description: Maximum rotational acceleration about the Y axis in radians per second squared.
DtRwReal myMaxRollAcceleration
 Parameter Name: max-roll-acceleration
Parameter Description: Maximum rotational acceleration around the X axis in radians per second squared.
DtRwReal myZeroCollectiveLiftAcceleration
 Parameter Name: zero-collective-lift-acceleration
Parameter Description: The upward acceleration when the collective is at zero, assuming no gravity.
DtRwReal myFullCollectiveLiftAcceleration
 Parameter Name: full-collective-lift-acceleration Parameter Description: This is the upward acceleration when the collective is at full, assuming no gravity.
- Protected Attributes inherited from DtMovingObjectParameters
DtRwBoolean myUsingRailMovement
 Parameter Name: using-rail-movement
Parameter Description: If true entity will clamp to a route segment using the segment's heading as it's heading and will use the rail movement system to to provide smoother driving.
DtRwBoolean myCanPivot
 Parameter Name: can-pivot
Parameter Description: Indicates whether not the entity can pivot to turn.
DtRwReal myMaxPivotSpeed
 Parameter Name: max-pivot-speed
Parameter Description: The maximum rate at which a ground entity can turn in place.
DtRwVector myLeftSupport
 Parameter Name: left-support
Parameter Description: Support contact point in body coordinates.
DtRwVector myRightSupport
 Parameter Name: right-support
Parameter Description: Support contact point in body coordinates.
DtRwVector myOtherSupport
 Parameter Name: other-support
Parameter Description: Support contact point in body coordinates.
DtRwReal myMaxSpeed
 Parameter Name: max-speed
Parameter Description: The top speed of the entity.
DtRwReal myMaxReverseSpeed
 Parameter Name: max-reverse-speed
Parameter Description: The maximum speed at which an entity can move in reverse.
DtRwReal myTurningRadius
 Parameter Name: turning-radius
Parameter Description: Maximum turning radius.
DtRwReal myMaxSlope
 Parameter Name: max-slope
Parameter Description: The maximum slope, at which the entity can still have acceleration >= 0 in its direction of motion.
DtRwReal myOrderedSpeed
 Parameter Name: ordered-speed
Parameter Description: The speed the entity will move when tasked, unless or until changed by a set speed message.
DtRwReal myMaxAcceleration
 Parameter Name: max-acceleration
Parameter Description: The maximum acceleration rate for the entity.
DtRwReal myMaxStoppingDeceleration
 Parameter Name: max-deceleration
Parameter Description: The maximum (braking) deceleration for the entity.
DtRwReal myFuelEfficiency
 Parameter Name: fuel-efficiency
Parameter Description: The number of meters the entity goes on one liter of fuel.
DtReaderWriterFile myObjectGeometryFile
 Parameter Name: object-geometry-file
Parameter Description: If the object geometry is defined (a polygonal model for the entity comparable to a terrain database), it will be used when entities are embarked to task them to move on the embarked item.
DtRwDIGuyCharacterInfo myDIGuyCharacterInfo
 Parameter Name: di-guy-character
Parameter Description: DI-Guy representation of the entity if any.
DtRwReal myDisaggregationRange
 Parameter Name: disaggregation-range
Parameter Description: Maximimum distance from this type of entity that will trigger a aggregate to disaggregate.
- Protected Attributes inherited from DtVrfObjectParameters
DtObjectType myObjectType
 An extended form of the DIS/RPR FOM entity enumerated type.
DtTaskExecutionRules myTaskExecutionRules
 Task execution rules.
DtString myParameterType
 String that keeps the type of parameter this is Local only – not part of descriptor.
std::list
< DtSimArtPartDescriptor * > 
myCompleteArtPartList
 A list containing all the art part descriptors from actuators directly on the entity and those in systems as well.
DtRwBoundingGeometryType myBoundingGeometryType
 Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object).
DtRwBoundingVolume myBvol
 Parameter Name: bounding-volume Parameter Description: Specifies the bounding volume around an object.
DtVrfObjectSubComponentTypesmyLocalSubComponentTypes
 Parameter Name: local-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used by locally simulated objects.
DtVrfObjectSubComponentTypesmyRemoteSubComponentTypes
 Parameter Name: remote-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used for remotely simulated objects.
DtRwFormationType myFormationType
 Parameter Name: formation
Parameter Description: (Optional) One of the following:
DtRwForceType myForceType
 Parameter Name: force-type Parameter Description: The force to which the object belongs.
DtRwString myCategory
 Parameter Name: category Parameter Description: The category string to use when creating an echelon ID.
DtRwString myEchelonLevel
 Parameter Name: echelon-level Parameter Description: The echelon level to use for this entity when creating an echelon ID.
DtRwBoolean myOrganized
 Parameter Name: is-organized Parameter Description: Specifies that the entity is part of the entity hierarchy and requires an echelon ID.
DtRwReal myMinTickPeriod
 Parameter Name: min-tick-period Parameter Description: Specifies the shortest period of time, in seconds, that can elapse between ticks of an entity's components.
DtRwReal myMinTickPeriodVariance
 Parameter Name: min-tick-period-variance Parameter Description: Specifies an amount within which the min-tick-period can vary.
DtRwDeadReckonTypes myDeadReckoningAlgorithm
 Parameter Name: dr-algorithm Parameter Description: The VR-Link dead-reckoning algorithm to use when publishing this entity.
DtRwDeadReckonThresholds myDeadReckoningThresholds
 Parameter Name: dr-thresholds Parameter Description: The translation, rotation, and aggregate dimension thresholds used when publishing this entity.
DtRwBoolean myDeadReckoningAllowGuiOverrides
 Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object).
DtRadioDescriptorList myRadioDescriptorList
 Parameter Name: radios Parameter Description: List of all radios on the entity.
DtComponentSystemDescriptorList mySystemDescriptorList
 Parameter Name: systems Parameter Description: List of system descriptors.
DtComponentDescriptorList mySensorDescriptorList
 Parameter Name: sensors Parameter Description: List of sensor controller component descriptors.
DtComponentDescriptorList myControllerDescriptorList
 Parameter Name: controllers Parameter Description: List of controller component descriptors.
DtComponentDescriptorList myActuatorDescriptorList
 Parameter Name: actuators Parameter Description: List of actuator component descriptors.
DtConnectionDescriptorList myConnectionDescriptorList
 Parameter Name: connections Parameter Description: The connections (Example 5.2, line 19) entry specifies how the components connect to one another (through ports, port groups, or both).
DtRwReal myMass
 Parameter Name: mass Parameter Description: The mass of the entity.
DtRwSensorSignatureList mySensorSignatureList
 Parameter Name: sensor-signatures Parameter Description: Parameter Default Value:
DtVrfSubObjectParameterListmySubordinateObjects
 Parameter Name: subordinate-objects
Parameter Description: (Optional) List of entries specifying subordinate objects to be created as part of an aggregate object.
DtVrfSubObjectParameterListmyAttachedObjects
 Parameter Name: attached-objects
Parameter Description:
Parameter Default Value:
.
DtRwString myEngagementRules
 Parameter Name: engagement-rules Parameter Description: (Optional) The engagement rules the entity will use unless/until changed by a set engagement rules message.
DtSimResourceManager myResourceManager
 Parameter Name: resources Parameter Description: Specifies the types and amount of resources the entity has.
DtRwString myStateRepositoryUserExtensionType
 Parameter Name: state-repository-extension-type
Parameter Description: Type of state repository extensions class to instantiate.
DtRwBoolean myTaskedBySuperiorUponTaskComplete
 Parameter Name: tasked-by-superior-upon-task-complete
Parameter Description: Flag indicating whether or not subordinates should automatically resume a tasked-by-superior status upon completing an independent task.
DtVrfStateRepositoryUserExtensionmyStateRepositoryUserExtension
 Parameter Name: user-extension
Parameter Description: Extension to the state repository class.
DtRwTime myUnderFireTime
 Parameter Name: under-fire-time
Parameter Description: Deprecated.
DtRwReal myUnderFireDistance
 Parameter Name: under-fire-distance
Parameter Description: Deprecated.
DtSimSector myInitialSectorOfResponsibility
 Parameter Name: initial-sector-of-responsibility
Parameter Description: The sector of responsibility for this entity when the entity is first created.
DtReaderWriterFile myTaskExecutionRulesFilename
 Parameter Name: task-execution-rules Parameter Description: The name of the file that contains the task execution rules for this entity.
- 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
- Static Protected Attributes inherited from DtVrfObjectParameters
static
DtVrfObjectParameterFactory
theFactory

Detailed Description

The moving-object-param parameter type is used to configure rotary-wing type of entities.


Developer Description: Used to hold parameters for the DtVrfMovingObjectStateRepository class.

Constructor & Destructor Documentation

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

constructor with parameters to set up read/writability correctly

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

copy constructor

virtual DtRotaryWingEntityParameters::~DtRotaryWingEntityParameters ( )
virtual

destructor

Member Function Documentation

const DtRotaryWingEntityParameters& DtRotaryWingEntityParameters::operator= ( const DtRotaryWingEntityParameters orig)
virtual DtVrfObjectParameters* DtRotaryWingEntityParameters::clone ( const DtSymbolString rwName,
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubsurfaceEntityParameters.

virtual DtVrfObjectParameters* DtRotaryWingEntityParameters::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubsurfaceEntityParameters.

virtual DtString DtRotaryWingEntityParameters::type ( ) const
virtual

Should return the type of entity this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubsurfaceEntityParameters.

virtual bool DtRotaryWingEntityParameters::inheritValues ( const DtVrfObjectParameters benefactor)
virtual

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (

For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from. ( const DtVrfObjectParameters* benefactor)

Reimplemented from DtMovingObjectParameters.

virtual void DtRotaryWingEntityParameters::inheritValuesFromThisType ( const DtRotaryWingEntityParameters benefactor)
virtual
virtual const DtVector& DtRotaryWingEntityParameters::noseSupport ( ) const
virtual

Offset in body coordinates to forward support point.

virtual void DtRotaryWingEntityParameters::setNoseSupport ( const DtVector noseSupport)
virtual

Offset in body coordinates to forward support point.

virtual DtReal DtRotaryWingEntityParameters::maxAltitude ( ) const
virtual

Accessor/mutator for myMaxAltitude.

virtual void DtRotaryWingEntityParameters::setMaxAltitude ( DtReal  maxAltitude)
virtual

Accessor/mutator for myMaxAltitude.

virtual bool DtRotaryWingEntityParameters::isCheckingTerrainDistance ( ) const
virtual

Accessor/mutator for myIsCheckingTerrainDistance.

virtual void DtRotaryWingEntityParameters::setIsCheckingTerrainDistance ( const bool  val)
virtual

Accessor/mutator for myIsCheckingTerrainDistance.

virtual DtReal DtRotaryWingEntityParameters::altitude ( ) const
virtual

Accessor/mutator for altitude in meters.

virtual void DtRotaryWingEntityParameters::setAltitude ( const DtReal  val)
virtual

Accessor/mutator for altitude in meters.

virtual void DtRotaryWingEntityParameters::setJoystickControl ( const bool  val)
virtual

Accessor/mutator for myJoystickControl.

virtual bool DtRotaryWingEntityParameters::joystickControl ( ) const
virtual

Accessor/mutator for myJoystickControl.

virtual void DtRotaryWingEntityParameters::setDefaults ( )
virtual

Sets all the default values for flight and rotary wing parameters.

virtual void DtRotaryWingEntityParameters::copyValues ( const DtRotaryWingEntityParameters orig)
virtual

Used by copy constructor and = operator to copy all member values.

static DtVrfObjectParameters* DtRotaryWingEntityParameters::creator ( )
static

Returns
Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubsurfaceEntityParameters.

virtual DtReal DtRotaryWingEntityParameters::maxClimbRate ( ) const
virtual

Accessor/mutator for myMaxClimbRate.

virtual void DtRotaryWingEntityParameters::setMaxClimbRate ( DtReal  maxClimbRate)
virtual

Accessor/mutator for myMaxClimbRate.

virtual DtReal DtRotaryWingEntityParameters::maxYawRate ( ) const
virtual

Accessor/mutator for myMaxYawRate.

virtual void DtRotaryWingEntityParameters::setMaxYawRate ( DtReal  maxYawRate)
virtual

Accessor/mutator for myMaxYawRate.

virtual DtReal DtRotaryWingEntityParameters::maxPitchRate ( ) const
virtual

Accessor/mutator for myMaxPitchRate.

virtual void DtRotaryWingEntityParameters::setMaxPitchRate ( DtReal  maxPitchRate)
virtual

Accessor/mutator for myMaxPitchRate.

virtual DtReal DtRotaryWingEntityParameters::maxRollRate ( ) const
virtual

Accessor/mutator for myMaxRollRate.

virtual void DtRotaryWingEntityParameters::setMaxRollRate ( DtReal  maxRollRate)
virtual

Accessor/mutator for myMaxRollRate.

virtual DtReal DtRotaryWingEntityParameters::maxYawAcceleration ( ) const
virtual
virtual void DtRotaryWingEntityParameters::setMaxYawAcceleration ( const DtReal  val)
virtual
virtual DtReal DtRotaryWingEntityParameters::maxPitchAcceleration ( ) const
virtual
virtual void DtRotaryWingEntityParameters::setMaxPitchAcceleration ( const DtReal  val)
virtual
virtual DtReal DtRotaryWingEntityParameters::maxRollAcceleration ( ) const
virtual
virtual void DtRotaryWingEntityParameters::setMaxRollAcceleration ( const DtReal  val)
virtual
virtual DtReal DtRotaryWingEntityParameters::zeroCollectiveLiftAcceleration ( ) const
virtual
virtual void DtRotaryWingEntityParameters::setZeroCollectiveLiftAcceleration ( const DtReal  val)
virtual
virtual DtReal DtRotaryWingEntityParameters::fullCollectiveLiftAcceleration ( ) const
virtual
virtual void DtRotaryWingEntityParameters::setFullCollectiveLiftAcceleration ( const DtReal  val)
virtual

Member Data Documentation

DtRwReal DtRotaryWingEntityParameters::myMaxAltitude
protected

Parameter Name: max-altitude Parameter Description: Above this altitude no lift is generated.

Parameter Default Value: 12000.0 Parameter Units: meters

DtRwBoolean DtRotaryWingEntityParameters::myJoystickControl
protected

Parameter Name: joystick-control Parameter Description: Specifies whether or not you can use a joystick to control rotary-wing entities.

Currently unused. Parameter Default Value: False

DtRwBoolean DtRotaryWingEntityParameters::myIsCheckingTerrainDistance
protected

Parameter Name: terrain-check
Parameter Description:
Parameter Default Value:
.

DtRwReal DtRotaryWingEntityParameters::myMaxClimbRate
protected

Parameter Name: max-climb-rate
Parameter Description:
Parameter Default Value: 50.


Parameter Units: meters/second

DtRwReal DtRotaryWingEntityParameters::myMaxYawRate
protected

Parameter Name: max-yaw-rate
Parameter Description: Maximum rate this plane can pitch down or up about its Y axis (due to stick).


Parameter Default Value: 0.7854 (45. degrees/second)
Parameter Units: radians/second

DtRwReal DtRotaryWingEntityParameters::myMaxPitchRate
protected

Parameter Name: max-pitch-rate
Parameter Description:
Parameter Default Value: 0.7854 (45.

degrees/second)
Parameter Units: radians/second

DtRwReal DtRotaryWingEntityParameters::myMaxRollRate
protected

Parameter Name: max-roll-rate
Parameter Description: Maximum rate this plane can rotate about its X axis (due to stick).


Parameter Default Value: 1.047 (60. degrees/second)
Parameter Units: radians/second

DtRwReal DtRotaryWingEntityParameters::myMaxYawAcceleration
protected

Parameter Name: max-yaw-acceleration
Parameter Description: The maximum rotational acceleration around the body Z axis (due to pedal).


Parameter Default Value: 0.1768 (10. degrees/second/second)
Parameter Units: radians/second/second

DtRwReal DtRotaryWingEntityParameters::myMaxPitchAcceleration
protected

Parameter Name: max-pitch-acceleration
Parameter Description: Maximum rotational acceleration about the Y axis in radians per second squared.

(due to stick). Parameter Default Value: 0.1768 (10. degrees/second/second)
Parameter Units: radians/second/second

DtRwReal DtRotaryWingEntityParameters::myMaxRollAcceleration
protected

Parameter Name: max-roll-acceleration
Parameter Description: Maximum rotational acceleration around the X axis in radians per second squared.

(due to stick). Parameter Default Value: 0.1768 (10. degrees/second/second)
Parameter Units: radians/second/second

DtRwReal DtRotaryWingEntityParameters::myZeroCollectiveLiftAcceleration
protected

Parameter Name: zero-collective-lift-acceleration
Parameter Description: The upward acceleration when the collective is at zero, assuming no gravity.


Parameter Default Value: -10.
Parameter Units: meters/second/second

DtRwReal DtRotaryWingEntityParameters::myFullCollectiveLiftAcceleration
protected

Parameter Name: full-collective-lift-acceleration Parameter Description: This is the upward acceleration when the collective is at full, assuming no gravity.

Default Value: 30. Parameter Units: meters/second/second

DtReal DtRotaryWingEntityParameters::myAltitude
protected

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)