WasteCollection output data types

The output data types containing the results from a waste collection analysis are described below.

Stops

The output is a copy of the input Stops table with additional information about which route served each stop and the stop sequence along the route.

The output Stops table includes all fields from the input Stops table. Fields that are updated or added to the output are listed in the following table:

FieldDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

RouteName

The name of the route to which the stop is assigned.

This field corresponds to the Name field in the output Routes table.

Text

Sequence

The sequence of the stop on its assigned route.

Output sequence values for a route are shared across renewal visits and stops. The sequences start from 1 for the first stop on the route.

Long

RouteLineID

The ObjectID value of the output RouteLines feature that serves this stop. This associates the individual stop locations with the further details of the route plan, such as when the vehicle will be collecting on this street.

Long

  • ViolatedConstraint_1
  • ViolatedConstraint_2
  • ViolatedConstraint_3
  • ViolatedConstraint_4

These fields contain a summary of violated constraints and are set after a solve operation. Each field will contain one violation. If a stop has more than one violation, the next ViolatedConstraint_* field will be used.

  • Capacities exceeded (1)—The preassigned stops cannot be assigned to the route, because assigning the stops will exceed the total route capacity as specified by the route's TotalBin_*, TotalWeight_*, and TotalVolume_* field values.
  • MaxTotalTime exceeded (2)—The travel time from the start depot to the end depot plus the service and wait times at both depots exceeds the total time for the route as specified by the route's MaxTotalTime field value.
  • MaxTotalDistance exceeded (4)—The travel distance from the start depot to the end depot exceeds the total travel distance for the route as specified by the route's MaxTotalDistance field value.
  • Unreachable (10)—A preassigned stop is located on a network element that cannot be reached by the route.
  • Cannot insert required renewal (12)—A route exceeds its capacity and needs to visit a route renewal; however, the associated route renewal has a null sequence value in the presence of preassigned stops and cannot be inserted anywhere without introducing other violations.

Learn more about troubleshooting network analyses

Note:

The violated constraint field value of an unrouted stop may or may not describe all its violations. If the violation is severe enough to immediately exclude the stop from further consideration, the solver does so, which prevents any other violations from being discovered for that stop. If a violation is encountered that doesn't automatically stop a solution from being generated, the violation is noted in violated constraint fields, and the solver continues to consider the stop. Any further violations such as these are added to the violated constraint fields until either the solver finds a violation that prematurely stops the solve process for that particular stop, or the solver finds an overall solution to the problem.

Long

Status

Specifies 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:

  • 0 (OK)—The point was located on the network.
  • 1 (Not Located)—The point was not located on the network and was not included in the analysis.
  • 2 (Network element not located)—The network element identified by the point's network location fields can't be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3 (Element not traversable)—The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5 (Not Reached)—The point can't be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6 (Time window violation)—The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7 (Not located on closest)—The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead.

Long

Network location fields

  • SourceID
  • SourceOID
  • PosAlong
  • SideOfEdge
  • SnapX
  • SnapY
  • SnapZ
  • DistanceToNetworkInMeters

Together, these properties describe the point on the network where the object is located.

Learn more about locating inputs on a network

Depots

The output is a copy of the input Depots table with additional information about how the depots were located on the network.

The output Depots table includes all fields from the input Depots table. Only fields that are added to the output are listed in the following table:

FieldDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

Status

Specifies 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:

  • 0 (OK)—The point was located on the network.
  • 1 (Not Located)—The point was not located on the network and was not included in the analysis.
  • 2 (Network element not located)—The network element identified by the point's network location fields can't be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3 (Element not traversable)—The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5 (Not Reached)—The point can't be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6 (Time window violation)—The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7 (Not located on closest)—The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead.

Long

Network location fields

  • SourceID
  • SourceOID
  • PosAlong
  • SideOfEdge
  • SnapX
  • SnapY
  • SnapZ
  • DistanceToNetworkInMeters

Together, these properties describe the point on the network where the object is located.

Learn more about locating inputs on a network

Routes

These are the output routes. The routes describe the region each route will operate, the amount of waste collected, and the travel time and distance.

The output Routes table includes all fields from the input Routes table as well as additional fields describing how each route serviced the stops. Only fields that are added to the output are listed below.

Field nameDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

  • ViolatedConstraint_1
  • ViolatedConstraint_2
  • ViolatedConstraint_3
  • ViolatedConstraint_4

Describes constraints violated by the route. The constraints are given as integers as described in the list below.

  • Capacities exceeded (1)—The preassigned stops cannot be assigned to the route, because assigning the stops will exceed the total route capacity as specified by the route's Capacities field value.
  • MaxTotalTime exceeded (2)—The travel time from the start depot to the end depot plus the service and wait times at both depots exceeds the total time for the route as specified by the route's MaxTotalTime field value.
  • MaxTotalDistance exceeded (4)—The travel distance from the start depot to the end depot exceeds the total travel distance for the route as specified by the route's MaxTotalDistance field value.
  • Unreachable (10)—A preassigned stop is located on a network element that cannot be reached by the route.
  • Cannot insert required renewal (12)—A route exceeds its capacity and needs to visit a route renewal; however, the associated route renewal has a null sequence value in the presence of preassigned stops and cannot be inserted anywhere without introducing other violations.

Long

StopCount

The number of stops serviced by this route.

Long

RenewalCount

The number of renewal visits needed by this route.

Long

TotalBins_1

The total number of bins for fraction 1 serviced by this route.

Double

TotalWeight_1

The total physical weight of waste for fraction 1 collected by this route.

Double

TotalVolume_1

The total volume of waste for fraction 1 collected by this route.

Double

TotalBins_2

The total number of bins for fraction 2 serviced by this route.

Double

TotalWeight_2

The total physical weight of waste for fraction 2 collected by this route.

Double

TotalVolume_2

The total volume of waste for fraction 2 collected by this route.

Double

TotalTime

The total route duration. This includes travel time as well as service times at stops, renewals, and starting and ending depots.

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

TotalStopServiceTime

The total service time spent at all stops on 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

EndTime

The ending time of the route. The route ends upon completion of service at the ending depot. This end time reflects the travel times that were used during the optimization by the solver.

Time Only

RouteLines

The output route lines describing the paths taken through the network to visit the stops.

Field nameDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

RouteName

The name of the route with which this route segment is associated. The RouteName field is a foreign key to the Name field in the Routes class.

Text

CollectionSequence

The sequence of the route's collection segments.

Long

Activity

Indicates whether the driver collected bins while traversing the route segment. The constraints are given as integers as described in the list below.

  • Collect Both Sides (1)—The driver collects bins from both sides of the street while traversing the route segment.
  • Collect Left Side (2)—The driver collects bins from the left side of the street while traversing the route segment.
  • Collect Right Side (3)—The driver collects bins from the right side of the street while traversing the route segment.
  • Stem (4)—The driver traverses the route segment from the depot to the first stop, from a stop to the renewal, or from the renewal to a stop or a depot.
  • Traverse (5)—The driver traversed the route segment to get from one place to another without collecting bines.

Long

ArriveTime

The time the route starts traversing this route segment in the time zone of the route's starting depot.

Time Only

DepartTime

The time the route finishes traversing this route segment in the time zone of the route's starting depot.

For collection segments, the depart time includes the service time of stops visited on this route segment. For stem segments, the service time at the renewal or depot is not included, because that is accounted for at the renewal or depot location and not on the route segment.

Time Only

StopCount

The number of stops from which to collect waste on this route segment. This field is null if no waste is to be collected.

Long

Bins_1

The number of bins for fraction 1 to collect on this route segment. If the route traverses this route segment without collecting waste, this field will be null.

Double

Weight_1

The physical weight of waste for fraction 1 to collect on this route segment. If the route traverses this route segment without collecting waste, this field will be null.

Double

Volume_1

The volume of waste for fraction 1 to collect on this route segment. If the route traverses this route segment without collecting waste, this field will be null.

Double

Bins_2

The number of bins for fraction 2 to collect on this route segment. If the route traverses this route segment without collecting waste, this field will be null.

Double

Weight_2

The physical weight of waste for fraction 2 to collect on this route segment. If the route traverses this route segment without collecting waste, this field will be null.

Double

Volume_2

The volume of waste for fraction 2 to collect on this route segment. If the route traverses this route segment without collecting waste, this field will be null.

Double

ReportGrouping

This field is used to group route segments in output waste collection reports to allow for close-up maps for each group.

Long

Renewals

The output is a copy of the input Renewals table with additional information about how the renewals were located on the network.

The output Renewals table includes all fields from the input Renewals table. Only fields that are added to the output are listed in the following table:

FieldDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

Status

Specifies 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:

  • 0 (OK)—The point was located on the network.
  • 1 (Not Located)—The point was not located on the network and was not included in the analysis.
  • 2 (Network element not located)—The network element identified by the point's network location fields can't be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3 (Element not traversable)—The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5 (Not Reached)—The point can't be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6 (Time window violation)—The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7 (Not located on closest)—The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead.

Long

Network location fields

  • SourceID
  • SourceOID
  • PosAlong
  • SideOfEdge
  • SnapX
  • SnapY
  • SnapZ
  • DistanceToNetworkInMeters

Together, these properties describe the point on the network where the object is located.

Learn more about locating inputs on a network

RenewalVisits

This is each instance of a renewal being visited by a route, including the time of the visit and information about the amount of waste unloaded at the renewal. A maximum of three renewal visits per route is supported.

FieldDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

RouteName

The name of the route this renewal applies to.

The value of this field corresponds to a value in the Name field of a route in the Routes output class.

Text

RenewalName

The name of the renewal where the truck was unloaded.

The value of this field corresponds to a value in the Name field of a route in the Renewals output class.

Text

Sequence

The sequence of the visited renewal along the route.

Long

ArriveTime

The arrival time at the renewal.

Time Only

DepartTime

The departure time from the renewal.

Time Only

UnloadedBins_1

The number of bins collected for fraction 1 unloaded at the renewal.

Double

UnloadedWeight_1

The physical weight of waste for fraction 1 unloaded at the renewal.

Double

UnloadedVolume_1

The volume of waste for fraction 1 unloaded at the renewal.

Double

UnloadedBins_2

The number of bins collected for fraction 2 unloaded at the renewal.

Double

UnloadedWeight_2

The physical weight of waste for fraction 2 unloaded at the renewal.

Double

UnloadedVolume_2

The volume of waste for fraction 2 unloaded at the renewal.

Double

DirectionPoints

This is the output turn-by-turn directions for the routes calculated in the analysis, represented as point locations along the routes where specific direction events or maneuvers occur.

Field nameDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

RouteID

The ObjectID value of the output Routes feature with which this direction point is associated.

Long

Sequence

The sequence of the direction points for the route, starting with 1.

Long

DirectionPointType

Specifies the type of direction event or maneuver described by the point, designated by one of the values below.

  • Header (1)
  • Arrive (50)
  • Depart (51)
  • Straight (52)
  • On Ferry (100)
  • Off Ferry (101)
  • Central Fork (102)
  • Roundabout (103)
  • U-Turn (104)
  • Door (150)
  • Stairs (151)
  • Elevator (152)
  • Escalator (153)
  • Pedestrian Ramp (154)
  • Left Fork (200)
  • Left Ramp (201)
  • Clockwise Roundabout (202)
  • Left-handed U-turn (203)
  • Bear left (204)
  • Left Turn (205)
  • Sharp Left (206)
  • Left Turn and immediate Left Turn (207)
  • Left Turn and immediate Right Turn (208)
  • Right Fork (300)
  • Right Ramp (301)
  • Counter-Clockwise Roundabout (302)
  • Right-handed U-turn (303)
  • Bear right (304)
  • Right Turn (305)
  • Sharp Right (306)
  • Right Turn and immediate Left Turn (307)
  • Right Turn and immediate Right Turn (308)
  • Up Elevator (400)
  • Up Escalator (401)
  • Up Stairs (402)
  • Down Elevator (500)
  • Down Escalator (501)
  • Down stairs (502)
  • General Event (1000)
  • Landmark (1001)
  • Time Zone Change (1002)
  • Traffic Event (1003)
  • Scaled Cost Barrier Event (1004)
  • Boundary Crossing (1005)
  • Restriction Violation (1006)
  • Lane (1007)

Long

RenewalID

The ObjectID value of the output Renewals feature with which this direction point is associated.

Long

DisplayText

The directions text that will be displayed in the consuming application.

Text

ArrivalTime

The time the direction event occurs in coordinated universal time (UTC).

Date

ArrivalUTCOffset

The difference in minutes between the local time at the maneuver location and UTC time shown in the ArrivalTime field.

Double

Name

The name of the direction point.

Text

ExitName

The highway exit name that appears in the directions instruction.

Text

AlternateName

The alternate source name that appears in the directions instruction.

Text

IntersectingName

The name of the intersecting or cross street that appears in the directions instruction.

Text

BranchName

The signpost branch name that appears in the directions instruction.

Text

TowardName

The signpost toward destination name that appears in the directions instruction.

Text

Level

The building level at which this direction event occurs. This value corresponds to the Level property defined in the network dataset used for the analysis.

Long

ShortVoiceInstruction

The short text that will be used as voice guidance text in the consuming application.

Text

VoiceInstruction

The additional text, including expanded abbreviations and plurals, that will be used as voice guidance text in the consuming application.

Text

Azimuth

The bearing in degrees of the vehicle departing this point. Zero indicates north.

Double

FromIntersectingName

The name of the intersecting cross street where the collection will start.

Text

ToIntersectingName

The name of the intersecting cross street where the collection will end.

Text

DirectionLines

This is the output route lines calculated in the analysis sliced to represent each route segment between DirectionPoints events or maneuver locations.

Field nameDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

DirectionPointID

The ObjectID value of the feature in the DirectionPoints table with which this line is associated.

Long

RouteID

The ObjectID value of the output Routes feature with which this direction line is associated.

Long

DirectionLineType

Specifies the type of direction situation described by this line, designated by one of the following values:

  • Unknown (0)
  • Segment (1)
  • Maneuver Segment (2)
  • Restriction violation (3)
  • Scaled Cost Barrier (4)
  • Heavy Traffic (5)
  • Slow Traffic (6)
  • Moderate Traffic (7)

Long

Meters

The length of the line segment measured in meters.

Double

Minutes

The travel time along the line segment in minutes.

Double

FromLevel

The building level at which this direction event begins. This value corresponds to the Level property defined in the network dataset used for the analysis.

Learn more about the directions configuration of a network dataset

Long

ToLevel

The building level at which this direction event ends. This value corresponds to the Level property defined in the network dataset used for the analysis.

Long