DtAggregateMoveAlongDescriptor Class Reference

Class DtAggregateMoveAlongDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateMoveAlongController model component. More...

Inheritance diagram for DtAggregateMoveAlongDescriptor:

List of all members.

Public Member Functions
	DtAggregateMoveAlongDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAggregateMoveAlongDescriptor (const DtAggregateMoveAlongDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtAggregateMoveAlongDescriptor &	operator= (const DtAggregateMoveAlongDescriptor &orig)
	assignment
virtual	~DtAggregateMoveAlongDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	catchUpFactor () const
	Accessor/mutator for myCatchupFactor.
virtual void	setCatchUpFactor (double catchUpFactor)
	Accessor/mutator for myCatchupFactor.
virtual DtReal	slowDownFactor () const
	Accessor/mutator for mySlowDownFactor.
virtual void	setSlowDownFactor (double slowDownFactor)
	Accessor/mutator for mySlowDownFactor.
virtual double	inPositionTolerance () const
	Accessor/mutator for myInPositionTolerance.
virtual void	setInPositionTolerance (double tolerance)
	Accessor/mutator for myInPositionTolerance.
virtual DtTime	evaluationInterval () const
	Accessor/mutator for myEvaluationInterval.
virtual void	setEvaluationInterval (DtTime intervalInSeconds)
	Accessor/mutator for myEvaluationInterval.
virtual bool	generateRoutesWithRoundedCorners () const
	Accessor/mutator for myGenerateRoutesWithRoundedCorners.
virtual void	setGenerateRoutesWithRoundedCorners (bool yesNo)
	Accessor/mutator for myGenerateRoutesWithRoundedCorners.
virtual double	vertexSpacingAlongRoundedCorners () const
	Accessor/mutator for myVertexSpacingAlongRoundedCorners.
virtual void	setVertexSpacingAlongRoundedCorners (double spacingInMeters)
	Accessor/mutator for myVertexSpacingAlongRoundedCorners.
virtual bool	groundClamp () const
	Accessor/mutator for myGroundClamp.
virtual void	setGroundClamp (bool yesNo)
	Accessor/mutator for myGroundClamp.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtAggregateMoveAlongDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myCatchupFactor
	Parameter Name: catchup-factor Parameter Description: Speed multiplier factor set in its subordiantes when they are falling behind in formation.
DtRwReal	mySlowDownFactor
	Parameter Name: slowdown-factor Parameter Description: Speed multiplier the aggregate uses to send speed control messages to a subordinate when it is ahead of where it should be in formation.
DtRwReal	myInPositionTolerance
	Parameter Name: in-position-tolerance Parameter Description: Tolerance about which an entity is considered to be 'in position' while moving in formation.
DtRwReal	myEvaluationInterval
	Parameter Name: evaluation-interval Parameter Description: Evaluation rate for monitoring subordinate position status.
DtRwBoolean	myGenerateRoutesWithRoundedCorners
	Parameter Name: generate-routes-with-rounded-corners Parameter Description: Choice as to whether or not to generate offset routes with 'rounded' corners.
DtRwReal	myVertexSpacingAlongRoundedCorners
	Parameter Name: vertex-spacing-along-rounded-corners Parameter Description: Spacing between vertices in meters on the rounded corners of generated routes, if generateRoutesWithRoundedCorners() is true.
DtRwBoolean	myGroundClamp
	Parameter Name: ground-clamp Parameter Description: Ground-clamp generated route vertices.

---

Detailed Description

Class DtAggregateMoveAlongDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateMoveAlongController model component.

End User Description: The DtAggregateMoveAlongDescriptor should only be configured as a part of aggregate entity types (entities configured with a vrf-aggregate-state-repository).

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtAggregateMoveAlongDescriptor::~DtAggregateMoveAlongDescriptor

(

)

[virtual]

destructor

DtAggregateMoveAlongDescriptor::DtAggregateMoveAlongDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtAggregateMoveAlongDescriptor& DtAggregateMoveAlongDescriptor::operator=

(

const DtAggregateMoveAlongDescriptor &

orig

)

assignment

virtual DtString DtAggregateMoveAlongDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

Used to create the descriptor when read in from an mtl file. Descriptor types are defined in compDescTypes.h

Returns:

DtAggregateMoveAlongControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtReal DtAggregateMoveAlongDescriptor::catchUpFactor

(

)

const [virtual]

Accessor/mutator for myCatchupFactor.

virtual void DtAggregateMoveAlongDescriptor::setCatchUpFactor

(

double

catchUpFactor

)

[virtual]

Accessor/mutator for myCatchupFactor.

virtual DtReal DtAggregateMoveAlongDescriptor::slowDownFactor

(

)

const [virtual]

Accessor/mutator for mySlowDownFactor.

virtual void DtAggregateMoveAlongDescriptor::setSlowDownFactor

(

double

slowDownFactor

)

[virtual]

Accessor/mutator for mySlowDownFactor.

virtual double DtAggregateMoveAlongDescriptor::inPositionTolerance

(

)

const [virtual]

Accessor/mutator for myInPositionTolerance.

virtual void DtAggregateMoveAlongDescriptor::setInPositionTolerance

(

double

tolerance

)

[virtual]

Accessor/mutator for myInPositionTolerance.

virtual DtTime DtAggregateMoveAlongDescriptor::evaluationInterval

(

)

const [virtual]

Accessor/mutator for myEvaluationInterval.

virtual void DtAggregateMoveAlongDescriptor::setEvaluationInterval

(

DtTime

intervalInSeconds

)

[virtual]

Accessor/mutator for myEvaluationInterval.

virtual bool DtAggregateMoveAlongDescriptor::generateRoutesWithRoundedCorners

(

)

const [virtual]

Accessor/mutator for myGenerateRoutesWithRoundedCorners.

virtual void DtAggregateMoveAlongDescriptor::setGenerateRoutesWithRoundedCorners

(

bool

yesNo

)

[virtual]

Accessor/mutator for myGenerateRoutesWithRoundedCorners.

virtual double DtAggregateMoveAlongDescriptor::vertexSpacingAlongRoundedCorners

(

)

const [virtual]

Accessor/mutator for myVertexSpacingAlongRoundedCorners.

virtual void DtAggregateMoveAlongDescriptor::setVertexSpacingAlongRoundedCorners

(

double

spacingInMeters

)

[virtual]

Accessor/mutator for myVertexSpacingAlongRoundedCorners.

virtual bool DtAggregateMoveAlongDescriptor::groundClamp

(

)

const [virtual]

Accessor/mutator for myGroundClamp.

virtual void DtAggregateMoveAlongDescriptor::setGroundClamp

(

bool

yesNo

)

[virtual]

Accessor/mutator for myGroundClamp.

virtual DtComponentDescriptor* DtAggregateMoveAlongDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtAggregateMoveAlongDescriptor::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 DtAggregateMoveAlongDescriptor::myCatchupFactor [protected]

Parameter Name: catchup-factor
Parameter Description: Speed multiplier factor set in its subordiantes when they are falling behind in formation.

Catchup factor is multiplied by ordered speed.
Parameter Default Value: 1.5

DtRwReal DtAggregateMoveAlongDescriptor::mySlowDownFactor [protected]

Parameter Name: slowdown-factor
Parameter Description: Speed multiplier the aggregate uses to send speed control messages to a subordinate when it is ahead of where it should be in formation.

Factor is multiplied by ordered speed.
Parameter Default Value: 0.1

DtRwReal DtAggregateMoveAlongDescriptor::myInPositionTolerance [protected]

Parameter Name: in-position-tolerance
Parameter Description: Tolerance about which an entity is considered to be 'in position' while moving in formation.

Expressed as a fraction of formation spacing (distance between an entity and the entity it is relative to in formation). If entity is +/- (0.5 * tolerance * formation spacing), aggregate sends a set speed message to the subordinate, indicating it should slow down or speed up, accordingly.
Parameter Default Value: 0.25

DtRwReal DtAggregateMoveAlongDescriptor::myEvaluationInterval [protected]

Parameter Name: evaluation-interval
Parameter Description: Evaluation rate for monitoring subordinate position status.

Parameter Default Value: 1.0
Parameter Units: seconds

DtRwBoolean DtAggregateMoveAlongDescriptor::myGenerateRoutesWithRoundedCorners [protected]

Parameter Name: generate-routes-with-rounded-corners
Parameter Description: Choice as to whether or not to generate offset routes with 'rounded' corners.

A value of true will result in the move-along-controller generating routes that sweep out an arc for entities on the outside of a turn along the route. A value of false will result in the move-along-controller generating routes that 'cut corners' on the ourside of turns.
Parameter Default Value: true

DtRwReal DtAggregateMoveAlongDescriptor::myVertexSpacingAlongRoundedCorners [protected]

Parameter Name: vertex-spacing-along-rounded-corners
Parameter Description: Spacing between vertices in meters on the rounded corners of generated routes, if generateRoutesWithRoundedCorners() is true.

Closer spacing results in a better approximation of an arc.
Parameter Default Value: 20.0
Parameter Units: meters

DtRwBoolean DtAggregateMoveAlongDescriptor::myGroundClamp [protected]

Parameter Name: ground-clamp
Parameter Description: Ground-clamp generated route vertices.

Ground-vehicles and human aggregates should set this value to true. Fixed-wing and rotary-wing entities should set this value to false.
Parameter Default Value: True

---

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

• include/vrfobjparam/aggregateMoveAlongDesc.h