Skip to content

RoutePedestrianSpan

Source code in docs_src/capo_geo_routes/types/route_pedestrian_span.py
class RoutePedestrianSpan(TypedDict, closed=True):
    best_case_duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Duration of the computed span without traffic congestion.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""
    country: NotRequired["capo_geo_routes.types.country_code3.CountryCode3"]
    """<p>3 letter Country code corresponding to the Span.</p>"""
    distance: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.</p>"""
    duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""
    dynamic_speed: NotRequired[
        "capo_geo_routes.types.route_span_dynamic_speed_details.RouteSpanDynamicSpeedDetails"
    ]
    """<p>Dynamic speed details corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>"""
    functional_classification: NotRequired[
        "capo_geo_routes.types.sensitive_integer.SensitiveInteger"
    ]
    """<p>A numerical value indicating the functional classification of the road segment corresponding to the span.</p> <p>Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:</p> <ol> <li> <p>Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.</p> </li> <li> <p>Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.</p> </li> <li> <p>Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.</p> </li> <li> <p>Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.</p> </li> <li> <p>Roads with volume and traffic movement below the level of any other functional class.</p> </li> </ol>"""
    geometry_offset: NotRequired["int"]
    """<p>Offset in the leg geometry corresponding to the start of this span.</p>"""
    incidents: NotRequired["capo_geo_routes.types.index_list.IndexList"]
    """<p>Incidents corresponding to the span. These index into the Incidents in the parent Leg.</p>"""
    names: NotRequired[
        "capo_geo_routes.types.localized_string_list.LocalizedStringList"
    ]
    """<p>Provides an array of names of the pedestrian span in available languages.</p>"""
    pedestrian_access: NotRequired[
        "capo_geo_routes.types.route_span_pedestrian_access_attribute_list.RouteSpanPedestrianAccessAttributeList"
    ]
    """<p>Access attributes for a pedestrian corresponding to the span.</p>"""
    region: NotRequired["capo_geo_routes.types.sensitive_string.SensitiveString"]
    """<p>2-3 letter Region code corresponding to the Span. This is either a province or a state.</p>"""
    road_attributes: NotRequired[
        "capo_geo_routes.types.route_span_road_attribute_list.RouteSpanRoadAttributeList"
    ]
    """<p>Attributes for the road segment corresponding to the span. </p>"""
    route_numbers: NotRequired[
        "capo_geo_routes.types.route_number_list.RouteNumberList"
    ]
    """<p>Designated route name or number corresponding to the span.</p>"""
    speed_limit: NotRequired[
        "capo_geo_routes.types.route_span_speed_limit_details.RouteSpanSpeedLimitDetails"
    ]
    """<p>Speed limit details corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>"""
    typical_duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Duration of the computed span under typical traffic congestion.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""

best_case_duration instance-attribute

best_case_duration: DurationSeconds

Duration of the computed span without traffic congestion.

Unit: seconds

country instance-attribute

country: NotRequired[CountryCode3]

3 letter Country code corresponding to the Span.

distance instance-attribute

distance: DistanceMeters

Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

duration instance-attribute

duration: DurationSeconds

Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

Unit: seconds

dynamic_speed instance-attribute

dynamic_speed: NotRequired[RouteSpanDynamicSpeedDetails]

Dynamic speed details corresponding to the span.

Unit: kilometers per hour

functional_classification instance-attribute

functional_classification: NotRequired[SensitiveInteger]

A numerical value indicating the functional classification of the road segment corresponding to the span.

Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:

  1. Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.

  2. Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.

  3. Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.

  4. Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.

  5. Roads with volume and traffic movement below the level of any other functional class.

geometry_offset instance-attribute

geometry_offset: NotRequired[int]

Offset in the leg geometry corresponding to the start of this span.

incidents instance-attribute

incidents: NotRequired[IndexList]

Incidents corresponding to the span. These index into the Incidents in the parent Leg.

names instance-attribute

names: NotRequired[LocalizedStringList]

Provides an array of names of the pedestrian span in available languages.

pedestrian_access instance-attribute

pedestrian_access: NotRequired[RouteSpanPedestrianAccessAttributeList]

Access attributes for a pedestrian corresponding to the span.

region instance-attribute

region: NotRequired[SensitiveString]

2-3 letter Region code corresponding to the Span. This is either a province or a state.

road_attributes instance-attribute

road_attributes: NotRequired[RouteSpanRoadAttributeList]

Attributes for the road segment corresponding to the span.

route_numbers instance-attribute

route_numbers: NotRequired[RouteNumberList]

Designated route name or number corresponding to the span.

speed_limit instance-attribute

speed_limit: NotRequired[RouteSpanSpeedLimitDetails]

Speed limit details corresponding to the span.

Unit: kilometers per hour

typical_duration instance-attribute

typical_duration: DurationSeconds

Duration of the computed span under typical traffic congestion.

Unit: seconds