DtGroundCollisionAvoidanceDescriptor Class Reference

DtGroundCollisionControllerDescriptor is a kind of DtComponentDescriptor containing parameters for a ground collision avoidance controller. More...

Inheritance diagram for DtGroundCollisionAvoidanceDescriptor:

List of all members.

Public Member Functions
	DtGroundCollisionAvoidanceDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtGroundCollisionAvoidanceDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtGroundCollisionAvoidanceDescriptor (const DtGroundCollisionAvoidanceDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtGroundCollisionAvoidanceDescriptor &	operator= (const DtGroundCollisionAvoidanceDescriptor &orig)
	assignment
virtual	~DtGroundCollisionAvoidanceDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
	returns a clone of this DtGroundCollisionAvoidanceDescriptor
virtual DtReal	stoppingDistanceFactor () const
	Accessor/mutator for myStoppingDistanceFactor.
virtual void	setStoppingDistanceFactor (DtReal distance)
	Accessor/mutator for myStoppingDistanceFactor.
virtual DtReal	lateralClearance () const
	Accessor/mutator for myLateralClearance.
virtual void	setLateralClearance (DtReal distance)
	Accessor/mutator for myLateralClearance.
virtual DtReal	timeToCollide () const
	Accessor/mutator for myTimeToCollide.
virtual void	setTimeToCollide (DtReal frames)
	Accessor/mutator for myTimeToCollide.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtGroundCollisionAvoidanceDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myTimeToCollide
	Parameter Name: time-to-collide Parameter Description: The minimum time before a collision (in seconds) which the collision avoidance controller compares to its own estimate of the time before a rear end collision to determine when to apply the brakes.
DtRwReal	myLateralClearance
	Parameter Name: lateral-clearance Parameter Description: The width (in meters) added to the length of the bounding volume which is checked for potential collisions.
DtRwReal	myStoppingDistanceFactor
	Parameter Name: stopping-distance-factor Parameter Description: The factor by which the collision avoidance controller multiplies the current stopping distance to determine the length of the bounding volume which is checked for potential collisions.

---

Detailed Description

DtGroundCollisionControllerDescriptor is a kind of DtComponentDescriptor containing parameters for a ground collision avoidance controller.

End User Description: It knows the name of the DtGroundFollowEntityController (if any) being used by this entity. When available, this can be used to find out if the entity is following another entity; the collision avoidance controller can then avoid trying to go around that entity.

---

Constructor & Destructor Documentation

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

real constructor

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

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

copy constructor

virtual DtGroundCollisionAvoidanceDescriptor::~DtGroundCollisionAvoidanceDescriptor

(

)

[virtual]

destructor

DtGroundCollisionAvoidanceDescriptor::DtGroundCollisionAvoidanceDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtGroundCollisionAvoidanceDescriptor& DtGroundCollisionAvoidanceDescriptor::operator=

(

const DtGroundCollisionAvoidanceDescriptor &

orig

)

assignment

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

DtGroundCollisionAvoidanceDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtReal DtGroundCollisionAvoidanceDescriptor::stoppingDistanceFactor

(

)

const [virtual]

Accessor/mutator for myStoppingDistanceFactor.

virtual void DtGroundCollisionAvoidanceDescriptor::setStoppingDistanceFactor

(

DtReal

distance

)

[virtual]

Accessor/mutator for myStoppingDistanceFactor.

virtual DtReal DtGroundCollisionAvoidanceDescriptor::lateralClearance

(

)

const [virtual]

Accessor/mutator for myLateralClearance.

virtual void DtGroundCollisionAvoidanceDescriptor::setLateralClearance

(

DtReal

distance

)

[virtual]

Accessor/mutator for myLateralClearance.

virtual DtReal DtGroundCollisionAvoidanceDescriptor::timeToCollide

(

)

const [virtual]

Accessor/mutator for myTimeToCollide.

virtual void DtGroundCollisionAvoidanceDescriptor::setTimeToCollide

(

DtReal

frames

)

[virtual]

Accessor/mutator for myTimeToCollide.

virtual DtComponentDescriptor* DtGroundCollisionAvoidanceDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

returns a clone of this DtGroundCollisionAvoidanceDescriptor

Reimplemented from DtComponentDescriptor.

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

---

Member Data Documentation

DtRwReal DtGroundCollisionAvoidanceDescriptor::myTimeToCollide [protected]

Parameter Name: time-to-collide
Parameter Description: The minimum time before a collision (in seconds) which the collision avoidance controller compares to its own estimate of the time before a rear end collision to determine when to apply the brakes.

Parameter Default Value: 3.
Parameter Units: seconds

DtRwReal DtGroundCollisionAvoidanceDescriptor::myLateralClearance [protected]

Parameter Name: lateral-clearance
Parameter Description: The width (in meters) added to the length of the bounding volume which is checked for potential collisions.

Parameter Default Value: 6.
Parameter Units: meters

DtRwReal DtGroundCollisionAvoidanceDescriptor::myStoppingDistanceFactor [protected]

Parameter Name: stopping-distance-factor
Parameter Description: The factor by which the collision avoidance controller multiplies the current stopping distance to determine the length of the bounding volume which is checked for potential collisions.

Parameter Default Value: 3.

---

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

• include/vrfobjparam/gndCollDesc.h