DtRotaryWingColAvoidanceControllerDescriptor Class Reference

DtRotaryWingColAvoidanceControllerDescriptor; descriptor for the DtRotaryWingCollisionAvoidanceController component. More...

Inheritance diagram for DtRotaryWingColAvoidanceControllerDescriptor:

List of all members.

Public Member Functions
	DtRotaryWingColAvoidanceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtRotaryWingColAvoidanceControllerDescriptor ()
	destructor
	DtRotaryWingColAvoidanceControllerDescriptor (const DtRotaryWingColAvoidanceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtRotaryWingColAvoidanceControllerDescriptor &	operator= (const DtRotaryWingColAvoidanceControllerDescriptor &orig)
	assignment operator
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	nominalDistance () const
	Accessor/mutator for myNominalDistance.
virtual void	setNominalDistance (DtReal val)
	Accessor/mutator for myNominalDistance.
virtual DtReal	searchDistance () const
	Accessor/mutator for mySearchDistance.
virtual void	setSearchDistance (DtReal val)
	Accessor/mutator for mySearchDistance.
virtual DtReal	collisionLimit () const
	Accessor/mutator for myCollisionLimit.
virtual void	setCollisionLimit (DtReal val)
	Accessor/mutator for myCollisionLimit.
virtual DtReal	clearingDistance () const
	Accessor/mutator for myClearingDistance.
virtual void	setClearingDistance (DtReal val)
	Accessor/mutator for myClearingDistance.
virtual DtReal	timeToMinDistance () const
	Accessor/mutator for myTimeToMinDistance.
virtual void	setTimeToMinDistance (DtReal val)
	Accessor/mutator for myTimeToMinDistance.
virtual DtReal	driftSpeed () const
	Accessor/mutator for myDriftSpeed.
virtual void	setDriftSpeed (DtReal val)
	Accessor/mutator for myDriftSpeed.
virtual DtReal	minDiveAltitude () const
	Accessor/mutator for myMinDiveAltitude.
virtual void	setMinDiveAltitude (DtReal val)
	Accessor/mutator for myMinDiveAltitude.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
virtual void	setDefaults ()
virtual void	copyValues (const DtRotaryWingColAvoidanceControllerDescriptor &orig)
	DtRotaryWingColAvoidanceControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myNominalDistance
	Parameter Name: nominal-distance Parameter Description: This entity will move this distnace from an entity when it is avoiding a collision with it.
DtRwReal	mySearchDistance
	Parameter Name: search-distance Parameter Description: Entities within this distance will be checked for potential collisions with this entity.
DtRwReal	myCollisionLimit
	Parameter Name: collision-limit Parameter Description: The closest this entity should come to another entity.
DtRwReal	myClearingDistance
	Parameter Name: clearing-distance Parameter Description: When avoiding a collision, the collision is considered clear once this distance is between the two entities.
DtRwReal	myTimeToMinDistance
	Parameter Name: time-to-minimum-distance Parameter Description: Entity will start responding to potential collisions when the projected time to the entities being closer than collision-limit distance is smaller than this value.
DtRwReal	myDriftSpeed
	Parameter Name: drifting-speed Parameter Description: The maximum speed which is still considered stopped.
DtRwReal	myMinDiveAltitude
	Parameter Name: minimum-diving-altitude Parameter Description: When altitude is lower than this value, the entity will not dive to avoid a collision.

---

Detailed Description

DtRotaryWingColAvoidanceControllerDescriptor; descriptor for the DtRotaryWingCollisionAvoidanceController component.

Instances of DtRotaryWingColAvoidanceControllerDescriptor are used to specify the parameters for a DtRotaryWingCollisionAvoidanceController object.

---

Constructor & Destructor Documentation

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

constructor

virtual DtRotaryWingColAvoidanceControllerDescriptor::~DtRotaryWingColAvoidanceControllerDescriptor

(

)

[virtual]

destructor

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

copy constructor

DtRotaryWingColAvoidanceControllerDescriptor::DtRotaryWingColAvoidanceControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtRotaryWingColAvoidanceControllerDescriptor& DtRotaryWingColAvoidanceControllerDescriptor::operator=

(

const DtRotaryWingColAvoidanceControllerDescriptor &

orig

)

assignment operator

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

DtRotaryWingColAvoidanceControllerDescriptorType

Reimplemented from DtRotaryWingTaskDescriptor.

virtual DtComponentDescriptor* DtRotaryWingColAvoidanceControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Returns:

New copy of this object.

Reimplemented from DtRotaryWingTaskDescriptor.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::nominalDistance

(

)

const [virtual]

Accessor/mutator for myNominalDistance.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setNominalDistance

(

DtReal

val

)

[virtual]

Accessor/mutator for myNominalDistance.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::searchDistance

(

)

const [virtual]

Accessor/mutator for mySearchDistance.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setSearchDistance

(

DtReal

val

)

[virtual]

Accessor/mutator for mySearchDistance.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::collisionLimit

(

)

const [virtual]

Accessor/mutator for myCollisionLimit.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setCollisionLimit

(

DtReal

val

)

[virtual]

Accessor/mutator for myCollisionLimit.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::clearingDistance

(

)

const [virtual]

Accessor/mutator for myClearingDistance.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setClearingDistance

(

DtReal

val

)

[virtual]

Accessor/mutator for myClearingDistance.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::timeToMinDistance

(

)

const [virtual]

Accessor/mutator for myTimeToMinDistance.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setTimeToMinDistance

(

DtReal

val

)

[virtual]

Accessor/mutator for myTimeToMinDistance.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::driftSpeed

(

)

const [virtual]

Accessor/mutator for myDriftSpeed.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setDriftSpeed

(

DtReal

val

)

[virtual]

Accessor/mutator for myDriftSpeed.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::minDiveAltitude

(

)

const [virtual]

Accessor/mutator for myMinDiveAltitude.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setMinDiveAltitude

(

DtReal

val

)

[virtual]

Accessor/mutator for myMinDiveAltitude.

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

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setDefaults

(

)

[protected, virtual]

virtual void DtRotaryWingColAvoidanceControllerDescriptor::copyValues

(

const DtRotaryWingColAvoidanceControllerDescriptor &

orig

)

[protected, virtual]

---

Member Data Documentation

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myNominalDistance [protected]

Parameter Name: nominal-distance
Parameter Description: This entity will move this distnace from an entity when it is avoiding a collision with it.

Parameter Default Value: 100.0
Parameter Units: meters

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::mySearchDistance [protected]

Parameter Name: search-distance
Parameter Description: Entities within this distance will be checked for potential collisions with this entity.

Parameter Default Value: 1000.0
Parameter Units: meters

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myCollisionLimit [protected]

Parameter Name: collision-limit
Parameter Description: The closest this entity should come to another entity.

Parameter Default Value: 40.0
Parameter Units: meters

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myClearingDistance [protected]

Parameter Name: clearing-distance
Parameter Description: When avoiding a collision, the collision is considered clear once this distance is between the two entities.

Parameter Default Value: 50.0
Parameter Units: meters

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myTimeToMinDistance [protected]

Parameter Name: time-to-minimum-distance
Parameter Description: Entity will start responding to potential collisions when the projected time to the entities being closer than collision-limit distance is smaller than this value.

Smaller times will result in later responses to potential collisions.
Parameter Default Value: 10.0
Parameter Units: seconds

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myDriftSpeed [protected]

Parameter Name: drifting-speed
Parameter Description: The maximum speed which is still considered stopped.

This applied both to this entity, and to other entities this controller is examining.
Parameter Default Value: 5.0
Parameter Units: meters/second

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myMinDiveAltitude [protected]

Parameter Name: minimum-diving-altitude
Parameter Description: When altitude is lower than this value, the entity will not dive to avoid a collision.

Parameter Default Value: 100.0
Parameter Units: meters

---

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

• include/vrfobjparam/rotWgColAvDsc.h