Describes the output data types containing the results from a vehicle routing problem analysis when using the VehicleRoutingProblemSchemaVersion.One schema version.
UnassignedStops
This provides access to the orders that couldn't be visited by any routes. You can also determine why the orders couldn't be visited and make the necessary changes to correct the problem.
Note:
When the returnStopShapes property of the analysis object is set to True, this data type is a feature class. Otherwise, it is a table.
The data type supports the following fields:
Field | Description | Data type |
---|---|---|
StopType | Indicates whether the stop represents a depot, an order, or a break. The field value is an integer that can be interpreted in the following ways:
| Integer |
Name | The name of the stop. The value of this field is the same as the Name field from input orders, depots, or breaks. You can use the StopType field to determine if the Name field value refers to a depot, an order, or a break. | Text |
ViolatedConstraints | This field contains a summary of violated constraints and is set after a solve operation. If a constraint is violated, a combination of one or more of the violations listed below could be assigned to the field. Dive-in:The coded value that represents the text description is shown in the list below in parentheses. Notice that the coded values are part of a geometric sequence that increases by doubling the last value. This allows various combinations of violations to be coded. For instance, the combination of Capacities exceeded (2) and Hard route zone (128) is coded as 130 (2 +128).
| Integer |
| Shows a single violated constraint per field. The descriptions of the violations can be seen in ViolationConstraints.
| Integer |
Status | Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are the following:
| Integer |
Stops
This provides information about stops made at depots, orders, and breaks. The information includes which routes make the stops, the arrival and departure times, and the stop sequence.
Note:
When the returnStopShapes property of the analysis object is set to True, this data type is a feature class. Otherwise, it is a table.
The data type supports the following fields:
Field | Description | Data type |
---|---|---|
Name | The name of the stop. The value of this field is the same as the Name field from the input orders, depots, or breaks. You can use the StopType field to determine if the Name field value refers to a depot, an order, or a break. | Text |
StopType | Indicates whether the stop represents a depot, an order, or a break. The field value is an integer that can be interpreted in the following ways:
| Integer |
PickupQuantities | The amount of cargo or number of people to be picked up from a stop. If multiple dimensions are delivered to a stop, each quantity is separated by a space. The units for the value of this field aren't stored. You should interpret the units according to the way you specified the Capacities field on the input routes and the PickupQuantities and DeliveryQuantities fields on the input orders. | Text |
DeliveryQuantities | The amount of cargo or number of people to be delivered to a stop. If multiple dimensions are delivered to a stop, each quantity is separated by a space. The units for the value of this field aren't stored. You should interpret the units according to the way you specified the Capacities field on the input routes and the PickupQuantities and DeliveryQuantities fields on the input orders. | Text |
RouteName | The name of the route to which the stop is assigned. | Text |
Sequence | The relative sequence in which the assigned route visits the stop. | Long |
FromPrevTravelTime | The elapsed travel time from the route's previous stop to the current stop. The value is in the units specified by the timeUnits property of the analysis object. | Double |
FromPrevDistance | The distance along the route from the previous stop to the current stop. The value is in the units specified by the distanceUnits property of the analysis object. | Double |
ArriveCurbApproach | Indicates the side of the vehicle the curb is on when arriving at the stop. A value of 1 means the right side of the vehicle; a value of 2 means the left side. | Long |
DepartCurbApproach | Indicates the side of the vehicle the curb is on when departing from the stop. A value of 1 means the right side of the vehicle; a value of 2 means the left side. | Long |
ArriveTime | The time of day the route arrives at the stop. The time of day value for this field is in the time zone in which the stop is located. | Date |
DepartTime | The time of day the route departs from the stop. The time of day value for this field is in the time zone in which the stop is located. | Date |
ArriveTimeUTC | The time of day the route arrives at the stop. This value is in coordinated universal time (UTC). | Date |
DepartTimeUTC | The time of day the route departs from the stop. This value is in coordinated universal time (UTC). | Date |
WaitTime | The wait time or layover at the stop. For example, a wait time is incurred when a route must wait at an order for a time window to open. The value is in the units specified by the timeUnits property of the analysis object. | Double |
ViolationTime | The amount of time elapsed from the end of the stop's time window to the arrival of the route vehicle. The value is in the units specified by the timeUnits property of the analysis object. | Double |
ORIG_FID | The ObjectID of the input order, depot, or break. This field can be used to join attributes from input features. | Long |
Routes
This provides access to the drivers, vehicles, and route paths of a vehicle routing problem analysis.
The data type supports the following fields:
Field | Description | Data type |
---|---|---|
Name | The name of the route. The values for this field are copied from the Name field on the input routes. | Text |
ViolatedConstraints | This field contains a summary of violated constraints and is set after a solve operation. If a constraint is violated, a combination of one or more of the violations listed below could be assigned to the field. Dive-in:The coded value that represents the text description is shown in the list below in parentheses. Notice that the coded values are part of a geometric sequence that increases by doubling the last value. This allows various combinations of violations to be coded. For instance, the combination of Capacities exceeded (2) and Hard route zone (128) is coded as 130 (2 +128).
| Integer |
| Shows a single violated constraint per field. The descriptions of the violations can be seen in ViolationConstraints.
| Integer |
OrderCount | The number of orders assigned to the route. | Long |
TotalCost | The total operating cost of the route, which is the sum of the following field values: FixedCost, RegularTimeCost, OvertimeCost, and DistanceCost. | Double |
RegularTimeCost | The cost of regular work time, excluding any unpaid breaks. | Double |
OvertimeCost | The cost of overtime work, excluding any unpaid breaks. | Double |
DistanceCost | The distance cost component obtained by multiplying the TotalDistance and CostPerUnitDistance field values. | Double |
TotalTime | The total route duration. This includes travel times as well as service and wait times at orders, depots, and breaks. The TotalTime value is the sum of the following attribute fields:
The value is in the units specified by the timeUnits property of the analysis object. | Double |
TotalOrderServiceTime | The total service time spent at all orders on the route. The value is in the units specified by the timeUnits property of the analysis object. | Double |
TotalBreakServiceTime | The total service time spent at all breaks on the route. The value is in the units specified by the timeUnits property of the analysis object. | Double |
TotalTravelTime | The total travel time for the route. The value is in the units specified by the timeUnits property of the analysis object. | Double |
TotalDistance | The total travel distance for the route. The value is in the units specified by the distanceUnits property of the analysis object. | Double |
StartTime | The starting time of the route. The route may start before the beginning of its start depot's time window, in which case there is a wait time at the starting depot. The time of day value for this attribute is in the time zone in which the starting depot is located. | Date |
EndTime | The ending time of the route. The route ends upon completion of service at the ending depot. The time of day value for this attribute is in the time zone in which the ending depot is located. | Date |
StartTimeUTC | The start time of the route in coordinated universal time (UTC). | Date |
EndTimeUTC | The end time of the route in coordinated universal time (UTC). | Date |
TotalWaitTime | The total wait time at all orders, depots, and breaks on the route. The value is in the units specified by the timeUnits property of the analysis object. | Double |
TotalViolationTime | The total violation time at all orders and breaks on the route. The value is in the units specified by the timeUnits property of the analysis object. | Double |
RenewalCount | For a route with renewals, this is equal to the number of visits to depots for the purpose of renewing a vehicle, that is, loading or unloading a vehicle. | Integer |
TotalRenewalServiceTime | For a route with renewals, this is the total service time spent at all renewal visits on the route. The value is in the units specified by the timeUnits property of the analysis object. | Double |
Directions
This provides access to the turn-by-turn directions for each resulting route.
The data type supports the following fields:
Field | Description | Data type |
---|---|---|
RouteName | The name of the route to which the driving action applies. This value is the same as the Name field of the output routes. | String |
ArriveTime | The time of day to initiate the given driving action. If the route spans multiple days, the date and time of day are displayed. | Date |
Type | The type of maneuver that the directions feature represents or the type of the directions text. To determine whether Type refers to a maneuver type or a directions string type, check the value of the SubItemType field. Type can be used, for example, to assign an icon for direction text based on the maneuver type, or it can use a formatting style based on the directions string type when displaying the driving directions in your application. The Type value is an integer from the Maneuver Types or Directions String Types lists below. Maneuver Types
Directions String Types
| Short |
SubItemType | Specifies whether the Type field refers to an integer from the Directions String Types table or the Maneuver Types table.
| Short |
Text | A text description of the travel directions. | String |
ElaspsedTime | The time elapsed in minutes from when the current driving direction starts until the next one starts, or until the route ends for the last driving direction. | Double |
DriveDistance | The distance from where the current driving direction occurs to where the next one occurs, or to where the route ends for the last driving direction. The value is in the units specified by the directionsDistanceUnits property of the analysis object. This value is zero for driving directions that occur at the same location where the next one begins. For example, the DriveDistance is 0 for the directions text at the start of the route. | Double |