Skip to content

CalculateRouteMatrixResponse

Source code in docs_src/capo_location/types/calculate_route_matrix_response.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class CalculateRouteMatrixResponse(TypedDict, closed=True):
    route_matrix: "capo_location.types.route_matrix.RouteMatrix"
    """<p>The calculated route matrix containing the results for all pairs of <code>DeparturePositions</code> to <code>DestinationPositions</code>. Each row corresponds to one entry in <code>DeparturePositions</code>. Each entry in the row corresponds to the route from that entry in <code>DeparturePositions</code> to an entry in <code>DestinationPositions</code>. </p>"""
    snapped_departure_positions: NotRequired[
        "capo_location.types.position_list.PositionList"
    ]
    """<p>For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the <code>RouteMatrix</code>.</p>"""
    snapped_destination_positions: NotRequired[
        "capo_location.types.position_list.PositionList"
    ]
    """<p>The list of destination positions for the route matrix used for calculation of the <code>RouteMatrix</code>.</p>"""
    summary: (
        "capo_location.types.calculate_route_matrix_summary.CalculateRouteMatrixSummary"
    )
    """<p>Contains information about the route matrix, <code>DataSource</code>, <code>DistanceUnit</code>, <code>RouteCount</code> and <code>ErrorCount</code>.</p>"""

route_matrix instance-attribute 

route_matrix: RouteMatrix

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

snapped_departure_positions instance-attribute 

snapped_departure_positions: NotRequired[PositionList]

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

snapped_destination_positions instance-attribute 

snapped_destination_positions: NotRequired[PositionList]

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

summary instance-attribute 

summary: CalculateRouteMatrixSummary

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.