Back to Top

Vehicle Routing Problem Solver properties

In this topic

  1. Summary
  2. Properties

Summary

The following properties are supported by the network analyst solver object when working with the vehicle routing problem solver. Note that the distance cost attribute can be obtained from the accumulators property on the Describe object.

Properties

PropertyExplanationData Type
defaultDate
(Read Only)

The implied date for time field values that don't have a date specified with the time.

String
distanceFieldUnits
(Read Only)

The distance units used by distance fields of the network analysis layer's sublayers and tables (network analysis classes).

  • Miles —Miles
  • Kilometers —Kilometers
  • Feet —Feet
  • Yards —Yards
  • Meters —Meters
  • Inches —Inches
  • Centimeters —Centimeters
  • Millimeters —Millimeters
  • Decimeters —Decimeters
  • NauticalMiles —Nautical miles
String
excessTransitTimePenaltyFactor
(Read Only)

Indicates how the solver rates the importance of reducing excess transit time.

  • Low —Low
  • Medium —Medium
  • High —High
  • Custom —Custom

This property is only relevant if using Order Pairs.

String
excessTransitTimePenaltyFactorValue
(Read Only)

The value used as the penalty factor for excess transit time in the objective function.

Double
timeFieldUnits
(Read Only)

The time units used by the temporal fields of the network analysis layer's sublayers and tables (network analysis classes).

  • Minutes —Minutes
  • Seconds —Seconds
  • Hours —Hours
  • Days —Days
String
timeWindowViolationPenaltyFactor
(Read Only)

Indicates how the solver rates the importance of honoring time windows without causing violations.

  • Low —Low
  • Medium —Medium
  • High —High
  • Custom —Custom
String
timeWindowViolationPenaltyFactorValue
(Read Only)

The value used as the penalty factor for time window violation in the objective function.

Double
timeZoneUsageForTimeFields
(Read Only)

Indicates whether datetime fields in the input data, such as time window fields, should be interpreted as the local time of the order or as coordinated universal time (UTC).

  • GEO LOCAL —Geo local
  • UTC —UTC
String
vrpRoutesShape
(Read Only)

The shape type for the route features that are output by the solver.

  • TRUE_LINES_WITHOUT_MEASURES —True lines without measures
  • TRUE_LINES_WITH_MEASURES —True lines with measures
  • NO_LINES —No lines
  • STRAIGHT_LINES —Straight lines
String
spatialClustering
(Read Only)

Specifies whether to use spatial clustering.

  • CLUSTER —The orders assigned to an individual route will be spatially clustered. Clustering orders tends to keep routes in smaller areas and reduce how often route lines intersect one another; yet, clustering can increase overall travel times. This is the default.
  • NO_CLUSTER —The solver will not prioritize spatially clustering orders, and the route lines might intersect. Use this option if route zones are specified.
Boolean

Feedback on this topic?

In this topic
  1. Summary
  2. Properties