DtRotaryWingRouteTaskDescriptor Class Reference

DtRotaryWingRouteTaskDescriptor; descriptor for the DtRotaryWingMoveAlongControllerComponent and DtRotaryWingPatrolRouteController components. More...

Inheritance diagram for DtRotaryWingRouteTaskDescriptor:

List of all members.

Public Member Functions
	DtRotaryWingRouteTaskDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtRotaryWingRouteTaskDescriptor (const DtRotaryWingRouteTaskDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtRotaryWingRouteTaskDescriptor &	operator= (const DtRotaryWingRouteTaskDescriptor &orig)
	assignment
virtual	~DtRotaryWingRouteTaskDescriptor ()
	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	routeTransitionRadius () const
	Accessor/mutator for myRouteTransitionRadius.
virtual void	setRouteTransitionRadius (const DtReal value)
	Accessor/mutator for myRouteTransitionRadius.
virtual DtReal	routeXGain () const
	Accessor/mutator for myRouteXGain.
virtual void	setRouteXGain (const DtReal value)
	Accessor/mutator for myRouteXGain.
virtual DtReal	routeYGain () const
	Accessor/mutator for myRouteYGain.
virtual void	setRouteYGain (const DtReal value)
	Accessor/mutator for myRouteYGain.
virtual DtReal	routeZGain () const
	Accessor/mutator for myRouteZGain.
virtual void	setRouteZGain (const DtReal value)
	Accessor/mutator for myRouteZGain.
virtual DtReal	routeLookaheadFactor () const
	Accessor/mutator for myRouteLookaheadFactor.
virtual void	setRouteLookaheadFactor (const DtReal value)
	Accessor/mutator for myRouteLookaheadFactor.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myRouteTransitionRadius
	Parameter Name: route-transition-radius Parameter Description: Transition radius for route points.
DtRwReal	myRouteXGain
	Parameter Name: route-x-gain Parameter Description: Route x-gain for route-position feedback.
DtRwReal	myRouteYGain
	Parameter Name: route-y-gain Parameter Description: Route y-gain for route-position feedback.
DtRwReal	myRouteZGain
	Parameter Name: route-z-gain Parameter Description: Route z-gain for route-position feedback.
DtRwReal	myRouteLookaheadFactor
	Parameter Name: route-lookahead-factor Parameter Description: Route lookahead factor for route following.
Private Member Functions
	DtRotaryWingRouteTaskDescriptor ()
	default constructor not implemented

---

Detailed Description

DtRotaryWingRouteTaskDescriptor; descriptor for the DtRotaryWingMoveAlongControllerComponent and DtRotaryWingPatrolRouteController components.

DtRotaryWingRouteTaskDescriptor is a component descriptor for helicopter controllers that follow a route. This descriptor includes gain, control-parameter, and transition-radius data.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtRotaryWingRouteTaskDescriptor::~DtRotaryWingRouteTaskDescriptor

(

)

[virtual]

destructor

DtRotaryWingRouteTaskDescriptor::DtRotaryWingRouteTaskDescriptor

(

)

[private]

default constructor not implemented

---

Member Function Documentation

DtRotaryWingRouteTaskDescriptor& DtRotaryWingRouteTaskDescriptor::operator=

(

const DtRotaryWingRouteTaskDescriptor &

orig

)

assignment

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

DtRotaryWingPilotDescriptorType

Reimplemented from DtRotaryWingTaskDescriptor.

virtual DtComponentDescriptor* DtRotaryWingRouteTaskDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Clone creates a new copy.

Reimplemented from DtRotaryWingTaskDescriptor.

virtual DtReal DtRotaryWingRouteTaskDescriptor::routeTransitionRadius

(

)

const [virtual]

Accessor/mutator for myRouteTransitionRadius.

virtual void DtRotaryWingRouteTaskDescriptor::setRouteTransitionRadius

(

const DtReal

value

)

[virtual]

Accessor/mutator for myRouteTransitionRadius.

virtual DtReal DtRotaryWingRouteTaskDescriptor::routeXGain

(

)

const [virtual]

Accessor/mutator for myRouteXGain.

virtual void DtRotaryWingRouteTaskDescriptor::setRouteXGain

(

const DtReal

value

)

[virtual]

Accessor/mutator for myRouteXGain.

virtual DtReal DtRotaryWingRouteTaskDescriptor::routeYGain

(

)

const [virtual]

Accessor/mutator for myRouteYGain.

virtual void DtRotaryWingRouteTaskDescriptor::setRouteYGain

(

const DtReal

value

)

[virtual]

Accessor/mutator for myRouteYGain.

virtual DtReal DtRotaryWingRouteTaskDescriptor::routeZGain

(

)

const [virtual]

Accessor/mutator for myRouteZGain.

virtual void DtRotaryWingRouteTaskDescriptor::setRouteZGain

(

const DtReal

value

)

[virtual]

Accessor/mutator for myRouteZGain.

virtual DtReal DtRotaryWingRouteTaskDescriptor::routeLookaheadFactor

(

)

const [virtual]

Accessor/mutator for myRouteLookaheadFactor.

virtual void DtRotaryWingRouteTaskDescriptor::setRouteLookaheadFactor

(

const DtReal

value

)

[virtual]

Accessor/mutator for myRouteLookaheadFactor.

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

---

Member Data Documentation

DtRwReal DtRotaryWingRouteTaskDescriptor::myRouteTransitionRadius [protected]

Parameter Name: route-transition-radius
Parameter Description: Transition radius for route points.

If the helicopter begins moving away from a route point within this radius, it transitions to the next route point.
Parameter Default Value: 150.0
Parameter Units: meters

DtRwReal DtRotaryWingRouteTaskDescriptor::myRouteXGain [protected]

Parameter Name: route-x-gain
Parameter Description: Route x-gain for route-position feedback.

Parameter Default Value: 0.05

DtRwReal DtRotaryWingRouteTaskDescriptor::myRouteYGain [protected]

Parameter Name: route-y-gain
Parameter Description: Route y-gain for route-position feedback.

Parameter Default Value: 0.05

DtRwReal DtRotaryWingRouteTaskDescriptor::myRouteZGain [protected]

Parameter Name: route-z-gain
Parameter Description: Route z-gain for route-position feedback.

Parameter Default Value: 0.02

DtRwReal DtRotaryWingRouteTaskDescriptor::myRouteLookaheadFactor [protected]

Parameter Name: route-lookahead-factor
Parameter Description: Route lookahead factor for route following.

The lookahead factor ranges from 0-1, with 0 giving sharp turns at waypoints and 1 giving very rounded turns at waypoints.
Parameter Default Value: 0.5

---

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

• include/vrfobjparam/rotWingRtTaskDesc.h