Contains the set of readable/writeable parameters assoicated with a fixed-wing entity. More...

Inheritance diagram for DtFixedWingEntityParameters:

Public Member Functions
	DtFixedWingEntityParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtFixedWingEntityParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
const DtFixedWingEntityParameters &	operator= (const DtFixedWingEntityParameters &orig)
virtual	~DtFixedWingEntityParameters ()
	destructor
virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParameters *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) 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 DtFixedWingEntityParameters *benefactor)
virtual void	setDefaults ()
	Sets all the default values specified above.
virtual void	copyValues (const DtFixedWingEntityParameters &orig)
	Used by copy constructor and = operator to copy all member values.

virtual DtReal	minLiftSpeed () const
	Flight Parameters: These parameters should apply to all fixed wing aircraft.
virtual void	setMinLiftSpeed (DtReal minLiftSpeed)
	Flight Parameters: These parameters should apply to all fixed wing aircraft.

virtual DtReal	maxAltitude () const
	Accessor/mutator for myMaxAltitude.
virtual void	setMaxAltitude (DtReal maxAltitude)
	Accessor/mutator for myMaxAltitude.

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.

virtual DtReal	flapsDeceleration () const
	Accessor/mutator for myFlapsDeceleration.
virtual void	setFlapsDeceleration (DtReal decel)
	Accessor/mutator for myFlapsDeceleration.

virtual DtReal	orderedGroundSpeed () const
	Accessor/mutator for myOrderedGroundSpeed.
virtual void	setOrderedGroundSpeed (DtReal orderedGroundSpeed)
	Accessor/mutator for myOrderedGroundSpeed.

virtual DtReal	maxGroundSpeed () const
	Accessor/mutator for myMaxGroundSpeed.
virtual void	setMaxGroundSpeed (DtReal maxGroundSpeed)
	Accessor/mutator for myMaxGroundSpeed.

virtual DtReal	onGroundTolerance () const
	Accessor/mutator for myOnGroundTolerance.
virtual void	setOnGroundTolerance (DtReal onGroundTolerance)
	Accessor/mutator for myOnGroundTolerance.

virtual DtReal	maxGroundStoppingDeceleration () const
	Accessor/mutator for myMaxGroundStoppingDeceleration.
virtual void	setMaxGroundStoppingDeceleration (DtReal maxGroundStoppingDeceleration)
	Accessor/mutator for myMaxGroundStoppingDeceleration.

virtual DtReal	groundTurningRadius () const
	Accessor/mutator for myGroundTurningRadius.
virtual void	setGroundTurningRadius (DtReal groundTurningRadius)
	Accessor/mutator for myGroundTurningRadius.

virtual DtReal	maxGroundSlope () const
	Accessor/mutator for myMaxGroundSlope.
virtual void	setMaxGroundSlope (DtReal maxGroundSlope)
	Accessor/mutator for myMaxGroundSlope.

virtual bool	onGround () const
	Accessor/mutator for myOnGround.
virtual void	setOnGround (bool onGround)
	Accessor/mutator for myOnGround.

virtual const DtVector &	noseSupport () const
	Accessor/mutator for forward-most support point, in body coordinates.
virtual void	setNoseSupport (const DtVector &newNoseSupport)
	Accessor/mutator for forward-most support point, in body coordinates.
Static Public Member Functions
static DtVrfObjectParameters *	creator ()

Protected Member Functions
	DtFixedWingEntityParameters (const DtFixedWingEntityParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtFixedWingEntityParameters (const DtFixedWingEntityParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMinLiftSpeed
	Parameter Name: min-speed Parameter Description: The lowest speed at which the entity can generate enough lift to fly level.
DtRwReal	myMaxAltitude
	Parameter Name: max-altitude Parameter Description: Plane will not fly above this.
DtRwReal	myMaxClimbRate
	Parameter Name: max-climb-rate Parameter Description: The maximum speed, that the plane can climb.
DtRwReal	myMaxYawRate
	Parameter Name: max-yaw-rate Parameter Description: The maximum rate at which the entity can rotate about its yaw (Z) body axis.
DtRwReal	myMaxPitchRate
	Parameter Name: max-pitch-rate Parameter Description: (Optional) The maximum rate this plane can pitch down or up about its Y axis (due to stick), in radians.
DtRwReal	myMaxRollRate
	Parameter Name: max-roll-rate Parameter Description: The maximum rate at which the entity can rotate about its roll (X) body axis.
DtRwReal	myFlapsDeceleration
	Parameter Name: flaps-deceleration Parameter Description: The additional deceleration applied to the drag when the flaps are deployed.
DtRwReal	myOrderedGroundSpeed
	Parameter Name: ordered-ground-speed Parameter Description: The speed at which a fixed-wing entity attempts to move when taxiing.
DtRwReal	myMaxGroundSpeed
	Parameter Name: max-ground-speed Parameter Description: Maximum speed when taxiing on the ground.
DtRwReal	myMaxGroundStoppingDeceleration
	Parameter Name: max-ground-stopping-deceleration Parameter Description: The maximum speed at which a fixed-wing entity can decelerate after landing.
DtRwReal	myGroundTurningRadius
	Parameter Name: ground-turning-radius Parameter Description: Turning radius used when entity is taxiing on the ground.
DtRwReal	myMaxGroundSlope
	Parameter Name: max-ground-slope Parameter Description: The maximum slope that a fixed-wing entity can taxi on.
DtRwReal	myOnGroundTolerance
	Parameter Name: on-ground-tolerance Parameter Description: The tolerance by which a fixed wing is considered on the ground or in the air.
DtRwBoolean	myOnGround
	Parameter Name: on-ground Parameter Description: Flag indicating whether or not entity is intially on the ground.

Detailed Description

Contains the set of readable/writeable parameters assoicated with a fixed-wing entity.

Changes the default values for the following inherited parameters:

Fuel-efficiency - inherited from individual local params. New Default Value: 1m/l

Ground Parameters: These parameters apply when on the ground; taxi, takeoff, and landing.

Turning-radius - inherited from local parameters. New Default Value: 20m

Max-stopping-acceleration - inherited from individual local params. New Default Value: 20m/s**2

Landing gear contact points (vectors passed into ground interaction points in State Repository). Default Values: nose support - < 2.5 0.0 1.8>

Miscellaneous Parameters: These two parameters are inherited from local params, but we set new default values.

Dead-reckoning-algorithm. New Default Value: DtDrDrmRvw

Ordered-speed - make sure this is between min-speed and max-speed. New Default Value: 150m/s

Constructor & Destructor Documentation

DtFixedWingEntityParameters::DtFixedWingEntityParameters	(	const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

constructor with parameters to set up read/writability correctly

DtFixedWingEntityParameters::DtFixedWingEntityParameters	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtFixedWingEntityParameters::DtFixedWingEntityParameters	(	const DtFixedWingEntityParameters &	orig,
		const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		`[protected]`

copy constructor

DtFixedWingEntityParameters::DtFixedWingEntityParameters	(	const DtFixedWingEntityParameters &	orig,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		`[protected]`

virtual DtFixedWingEntityParameters::~DtFixedWingEntityParameters ( ) [virtual]

destructor

Member Function Documentation

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

virtual DtVrfObjectParameters* DtFixedWingEntityParameters::clone	(	const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const `[virtual]`

Reimplemented from DtMovingObjectParameters.

virtual DtVrfObjectParameters* DtFixedWingEntityParameters::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const `[virtual]`

Reimplemented from DtMovingObjectParameters.

virtual DtString DtFixedWingEntityParameters::type ( ) const [virtual]

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

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

virtual bool DtFixedWingEntityParameters::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 DtFixedWingEntityParameters::inheritValuesFromThisType ( const DtFixedWingEntityParameters * benefactor ) [virtual]

virtual DtReal DtFixedWingEntityParameters::minLiftSpeed ( ) const [virtual]

Flight Parameters: These parameters should apply to all fixed wing aircraft.

Parameters of specific models (for a given actuator) are specified in that actuator's component descriptor. Accessor/mutator for myMinLiftSpeed.

virtual void DtFixedWingEntityParameters::setMinLiftSpeed ( DtReal minLiftSpeed ) [virtual]

Flight Parameters: These parameters should apply to all fixed wing aircraft.

Parameters of specific models (for a given actuator) are specified in that actuator's component descriptor. Accessor/mutator for myMinLiftSpeed.

virtual DtReal DtFixedWingEntityParameters::maxAltitude ( ) const [virtual]

Accessor/mutator for myMaxAltitude.

virtual void DtFixedWingEntityParameters::setMaxAltitude ( DtReal maxAltitude ) [virtual]

Accessor/mutator for myMaxAltitude.

virtual DtReal DtFixedWingEntityParameters::maxClimbRate ( ) const [virtual]

Accessor/mutator for myMaxClimbRate.

virtual void DtFixedWingEntityParameters::setMaxClimbRate ( DtReal maxClimbRate ) [virtual]

Accessor/mutator for myMaxClimbRate.

virtual DtReal DtFixedWingEntityParameters::maxYawRate ( ) const [virtual]

Accessor/mutator for myMaxYawRate.

virtual void DtFixedWingEntityParameters::setMaxYawRate ( DtReal maxYawRate ) [virtual]

Accessor/mutator for myMaxYawRate.

virtual DtReal DtFixedWingEntityParameters::maxPitchRate ( ) const [virtual]

Accessor/mutator for myMaxPitchRate.

virtual void DtFixedWingEntityParameters::setMaxPitchRate ( DtReal maxPitchRate ) [virtual]

Accessor/mutator for myMaxPitchRate.

virtual DtReal DtFixedWingEntityParameters::maxRollRate ( ) const [virtual]

Accessor/mutator for myMaxRollRate.

virtual void DtFixedWingEntityParameters::setMaxRollRate ( DtReal maxRollRate ) [virtual]

Accessor/mutator for myMaxRollRate.

virtual DtReal DtFixedWingEntityParameters::flapsDeceleration ( ) const [virtual]

Accessor/mutator for myFlapsDeceleration.

virtual void DtFixedWingEntityParameters::setFlapsDeceleration ( DtReal decel ) [virtual]

Accessor/mutator for myFlapsDeceleration.

virtual DtReal DtFixedWingEntityParameters::orderedGroundSpeed ( ) const [virtual]

Accessor/mutator for myOrderedGroundSpeed.

virtual void DtFixedWingEntityParameters::setOrderedGroundSpeed ( DtReal orderedGroundSpeed ) [virtual]

Accessor/mutator for myOrderedGroundSpeed.

virtual DtReal DtFixedWingEntityParameters::maxGroundSpeed ( ) const [virtual]

Accessor/mutator for myMaxGroundSpeed.

virtual void DtFixedWingEntityParameters::setMaxGroundSpeed ( DtReal maxGroundSpeed ) [virtual]

Accessor/mutator for myMaxGroundSpeed.

virtual DtReal DtFixedWingEntityParameters::onGroundTolerance ( ) const [virtual]

Accessor/mutator for myOnGroundTolerance.

virtual void DtFixedWingEntityParameters::setOnGroundTolerance ( DtReal onGroundTolerance ) [virtual]

Accessor/mutator for myOnGroundTolerance.

virtual DtReal DtFixedWingEntityParameters::maxGroundStoppingDeceleration ( ) const [virtual]

Accessor/mutator for myMaxGroundStoppingDeceleration.

virtual void DtFixedWingEntityParameters::setMaxGroundStoppingDeceleration ( DtReal maxGroundStoppingDeceleration ) [virtual]

Accessor/mutator for myMaxGroundStoppingDeceleration.

virtual DtReal DtFixedWingEntityParameters::groundTurningRadius ( ) const [virtual]

Accessor/mutator for myGroundTurningRadius.

virtual void DtFixedWingEntityParameters::setGroundTurningRadius ( DtReal groundTurningRadius ) [virtual]

Accessor/mutator for myGroundTurningRadius.

virtual DtReal DtFixedWingEntityParameters::maxGroundSlope ( ) const [virtual]

Accessor/mutator for myMaxGroundSlope.

virtual void DtFixedWingEntityParameters::setMaxGroundSlope ( DtReal maxGroundSlope ) [virtual]

Accessor/mutator for myMaxGroundSlope.

virtual bool DtFixedWingEntityParameters::onGround ( ) const [virtual]

Accessor/mutator for myOnGround.

virtual void DtFixedWingEntityParameters::setOnGround ( bool onGround ) [virtual]

Accessor/mutator for myOnGround.

virtual const DtVector& DtFixedWingEntityParameters::noseSupport ( ) const [virtual]

Accessor/mutator for forward-most support point, in body coordinates.

virtual void DtFixedWingEntityParameters::setNoseSupport ( const DtVector & newNoseSupport ) [virtual]

Accessor/mutator for forward-most support point, in body coordinates.

virtual void DtFixedWingEntityParameters::setDefaults ( ) [virtual]

Sets all the default values specified above.

virtual void DtFixedWingEntityParameters::copyValues ( const DtFixedWingEntityParameters & orig ) [virtual]

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

static DtVrfObjectParameters* DtFixedWingEntityParameters::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.

Member Data Documentation

DtRwReal DtFixedWingEntityParameters::myMinLiftSpeed [protected]

Parameter Name: min-speed
Parameter Description: The lowest speed at which the entity can generate enough lift to fly level.

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

DtRwReal DtFixedWingEntityParameters::myMaxAltitude [protected]

Parameter Name: max-altitude Parameter Description: Plane will not fly above this.

Parameter Default Value: 12000.0 Parameter Units: meters

DtRwReal DtFixedWingEntityParameters::myMaxClimbRate [protected]

Parameter Name: max-climb-rate Parameter Description: The maximum speed, that the plane can climb.

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

DtRwReal DtFixedWingEntityParameters::myMaxYawRate [protected]

Parameter Name: max-yaw-rate
Parameter Description: The maximum rate at which the entity can rotate about its yaw (Z) body axis.

Parameter Default Value: 0.
Parameter Units: radians/second

DtRwReal DtFixedWingEntityParameters::myMaxPitchRate [protected]

Parameter Name: max-pitch-rate Parameter Description: (Optional) The maximum rate this plane can pitch down or up about its Y axis (due to stick), in radians.

Parameter Default Value: PI/4 (45 degrees /second) Parameter Units: radians/second

DtRwReal DtFixedWingEntityParameters::myMaxRollRate [protected]

Parameter Name: max-roll-rate
Parameter Description: The maximum rate at which the entity can rotate about its roll (X) body axis.

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

DtRwReal DtFixedWingEntityParameters::myFlapsDeceleration [protected]

Parameter Name: flaps-deceleration
Parameter Description: The additional deceleration applied to the drag when the flaps are deployed.

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

DtRwReal DtFixedWingEntityParameters::myOrderedGroundSpeed [protected]

Parameter Name: ordered-ground-speed
Parameter Description: The speed at which a fixed-wing entity attempts to move when taxiing.

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

DtRwReal DtFixedWingEntityParameters::myMaxGroundSpeed [protected]

Parameter Name: max-ground-speed
Parameter Description: Maximum speed when taxiing on the ground.

Parameter Default Value: 10
Parameter Units: meters/second

DtRwReal DtFixedWingEntityParameters::myMaxGroundStoppingDeceleration [protected]

Parameter Name: max-ground-stopping-deceleration Parameter Description: The maximum speed at which a fixed-wing entity can decelerate after landing.

Parameter Default Value: 4.5 Parameter Units: meters/second/second

DtRwReal DtFixedWingEntityParameters::myGroundTurningRadius [protected]

Parameter Name: ground-turning-radius
Parameter Description: Turning radius used when entity is taxiing on the ground.

Parameter Default Value: 5
Parameter Units: meters

DtRwReal DtFixedWingEntityParameters::myMaxGroundSlope [protected]

Parameter Name: max-ground-slope Parameter Description: The maximum slope that a fixed-wing entity can taxi on.

Parameter Default Value: 1.

DtRwReal DtFixedWingEntityParameters::myOnGroundTolerance [protected]

Parameter Name: on-ground-tolerance Parameter Description: The tolerance by which a fixed wing is considered on the ground or in the air.

on. Parameter Default Value: 10.

DtRwBoolean DtFixedWingEntityParameters::myOnGround [protected]

Parameter Name: on-ground
Parameter Description: Flag indicating whether or not entity is intially on the ground.

If this is false, then it is possible to initially place the entity at a given initial altitude.
Parameter Default Value: False

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

include/vrfobjparam/fixWingPar.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation