DtFixedWingActuatorDescriptor Class Reference

DtFixedWingActuatorDescriptor, a descriptor for the DtFixedWingActuatorComponent component. More...

Inheritance diagram for DtFixedWingActuatorDescriptor:

List of all members.

Public Member Functions
	DtFixedWingActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtFixedWingActuatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtFixedWingActuatorDescriptor (const DtFixedWingActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtFixedWingActuatorDescriptor &	operator= (const DtFixedWingActuatorDescriptor &orig)
	assignment
virtual	~DtFixedWingActuatorDescriptor ()
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setDragCoefficient (double dc)
	Accessor/mutator for myDragCoefficient.
virtual double	dragCoefficient () const
virtual DtReal	maxThrustAcceleration () const
	Accessor/mutator for myMaxThrustAcceleration.
virtual void	setMaxThrustAcceleration (DtReal maxThrustAcceleration)
	Accessor/mutator for myMaxThrustAcceleration.
virtual bool	checkTerrain () const
	Accessor/mutator for myCheckTerrain.
virtual void	setCheckTerrain (bool checkTerrain)
	Accessor/mutator for myCheckTerrain.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtFixedWingActuatorDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxThrustAcceleration
	Parameter Name: max-thrust-acceleration Parameter Description: The maximum acceleration in the direction of thrust (assumed down the X axis, the nose).
DtRwBoolean	myCheckTerrain
	Parameter Name: terrain-check Parameter Description: If terrain-check is False, entity ignores the terrain.
DtRwReal	myDragCoefficient
	Parameter Name: drag-coefficient Parameter Description: This is amount of drag associated with this entity.

---

Detailed Description

DtFixedWingActuatorDescriptor, a descriptor for the DtFixedWingActuatorComponent component.

DtFixedWingActuatorDescriptor is a kind of DtActuatorComponentDescriptor that has additional information needed for providing parameters to the kinematics-based fixed wing model (DtFixedWingActuatorComponent).

---

Constructor & Destructor Documentation

DtFixedWingActuatorDescriptor::DtFixedWingActuatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

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

DtFixedWingActuatorDescriptor::DtFixedWingActuatorDescriptor	(	const DtFixedWingActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtFixedWingActuatorDescriptor::~DtFixedWingActuatorDescriptor

(

)

[virtual]

DtFixedWingActuatorDescriptor::DtFixedWingActuatorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtFixedWingActuatorDescriptor& DtFixedWingActuatorDescriptor::operator=

(

const DtFixedWingActuatorDescriptor &

orig

)

assignment

virtual DtString DtFixedWingActuatorDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtFixedWingActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtFixedWingActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

virtual DtReal DtFixedWingActuatorDescriptor::maxThrustAcceleration

(

)

const [virtual]

Accessor/mutator for myMaxThrustAcceleration.

virtual void DtFixedWingActuatorDescriptor::setMaxThrustAcceleration

(

DtReal

maxThrustAcceleration

)

[virtual]

Accessor/mutator for myMaxThrustAcceleration.

virtual bool DtFixedWingActuatorDescriptor::checkTerrain

(

)

const [virtual]

Accessor/mutator for myCheckTerrain.

virtual void DtFixedWingActuatorDescriptor::setCheckTerrain

(

bool

checkTerrain

)

[virtual]

Accessor/mutator for myCheckTerrain.

virtual void DtFixedWingActuatorDescriptor::setDragCoefficient

(

double

dc

)

[virtual]

Accessor/mutator for myDragCoefficient.

This controls the amount of drag this entity experiences.

virtual double DtFixedWingActuatorDescriptor::dragCoefficient

(

)

const [virtual]

static DtComponentDescriptor* DtFixedWingActuatorDescriptor::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 DtActuatorComponentDescriptor.

---

Member Data Documentation

DtRwReal DtFixedWingActuatorDescriptor::myMaxThrustAcceleration [protected]

Parameter Name: max-thrust-acceleration
Parameter Description: The maximum acceleration in the direction of thrust (assumed down the X axis, the nose).

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

DtRwBoolean DtFixedWingActuatorDescriptor::myCheckTerrain [protected]

Parameter Name: terrain-check
Parameter Description: If terrain-check is False, entity ignores the terrain.

It could appear to fly below ground. However, when terrain-check is set to False, VR-Forces does not have to check ground points, so performance may improve. When terrain-check is True, if a rotary-wing or fixed-wing entity approaches a ground point at three meters per second or less, it lands. If it approaches the ground at a greater speed, it crashes. Parameter Default Value: True

DtRwReal DtFixedWingActuatorDescriptor::myDragCoefficient [protected]

Parameter Name: drag-coefficient
Parameter Description: This is amount of drag associated with this entity.

Parameter Default Value: 0.03

---

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

• include/vrfobjparam/fixWngActDesc.h