DtFixedWingDefaultControllerDescriptor Class Reference

DtFixedWingDefaultControllerDescriptor; descriptor for the DtFixedWingDefaultController component. More...

Inheritance diagram for DtFixedWingDefaultControllerDescriptor:

List of all members.

Public Member Functions
	DtFixedWingDefaultControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtFixedWingDefaultControllerDescriptor (const DtFixedWingDefaultControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtFixedWingDefaultControllerDescriptor &	operator= (const DtFixedWingDefaultControllerDescriptor &orig)
	assignment
virtual	~DtFixedWingDefaultControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	clockwise () const
	Accessor/mutator for myClockwise.
virtual void	setClockwise (bool clockwise)
	Accessor/mutator for myClockwise.
virtual DtReal	radius () const
	Accessor/mutator for myRadius.
virtual void	setRadius (DtReal radius)
	Accessor/mutator for myRadius.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtFixedWingDefaultControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myRadius
	Parameter Name: radius Parameter Description: Specifies the radius of the circle for default.
DtRwBoolean	myClockwise
	Parameter Name: clockwise Parameter Description: Specifies whether or not the default circling behavior should be clockwise or counterclockwise.

---

Detailed Description

DtFixedWingDefaultControllerDescriptor; descriptor for the DtFixedWingDefaultController component.

A type of DtFixedWingPilotControllerDescriptor that has additional information needed for providing parameters to default fixed wing controller; circle radius and direction (clockwise or not).

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtFixedWingDefaultControllerDescriptor::~DtFixedWingDefaultControllerDescriptor

(

)

[virtual]

destructor

DtFixedWingDefaultControllerDescriptor::DtFixedWingDefaultControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtFixedWingDefaultControllerDescriptor& DtFixedWingDefaultControllerDescriptor::operator=

(

const DtFixedWingDefaultControllerDescriptor &

orig

)

assignment

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

DtFixedWingDefaultControllerDescriptorType

Reimplemented from DtFixedWingPilotControllerDescriptor.

virtual DtComponentDescriptor* DtFixedWingDefaultControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtFixedWingPilotControllerDescriptor.

virtual bool DtFixedWingDefaultControllerDescriptor::clockwise

(

)

const [virtual]

Accessor/mutator for myClockwise.

virtual void DtFixedWingDefaultControllerDescriptor::setClockwise

(

bool

clockwise

)

[virtual]

Accessor/mutator for myClockwise.

virtual DtReal DtFixedWingDefaultControllerDescriptor::radius

(

)

const [virtual]

Accessor/mutator for myRadius.

virtual void DtFixedWingDefaultControllerDescriptor::setRadius

(

DtReal

radius

)

[virtual]

Accessor/mutator for myRadius.

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

---

Member Data Documentation

DtRwReal DtFixedWingDefaultControllerDescriptor::myRadius [protected]

Parameter Name: radius
Parameter Description: Specifies the radius of the circle for default.

Parameter Default Value: 3000.
Parameter Units: meters

DtRwBoolean DtFixedWingDefaultControllerDescriptor::myClockwise [protected]

Parameter Name: clockwise
Parameter Description: Specifies whether or not the default circling behavior should be clockwise or counterclockwise.

Parameter Default Value: True

---

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

• include/vrfobjparam/fixWngDefDesc.h