DtSurfaceEntityPilotControllerDescriptor Class Reference

Contains class declaration for DtSurfaceEntityPilotControllerDescriptor; descriptor for the DtSurfaceEntityPilotController component. More...

Inheritance diagram for DtSurfaceEntityPilotControllerDescriptor:

List of all members.

Public Member Functions
	DtSurfaceEntityPilotControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtSurfaceEntityPilotControllerDescriptor (const DtSurfaceEntityPilotControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSurfaceEntityPilotControllerDescriptor &	operator= (const DtSurfaceEntityPilotControllerDescriptor &orig)
	assignment
virtual	~DtSurfaceEntityPilotControllerDescriptor ()
virtual void	setAtDistance (DtReal atDistance)
virtual DtReal	atDistance () const
	Accessor/mutator for myAtDistance.
virtual void	setNearDistance (DtReal nearDistance)
virtual DtReal	nearDistance () const
	Accessor/mutator for myNearDistance.
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtSurfaceEntityPilotControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myAtDistance
	Parameter Name: at-distance Parameter Description: The distance from a destination point at which an entity considers itself to have arrived at that point.
DtRwReal	myNearDistance
	Parameter Name: near-distance Parameter Description: The distance from a destination point at which an entity begins to slow down.

---

Detailed Description

Contains class declaration for DtSurfaceEntityPilotControllerDescriptor; descriptor for the DtSurfaceEntityPilotController component.

A DtComponentDescriptor that has additional information needed for providing parameters to the derived DtSurfaceEntityPilotController objects.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtSurfaceEntityPilotControllerDescriptor::~DtSurfaceEntityPilotControllerDescriptor

(

)

[virtual]

DtSurfaceEntityPilotControllerDescriptor::DtSurfaceEntityPilotControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

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

const DtSurfaceEntityPilotControllerDescriptor& DtSurfaceEntityPilotControllerDescriptor::operator=

(

const DtSurfaceEntityPilotControllerDescriptor &

orig

)

assignment

virtual void DtSurfaceEntityPilotControllerDescriptor::setAtDistance

(

DtReal

atDistance

)

[virtual]

virtual DtReal DtSurfaceEntityPilotControllerDescriptor::atDistance

(

)

const [virtual]

Accessor/mutator for myAtDistance.

virtual void DtSurfaceEntityPilotControllerDescriptor::setNearDistance

(

DtReal

nearDistance

)

[virtual]

virtual DtReal DtSurfaceEntityPilotControllerDescriptor::nearDistance

(

)

const [virtual]

Accessor/mutator for myNearDistance.

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

DtSurfaceEntityPilotControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtSurfaceEntityRoutePilotDescriptor.

virtual DtComponentDescriptor* DtSurfaceEntityPilotControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtSurfaceEntityRoutePilotDescriptor.

---

Member Data Documentation

DtRwReal DtSurfaceEntityPilotControllerDescriptor::myAtDistance [protected]

Parameter Name: at-distance
Parameter Description: The distance from a destination point at which an entity considers itself to have arrived at that point.

Parameter Default Value: 500.
Parameter Units: meters

DtRwReal DtSurfaceEntityPilotControllerDescriptor::myNearDistance [protected]

Parameter Name: near-distance
Parameter Description: The distance from a destination point at which an entity begins to slow down.

Parameter Default Value: 1000.
Parameter Units: meters

---

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

• include/vrfobjparam/surfEntPltDesc.h