DtConvoyDescriptor Class Reference

A DtComponentDescriptor that has parameters that indicate the distances at which the entity is considered at a given waypoint or near a given waypoint. More...

Inheritance diagram for DtConvoyDescriptor:

List of all members.

Public Member Functions
	DtConvoyDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtConvoyDescriptor (const DtConvoyDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtConvoyDescriptor &	operator= (const DtConvoyDescriptor &orig)
	assignment
virtual	~DtConvoyDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual void	setSeparationDistance (DtReal distance)
virtual DtReal	separationDistance () const
virtual void	setSeparationTolerance (DtReal tolerancePercent)
virtual DtReal	separationTolerance () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtConvoyDescriptor ()
	default constructor; not implemented
Protected Attributes
DtRwReal	mySeparationDistance
DtRwReal	mySeparationTolerance

---

Detailed Description

A DtComponentDescriptor that has parameters that indicate the distances at which the entity is considered at a given waypoint or near a given waypoint.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtConvoyDescriptor::~DtConvoyDescriptor

(

)

[virtual]

destructor

DtConvoyDescriptor::DtConvoyDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtConvoyDescriptor& DtConvoyDescriptor::operator=

(

const DtConvoyDescriptor &

orig

)

assignment

virtual DtString DtConvoyDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

This will be used to create the descriptor on read from an mtl file.

Reimplemented from DtRailPathControllerDescriptor.

virtual void DtConvoyDescriptor::setSeparationDistance

(

DtReal

distance

)

[virtual]

virtual DtReal DtConvoyDescriptor::separationDistance

(

)

const [virtual]

virtual void DtConvoyDescriptor::setSeparationTolerance

(

DtReal

tolerancePercent

)

[virtual]

virtual DtReal DtConvoyDescriptor::separationTolerance

(

)

const [virtual]

virtual DtComponentDescriptor* DtConvoyDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtRailPathControllerDescriptor.

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

---

Member Data Documentation

DtRwReal DtConvoyDescriptor::mySeparationDistance [protected]

DtRwReal DtConvoyDescriptor::mySeparationTolerance [protected]

---

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

• include/vrfobjparam/convoyDescriptor.h