DtRotaryWingTaskDescriptor Class Reference

DtRotaryWingTaskDescriptor; descriptor for the rotary wing task components. More...

Inheritance diagram for DtRotaryWingTaskDescriptor:

List of all members.

Public Member Functions
	DtRotaryWingTaskDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtRotaryWingTaskDescriptor (const DtRotaryWingTaskDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtRotaryWingTaskDescriptor &	operator= (const DtRotaryWingTaskDescriptor &orig)
	assignment
virtual	~DtRotaryWingTaskDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
	Clone creates a new copy.
virtual DtReal	defaultAggressiveness () const
	Accessor/mutator for myDefaultAggressiveness.
virtual void	setDefaultAggressiveness (const DtReal value)
	Accessor/mutator for myDefaultAggressiveness.
virtual DtReal	transitionRadius () const
	Accessor/mutator for myTransitionRadius.
virtual void	setTransitionRadius (const DtReal value)
	Accessor/mutator for myTransitionRadius.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtRotaryWingTaskDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myDefaultAggressiveness
	Parameter Name: default-aggressiveness Parameter Description: Acceleration level used by the helicopter in maneuvers is scaled by this value.
DtRwReal	myTransitionRadius
	Parameter Name: transition-radius Parameter Description: Distance (in meters) from a point or route endpoint within with the helicopter will complete movement tasks.

---

Detailed Description

DtRotaryWingTaskDescriptor; descriptor for the rotary wing task components.

DtRotaryWingTaskDescriptor is a component descriptor for helicopter task controllers.

---

Constructor & Destructor Documentation

DtRotaryWingTaskDescriptor::DtRotaryWingTaskDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtRotaryWingTaskDescriptor::DtRotaryWingTaskDescriptor	(	const DtRotaryWingTaskDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtRotaryWingTaskDescriptor::~DtRotaryWingTaskDescriptor

(

)

[virtual]

destructor

DtRotaryWingTaskDescriptor::DtRotaryWingTaskDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtRotaryWingTaskDescriptor& DtRotaryWingTaskDescriptor::operator=

(

const DtRotaryWingTaskDescriptor &

orig

)

assignment

virtual DtString DtRotaryWingTaskDescriptor::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:

DtRotaryWingTaskDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtRotaryWingRouteTaskDescriptor, and DtRotaryWingColAvoidanceControllerDescriptor.

virtual DtComponentDescriptor* DtRotaryWingTaskDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Clone creates a new copy.

Reimplemented from DtComponentDescriptor.

Reimplemented in DtRotaryWingRouteTaskDescriptor, and DtRotaryWingColAvoidanceControllerDescriptor.

virtual DtReal DtRotaryWingTaskDescriptor::defaultAggressiveness

(

)

const [virtual]

Accessor/mutator for myDefaultAggressiveness.

virtual void DtRotaryWingTaskDescriptor::setDefaultAggressiveness

(

const DtReal

value

)

[virtual]

Accessor/mutator for myDefaultAggressiveness.

virtual DtReal DtRotaryWingTaskDescriptor::transitionRadius

(

)

const [virtual]

Accessor/mutator for myTransitionRadius.

virtual void DtRotaryWingTaskDescriptor::setTransitionRadius

(

const DtReal

value

)

[virtual]

Accessor/mutator for myTransitionRadius.

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

Reimplemented in DtRotaryWingColAvoidanceControllerDescriptor, and DtRotaryWingRouteTaskDescriptor.

---

Member Data Documentation

DtRwReal DtRotaryWingTaskDescriptor::myDefaultAggressiveness [protected]

Parameter Name: default-aggressiveness
Parameter Description: Acceleration level used by the helicopter in maneuvers is scaled by this value.

Range: 0.0 to 1.0.
Parameter Default Value: 0.5

DtRwReal DtRotaryWingTaskDescriptor::myTransitionRadius [protected]

Parameter Name: transition-radius
Parameter Description: Distance (in meters) from a point or route endpoint within with the helicopter will complete movement tasks.

Parameter Default Value: 10.0
Parameter Units: meters

---

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

• include/vrfobjparam/rotWingTaskDesc.h