RouteOptions Class Reference

Inherits ICloneable.

Public Member Functions
object	Clone ()
	Returns a copy of the current object. More...

Properties
int[]	AFSetIDs[get, set]
	The list Avoid/Favor Set IDs to inject into the route. More...
string[]	AFSetNames[get, set]
	The list Avoid/Favor Set Names to inject into the route. More...
bool?	BordersOpen[get, set]
	Gets or sets a value indicating whether borders are open for travel. The default is true. More...
ClassOverrideType	ClassOverrides[get, set]
	Gets or sets the enumeration of class overrides. This is an optional field and the default is None. More...
List< RoadSpeedBase >	CustomRoadSpeeds[get, set]
	A list of custom road speeds to be applied for the route. More...
DistanceUnits	DistanceUnits[get, set]
	Gets or sets the distance units to miles (default) or kilometers. More...
uint?	ElevLimit[get, set]
	Gets or sets elevation limit when generating a route. The default is null. More...
bool	FerryDiscourage[get, set]
	Indicates whether or not to avoid ferries while routing. More...
double?	FuelConsumption[get, set]
	Indicates the fuel consumption of the vehicle More...
bool	FuelRoute[get, set]
	Gets or sets a value indicating whether or not a fuel optimized route is desired. More...
FuelType?	FuelType[get, set]
	Indicates the fuel type of the vehicle More...
int?	GovernorSpeedLimit[get, set]
	Maximum average road speed to use in route calculations that overrides all other road speeds when they are above this value. Default is disabled and valid value is between 1 and 100 mph. More...
HazMatType	HazMatType[get, set]
	Gets or sets the hazardous material type. The default is none. More...
bool?	HighwayOnly[get, set]
	Gets or sets a value indicating whether to use highways only. More...
HoursOfServiceOptions	HoSOptions[get, set]
	Gets or sets the Hours of Service options for the route More...
bool	HubRouting[get, set]
	Gets or sets a value indicating whether or not to enable hub routing. The default is false to disable hub routing. More...
bool?	MaintainHeading[get, set]
	When this option is set, a vehicle will attempt to avoid u-turns at intermediate stops and instead leave the stop in the same direction it entered it. More...
bool	OverrideRestrict[get, set]
	Gets or sets a value indicating whether or not to override truck restrictions. The default is false to keep the restrictions. More...
bool?	Refrigerated[get, set]
	Indicates whether the vehicle is a refrigerated truck More...
RouteOptimizeType	RouteOptimization[get, set]
	Gets or sets the method by which to optimize the route stops. Default is None. More...
RoutingType	RoutingType[get, set]
	Gets or sets the type of routing desired. More...
SideOfStreetAdherenceLevel	SideOfStreetAdherence[get, set]
	How strict to be in order to avoid the destination being on the opposite side of the street. More...
bool	TollDiscourage[get, set]
	Gets or sets a value indicating whether or not tolls should be discouraged on the route. The default is false. More...
TrailerConfig	TrailerCfg[get, set]
	Gets or sets the trailer configuration which is used for toll reports. More...
TruckConfig	TruckCfg[get, set]
	Gets or sets the truck configuration. More...
TunnelCategory	TunnelCategory[get, set]
	Gets or sets the hazardous material type. The default is none. More...
bool	UseAvoidsAndFavors[get, set]
	Gets or sets a value indicating whether or not to use avoids and favors. More...
bool	UseSites[get, set]
	Indicates whether or not to use sites during routing. More...
TruckStyle?	VehicleProfile[get, set]
	Provides the ability to load a vehicle profile which includes vehicle dimensions, route costs and routing options for a specific vehicle class. More...
VehicleType	VehicleType[get, set]
	Gets or sets the type of the vehicle. More...
uint?	TrafficLookaheadDistance[get, set]
	Distance in miles for which we will gather traffic for the route. More...
string[]	AvoidCountry[get, set]
	Indicates which countries to avoid More...
string[]	AvoidState[get, set]
	Indicates which states to avoid More...
string[]	FavorCountry[get, set]
	Indicates which countries to favor More...
string[]	FavorState[get, set]
	Indicates with states to favor More...
bool?	IncludeTrimblePlaceIDs[get, set]
	Indicates use Trimble placeIds from while the processing route More...
TollRoadsType?	TollRoads[get, set]
	Toll type: Always Avoid, Use, Avoid if Possible More...
HazMatType[]	HazMatTypes[get, set]
	Gets or sets the hazardous material types. More...
TunnelCategory[]	TunnelCategories[get, set]
	Gets or sets the tunnel category types. More...

Detailed Description

Represents options specific to the kind of route to be run.

Member Function Documentation

Clone()

object Clone

(

)

Returns a copy of the current object.

Returns

The cloned options.

Property Documentation

AFSetIDs

int [] AFSetIDs

getset

The list Avoid/Favor Set IDs to inject into the route.

AFSetNames

string [] AFSetNames

getset

The list Avoid/Favor Set Names to inject into the route.

BordersOpen

bool? BordersOpen

getset

Gets or sets a value indicating whether borders are open for travel. The default is true.

ClassOverrides

ClassOverrideType ClassOverrides

getset

Gets or sets the enumeration of class overrides. This is an optional field and the default is None.

Note that this enumerations supports flags, meaning that multiple values (excluding None) can be set at once.

CustomRoadSpeeds

List<RoadSpeedBase> CustomRoadSpeeds

getset

A list of custom road speeds to be applied for the route.

DistanceUnits

DistanceUnits DistanceUnits

getset

Gets or sets the distance units to miles (default) or kilometers.

The distance units primarily affect report option, but when drawing a map, the scale bar legend will use these distance units.

ElevLimit

uint? ElevLimit

getset

Gets or sets elevation limit when generating a route. The default is null.

Elevation units can be either meters or feet determined by DistanceUnits. Miles = feet, Kilometers = meters Available to NA data 29 and after. Limit will be ignored if:

1. Routing is deemed impractical with the limit.
2. A stop is located at an elevation higher than the limit.

FerryDiscourage

bool FerryDiscourage

getset

Indicates whether or not to avoid ferries while routing.

FuelConsumption

double? FuelConsumption

getset

Indicates the fuel consumption of the vehicle

FuelRoute

bool FuelRoute

getset

Gets or sets a value indicating whether or not a fuel optimized route is desired.

When a fuel route is desired, be sure to set fuel login information in the FuelOptions class.

FuelType

FuelType? FuelType

getset

Indicates the fuel type of the vehicle

GovernorSpeedLimit

int? GovernorSpeedLimit

getset

Maximum average road speed to use in route calculations that overrides all other road speeds when they are above this value. Default is disabled and valid value is between 1 and 100 mph.

HazMatType

HazMatType HazMatType

getset

Gets or sets the hazardous material type. The default is none.

HighwayOnly

bool? HighwayOnly

getset

Gets or sets a value indicating whether to use highways only.

HoSOptions

HoursOfServiceOptions HoSOptions

getset

Gets or sets the Hours of Service options for the route

HubRouting

bool HubRouting

getset

Gets or sets a value indicating whether or not to enable hub routing. The default is false to disable hub routing.

MaintainHeading

bool? MaintainHeading

getset

When this option is set, a vehicle will attempt to avoid u-turns at intermediate stops and instead leave the stop in the same direction it entered it.

When using the school bus vehicle profiles, this option will be automatically set to true if not supplied.

OverrideRestrict

bool OverrideRestrict

getset

Gets or sets a value indicating whether or not to override truck restrictions. The default is false to keep the restrictions.

Refrigerated

bool? Refrigerated

getset

Indicates whether the vehicle is a refrigerated truck

RouteOptimization

RouteOptimizeType RouteOptimization

getset

Gets or sets the method by which to optimize the route stops. Default is None.

See RouteOptimizeType and use ThruAll to re-sequence all of the input stops in the most optimal sequence; use fixed to re-sequence the input stops while keeping the destination fixed.

RoutingType

RoutingType RoutingType

getset

Gets or sets the type of routing desired.

SideOfStreetAdherence

SideOfStreetAdherenceLevel SideOfStreetAdherence

getset

How strict to be in order to avoid the destination being on the opposite side of the street.

TollDiscourage

bool TollDiscourage

getset

Gets or sets a value indicating whether or not tolls should be discouraged on the route. The default is false.

TrailerCfg

TrailerConfig TrailerCfg

getset

Gets or sets the trailer configuration which is used for toll reports.

TruckCfg

TruckConfig TruckCfg

getset

Gets or sets the truck configuration.

TunnelCategory

TunnelCategory TunnelCategory

getset

Gets or sets the hazardous material type. The default is none.

UseAvoidsAndFavors

bool UseAvoidsAndFavors

getset

Gets or sets a value indicating whether or not to use avoids and favors.

UseSites

bool UseSites

getset

Indicates whether or not to use sites during routing.

VehicleProfile

TruckStyle? VehicleProfile

getset

Provides the ability to load a vehicle profile which includes vehicle dimensions, route costs and routing options for a specific vehicle class.

This option replaces the RouteOptions.VehicleType as well as SharedOptions.TruckStyle RouteCosts.TruckStyle and should be used instead

VehicleType

VehicleType VehicleType

getset

Gets or sets the type of the vehicle.

Starting in v32, this is deprecated and we recommend using the VehicleProfile instead.

TrafficLookaheadDistance

uint? TrafficLookaheadDistance

getset

Distance in miles for which we will gather traffic for the route.

AvoidCountry

string [] AvoidCountry

getset

Indicates which countries to avoid

AvoidState

string [] AvoidState

getset

Indicates which states to avoid

FavorCountry

string [] FavorCountry

getset

Indicates which countries to favor

FavorState

string [] FavorState

getset

Indicates with states to favor

IncludeTrimblePlaceIDs

bool? IncludeTrimblePlaceIDs

getset

Indicates use Trimble placeIds from while the processing route

TollRoads

TollRoadsType? TollRoads

getset

Toll type: Always Avoid, Use, Avoid if Possible

HazMatTypes

HazMatType [] HazMatTypes

getset

Gets or sets the hazardous material types.

TunnelCategories

TunnelCategory [] TunnelCategories

getset

Gets or sets the tunnel category types.