DtRailPathControllerDescriptor Class Reference

DtRailPathControllerDescriptor; descriptor for the DDtRailPathController component. More...

Inheritance diagram for DtRailPathControllerDescriptor:

List of all members.

Public Member Functions
	DtRailPathControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtRailPathControllerDescriptor (const DtRailPathControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtRailPathControllerDescriptor &	operator= (const DtRailPathControllerDescriptor &orig)
	assignment
virtual	~DtRailPathControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	usePredefinedSearchArea () const
	Accessor/mutator for myUsePredefinedSearchArea.
virtual void	setUsePredefinedSearchArea (bool usePred)
	Accessor/mutator for myUsePredefinedSearchArea.
virtual double	searchAreaRadius () const
	Accessor/mutator for #mySearchAreaRadius.
virtual void	setSearchAreaRadius (double radius)
	Accessor/mutator for #mySearchAreaRadius.
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	mySearchAreaExtraLength
	Parameter Name: search-area-extra-length Parameter Description: Length added to search area beyond distance from start to end.
DtRwBoolean	myUsePredefinedSearchArea
	Parameter Name: use-predefined-search-area Parameter Description: Used to determine if the user would like to use a predefined search area radius around the entity.
DtRwReal	myPredefinedSearchAreaRadius
	Parameter Name: search-area-radius Parameter Description: search area radius.
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
	DtRailPathControllerDescriptor ()
	default constructor -- not implemented.

---

Detailed Description

DtRailPathControllerDescriptor; descriptor for the DDtRailPathController component.

Parameters for the DtPathMovementController.

See also:

DtPathPlanner DtPathMovementController.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtRailPathControllerDescriptor::~DtRailPathControllerDescriptor

(

)

[virtual]

destructor

DtRailPathControllerDescriptor::DtRailPathControllerDescriptor

(

)

[private]

default constructor -- not implemented.

---

Member Function Documentation

DtRailPathControllerDescriptor& DtRailPathControllerDescriptor::operator=

(

const DtRailPathControllerDescriptor &

orig

)

assignment

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

DtRailPathControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtConvoyDescriptor.

virtual bool DtRailPathControllerDescriptor::usePredefinedSearchArea

(

)

const [virtual]

Accessor/mutator for myUsePredefinedSearchArea.

virtual void DtRailPathControllerDescriptor::setUsePredefinedSearchArea

(

bool

usePred

)

[virtual]

Accessor/mutator for myUsePredefinedSearchArea.

virtual double DtRailPathControllerDescriptor::searchAreaRadius

(

)

const [virtual]

Accessor/mutator for #mySearchAreaRadius.

virtual void DtRailPathControllerDescriptor::setSearchAreaRadius

(

double

radius

)

[virtual]

Accessor/mutator for #mySearchAreaRadius.

virtual double DtRailPathControllerDescriptor::searchAreaExtraLength

(

)

const [virtual]

Accessor/mutator for mySearchAreaExtraLength.

virtual void DtRailPathControllerDescriptor::setSearchAreaExtraLength

(

double

length

)

[virtual]

Accessor/mutator for mySearchAreaExtraLength.

virtual DtRwVectorObstructionTypeList& DtRailPathControllerDescriptor::preferredRouteTypes

(

)

[virtual]

Accessor for myPreferredRouteTypes.

virtual const DtRwVectorObstructionTypeList& DtRailPathControllerDescriptor::preferredRouteTypes

(

)

const [virtual]

Accessor for myPreferredRouteTypes.

virtual double DtRailPathControllerDescriptor::preferredRouteBonus

(

)

const [virtual]

Accessor/mutator for myPreferredRouteBonus.

virtual void DtRailPathControllerDescriptor::setPreferredRouteBonus

(

double

bonus

)

[virtual]

Accessor/mutator for myPreferredRouteBonus.

virtual DtRwVectorObstructionTypeList& DtRailPathControllerDescriptor::impassableVectorTypes

(

)

[virtual]

Accessor for myImpassableVectorTypes.

virtual const DtRwVectorObstructionTypeList& DtRailPathControllerDescriptor::impassableVectorTypes

(

)

const [virtual]

Accessor for myImpassableVectorTypes.

virtual DtString DtRailPathControllerDescriptor::metricType

(

)

const [virtual]

Accessor/mutator for myMetricType.

virtual void DtRailPathControllerDescriptor::setMetricType

(

const DtString &

metricType

)

[virtual]

Accessor/mutator for myMetricType.

virtual bool DtRailPathControllerDescriptor::publishPaths

(

)

const [virtual]

Accessor/mutator for myPublishPaths.

virtual void DtRailPathControllerDescriptor::setPublishPaths

(

bool

value

)

[virtual]

Accessor/mutator for myPublishPaths.

virtual bool DtRailPathControllerDescriptor::registerVrfSpecificTasks

(

)

const [virtual]

See also:

myRegisterVrfSpecificTasks

virtual void DtRailPathControllerDescriptor::setRegisterVrfSpecificTasks

(

bool

value

)

[virtual]

See also:

myRegisterVrfSpecificTasks

virtual DtComponentDescriptor* DtRailPathControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtConvoyDescriptor.

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

---

Member Data Documentation

DtRwReal DtRailPathControllerDescriptor::mySearchAreaExtraLength [protected]

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

Parameter Default Value: 500.0

DtRwBoolean DtRailPathControllerDescriptor::myUsePredefinedSearchArea [protected]

Parameter Name: use-predefined-search-area Parameter Description: Used to determine if the user would like to use a predefined search area radius around the entity.

Can be useful if performance is an issue. Otherwise the path controller will define the search area radius as the distance from the entity to the destination plus the extra length specified above. Parameter Default Value: false;

DtRwReal DtRailPathControllerDescriptor::myPredefinedSearchAreaRadius [protected]

Parameter Name: search-area-radius
Parameter Description: search area radius.

The search area for the rail path planning component is defined as a radius around the entity in which to search
Parameter Default Value: 10000.0

DtRwVectorObstructionTypeList DtRailPathControllerDescriptor::myPreferredRouteTypes [protected]

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

Parameter Default Value:

DtRwReal DtRailPathControllerDescriptor::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 DtRailPathControllerDescriptor::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 DtRailPathControllerDescriptor::myMetricType [protected]

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

Parameter Default Value:

DtRwBoolean DtRailPathControllerDescriptor::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 DtRailPathControllerDescriptor::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/railPathControllerDescriptor.h