DtPathMovementControllerDescriptor Class Reference

DtPathMovementControllerDescriptor; descriptor for the DtPathMovementController component. More...

Inheritance diagram for DtPathMovementControllerDescriptor:

List of all members.

Public Member Functions
	DtPathMovementControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtPathMovementControllerDescriptor (const DtPathMovementControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtPathMovementControllerDescriptor &	operator= (const DtPathMovementControllerDescriptor &orig)
	assignment
virtual	~DtPathMovementControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual double	searchNodeSpacing () const
	Accessor/mutator for mySearchNodeSpacing.
virtual void	setSearchNodeSpacing (double space)
	Accessor/mutator for mySearchNodeSpacing.
virtual double	vectorSearchNodeSpacing () const
	Accessor/mutator for myVectorSearchNodeSpacing.
virtual void	setVectorSearchNodeSpacing (double space)
	Accessor/mutator for myVectorSearchNodeSpacing.
virtual double	searchAreaWidth () const
	Accessor/mutator for mySearchAreaWidth.
virtual void	setSearchAreaWidth (double width)
	Accessor/mutator for mySearchAreaWidth.
virtual double	searchAreaExtraLength () const
	Accessor/mutator for mySearchAreaExtraLength.
virtual void	setSearchAreaExtraLength (double length)
	Accessor/mutator for mySearchAreaExtraLength.
virtual DtRwVectorObstructionTypeList &	preferredRouteTypes ()
	Accessor for myPreferredRouteTypes.
virtual const DtRwVectorObstructionTypeList &	preferredRouteTypes () const
	Accessor for myPreferredRouteTypes.
virtual double	preferredRouteBonus () const
	Accessor/mutator for myPreferredRouteBonus.
virtual void	setPreferredRouteBonus (double bonus)
	Accessor/mutator for myPreferredRouteBonus.
virtual DtRwVectorObstructionTypeList &	impassableVectorTypes ()
	Accessor for myImpassableVectorTypes.
virtual const DtRwVectorObstructionTypeList &	impassableVectorTypes () const
	Accessor for myImpassableVectorTypes.
virtual DtString	metricType () const
	Accessor/mutator for myMetricType.
virtual void	setMetricType (const DtString &metricType)
	Accessor/mutator for myMetricType.
virtual bool	publishPaths () const
	Accessor/mutator for myPublishPaths.
virtual void	setPublishPaths (bool value)
	Accessor/mutator for myPublishPaths.
virtual bool	registerVrfSpecificTasks () const
virtual void	setRegisterVrfSpecificTasks (bool value)
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	mySearchNodeSpacing
	Parameter Name: search-node-spacing Parameter Description: Distance in meters between each search node in the path seach grid.
DtRwReal	myVectorSearchNodeSpacing
	Parameter Name: vector-search-node-spacing Parameter Description: Distance in meters between each search node when searching along vector features (i.e.
DtRwReal	mySearchAreaWidth
	Parameter Name: search-area-width Parameter Description: Width of search area.
DtRwReal	mySearchAreaExtraLength
	Parameter Name: search-area-extra-length Parameter Description: Length added to search area beyond distance from start to end.
DtRwVectorObstructionTypeList	myPreferredRouteTypes
	Parameter Name: preferred-route-types Parameter Description: List of vector types that will be treated as preferred routes.
DtRwReal	myPreferredRouteBonus
	Parameter Name: preferred-route-bonus Parameter Description: A percentage bonus that is applied to the use of the preferred routes.
DtRwVectorObstructionTypeList	myImpassableVectorTypes
	Parameter Name: impassable-vector-types Parameter Description: List of vector types that will not be crossed by any planned route.
DtRwString	myMetricType
	Parameter Name: path-metric-type Parameter Description: String type of the path metric to be used.
DtRwBoolean	myPublishPaths
	Parameter Name: publish-paths Parameter Description: Indicated whether paths found by the path planner should be published on the network.
DtRwBoolean	myRegisterVrfSpecificTasks
	Parameter Name: register-vrf-specific-tasks Parameter Description: This parameter controls what types of tasks this controller registers for.
Private Member Functions
	DtPathMovementControllerDescriptor ()
	default constructor -- not implemented.

---

Detailed Description

DtPathMovementControllerDescriptor; descriptor for the DtPathMovementController component.

Parameters for the DtPathMovementController.

See also:

DtPathPlanner DtPathMovementController.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtPathMovementControllerDescriptor::~DtPathMovementControllerDescriptor

(

)

[virtual]

destructor

DtPathMovementControllerDescriptor::DtPathMovementControllerDescriptor

(

)

[private]

default constructor -- not implemented.

---

Member Function Documentation

DtPathMovementControllerDescriptor& DtPathMovementControllerDescriptor::operator=

(

const DtPathMovementControllerDescriptor &

orig

)

assignment

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

DtPathMovementControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual double DtPathMovementControllerDescriptor::searchNodeSpacing

(

)

const [virtual]

Accessor/mutator for mySearchNodeSpacing.

virtual void DtPathMovementControllerDescriptor::setSearchNodeSpacing

(

double

space

)

[virtual]

Accessor/mutator for mySearchNodeSpacing.

virtual double DtPathMovementControllerDescriptor::vectorSearchNodeSpacing

(

)

const [virtual]

Accessor/mutator for myVectorSearchNodeSpacing.

virtual void DtPathMovementControllerDescriptor::setVectorSearchNodeSpacing

(

double

space

)

[virtual]

Accessor/mutator for myVectorSearchNodeSpacing.

virtual double DtPathMovementControllerDescriptor::searchAreaWidth

(

)

const [virtual]

Accessor/mutator for mySearchAreaWidth.

virtual void DtPathMovementControllerDescriptor::setSearchAreaWidth

(

double

width

)

[virtual]

Accessor/mutator for mySearchAreaWidth.

virtual double DtPathMovementControllerDescriptor::searchAreaExtraLength

(

)

const [virtual]

Accessor/mutator for mySearchAreaExtraLength.

virtual void DtPathMovementControllerDescriptor::setSearchAreaExtraLength

(

double

length

)

[virtual]

Accessor/mutator for mySearchAreaExtraLength.

virtual DtRwVectorObstructionTypeList& DtPathMovementControllerDescriptor::preferredRouteTypes

(

)

[virtual]

Accessor for myPreferredRouteTypes.

virtual const DtRwVectorObstructionTypeList& DtPathMovementControllerDescriptor::preferredRouteTypes

(

)

const [virtual]

Accessor for myPreferredRouteTypes.

virtual double DtPathMovementControllerDescriptor::preferredRouteBonus

(

)

const [virtual]

Accessor/mutator for myPreferredRouteBonus.

virtual void DtPathMovementControllerDescriptor::setPreferredRouteBonus

(

double

bonus

)

[virtual]

Accessor/mutator for myPreferredRouteBonus.

virtual DtRwVectorObstructionTypeList& DtPathMovementControllerDescriptor::impassableVectorTypes

(

)

[virtual]

Accessor for myImpassableVectorTypes.

virtual const DtRwVectorObstructionTypeList& DtPathMovementControllerDescriptor::impassableVectorTypes

(

)

const [virtual]

Accessor for myImpassableVectorTypes.

virtual DtString DtPathMovementControllerDescriptor::metricType

(

)

const [virtual]

Accessor/mutator for myMetricType.

virtual void DtPathMovementControllerDescriptor::setMetricType

(

const DtString &

metricType

)

[virtual]

Accessor/mutator for myMetricType.

virtual bool DtPathMovementControllerDescriptor::publishPaths

(

)

const [virtual]

Accessor/mutator for myPublishPaths.

virtual void DtPathMovementControllerDescriptor::setPublishPaths

(

bool

value

)

[virtual]

Accessor/mutator for myPublishPaths.

virtual bool DtPathMovementControllerDescriptor::registerVrfSpecificTasks

(

)

const [virtual]

See also:

myRegisterVrfSpecificTasks

virtual void DtPathMovementControllerDescriptor::setRegisterVrfSpecificTasks

(

bool

value

)

[virtual]

See also:

myRegisterVrfSpecificTasks

virtual DtComponentDescriptor* DtPathMovementControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtPathMovementControllerDescriptor::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 DtPathMovementControllerDescriptor::mySearchNodeSpacing [protected]

Parameter Name: search-node-spacing
Parameter Description: Distance in meters between each search node in the path seach grid.

Parameter Default Value: 30.0
Parameter Units: meters

DtRwReal DtPathMovementControllerDescriptor::myVectorSearchNodeSpacing [protected]

Parameter Name: vector-search-node-spacing
Parameter Description: Distance in meters between each search node when searching along vector features (i.e.

roads).
Parameter Default Value: 10.0
Parameter Units: meters

DtRwReal DtPathMovementControllerDescriptor::mySearchAreaWidth [protected]

Parameter Name: search-area-width
Parameter Description: Width of search area.

The search area for the path planning component is defined as a rectangular area oriented along the line directly from the start point to the goal point with width as defined by search-area-width, and length as the distance between the start point and goal point plus search-area-extra-length.
Parameter Default Value: 1830.0

DtRwReal DtPathMovementControllerDescriptor::mySearchAreaExtraLength [protected]

Parameter Name: search-area-extra-length
Parameter Description: Length added to search area beyond distance from start to end.

Parameter Default Value: 630.0

DtRwVectorObstructionTypeList DtPathMovementControllerDescriptor::myPreferredRouteTypes [protected]

Parameter Name: preferred-route-types
Parameter Description: List of vector types that will be treated as preferred routes.

Parameter Default Value:

DtRwReal DtPathMovementControllerDescriptor::myPreferredRouteBonus [protected]

Parameter Name: preferred-route-bonus
Parameter Description: A percentage bonus that is applied to the use of the preferred routes.

(0 - 1.0)
Parameter Default Value: 0.0

DtRwVectorObstructionTypeList DtPathMovementControllerDescriptor::myImpassableVectorTypes [protected]

Parameter Name: impassable-vector-types
Parameter Description: List of vector types that will not be crossed by any planned route.

Parameter Default Value:

DtRwString DtPathMovementControllerDescriptor::myMetricType [protected]

Parameter Name: path-metric-type
Parameter Description: String type of the path metric to be used.

Parameter Default Value:

DtRwBoolean DtPathMovementControllerDescriptor::myPublishPaths [protected]

Parameter Name: publish-paths
Parameter Description: Indicated whether paths found by the path planner should be published on the network.

Parameter Default Value: True

DtRwBoolean DtPathMovementControllerDescriptor::myRegisterVrfSpecificTasks [protected]

Parameter Name: register-vrf-specific-tasks
Parameter Description: This parameter controls what types of tasks this controller registers for.

If True, this controller registers for the VRF specific path movement tasks that are issued by the Movement Chooser Controller. Otherwise, it registers for the base path movement tasks sent directly from the GUI. If a Movement Chooser Controller is being used, set this to True, otherwise False. Parameter Default Value: True

---

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

• include/vrfobjparam/pathMoveDesc.h