Method Details

• getStartOffsetInMeters

  public int getStartOffsetInMeters()

  Gets the start offset in meters of the span.

  The offset in meters from the beginning of the segment to the start of the span in positive direction or from the end of the segment to the start of the span in negative direction.

  Returns:

  Start offset.

• getSpanLengthInMeters

  public int getSpanLengthInMeters()

  Gets the length of this span in meters.

  Returns:

  The length of this span in meters.

• getTravelDirection

  @Nullable public TravelDirection getTravelDirection()

  Gets the TravelDirection.

  Gets the TravelDirection object for the portion of the segment. Returns null if SegmentDataLoaderOptions.loadTravelDirection is set to false.

  Returns:

  The TravelDirection object representing the allowed travel directions.

• getAllowedTransportModes

  @Nullable public AllowedTransportModes getAllowedTransportModes()

  Gets the AllowedTransportModes object.

  Returns null if SegmentDataLoaderOptions.loadTransportModesAccess is set to false.

  Returns:

  The AllowedTransportModes object representing the allowed transport modes.

• getFunctionalRoadClass

  @Nullable public FunctionalRoadClass getFunctionalRoadClass()

  Gets the FunctionalRoadClass object representing the polyline of this section.

  Returns null if SegmentDataLoaderOptions.loadFunctionalRoadClass is set to false.

  Returns:

  The FunctionalRoadClass object representing the polyline of this segment.

• getPositiveDirectionSpeedLimit

  @Nullable public SegmentSpeedLimit getPositiveDirectionSpeedLimit()

  Gets the SegmentSpeedLimit object representing the speed limit of this segment span.

  Returns null if SegmentDataLoaderOptions.loadSpeedLimits is set to false.

  Returns:

  The SegmentSpeedLimit object representing the speed limit of this segment span in the positive tavel direction.

• getNegativeDirectionSpeedLimit

  @Nullable public SegmentSpeedLimit getNegativeDirectionSpeedLimit()

  Gets the SegmentSpeedLimit object representing the speed limit of this segment span.

  Returns null if SegmentDataLoaderOptions.loadSpeedLimits is set to false.

  Returns:

  The SegmentSpeedLimit object representing the speed limit of this segment span in the negative travel direction.

• getSpeedLimit

  @Nullable public SegmentSpeedLimit getSpeedLimit()

  Gets the SegmentSpeedLimit object representing the speed limit of this segment span.

  Will be loaded if SegmentDataLoaderOptions.loadSpeedLimits is true.

  Returns:

  The SegmentSpeedLimit object representing the speed limit of this segment span.

• getPositiveDirectionBaseSpeedInMetersPerSecond

  @Nullable public Double getPositiveDirectionBaseSpeedInMetersPerSecond()

  Gets the average speed in the positive direction.

  Returns null if SegmentDataLoaderOptions.loadBaseSpeeds is set to false.

  Returns:

  The average speed expected for this segment in positive direction with a car or a similar vehicle.

• getNegativeDirectionBaseSpeedInMetersPerSecond

  @Nullable public Double getNegativeDirectionBaseSpeedInMetersPerSecond()

  Gets the average speed in the negative direction.

  Returns null if SegmentDataLoaderOptions.loadBaseSpeeds is set to false.

  Returns:

  The average speed expected for this segment in negative direction with a car or a similar vehicle.

• getBaseSpeedInMetersPerSecond

  @Nullable public Double getBaseSpeedInMetersPerSecond()

  Gets the average speed for this segment span.

  Will be loaded if SegmentDataLoaderOptions.loadBaseSpeeds is true.

  Returns:

  The average speed expected for this segment span with a car or a similar vehicle.

• getLocalRoadCharacteristics

  @Nullable public List<LocalRoadCharacteristic> getLocalRoadCharacteristics()

  Gets the local road characteristics.

  Returns null if SegmentDataLoaderOptions.loadLocalRoadCharacteristics is set to false.

  Returns:

  The local road characteristics of the segment: frontage, parking lot road, or POI access road.

• getStreetNames

  @Nullable public LocalizedTexts getStreetNames()

  The street names on the span.

  Returns null if SegmentDataLoaderOptions.loadStreetNamesAndRoadNumbers is set to false.

  Returns:

  The street names on the span.

• getRoadNumbers

  @Nullable public LocalizedRoadNumbers getRoadNumbers()

  Gets the road numbers on the span enriched with information specific to route numbers of a road such as I-10, US-50, or A3.

  Returns null if SegmentDataLoaderOptions.loadStreetNamesAndRoadNumbers is set to false.

  Returns:

  The road numbers on the span enriched with information specific to route numbers of a road such as I-10, US-50, or A3.

• getPhysicalAttributes

  @Nullable public PhysicalAttributes getPhysicalAttributes()

  Gets the physical attributes.

  Returns null if SegmentDataLoaderOptions.loadRoadAttributes is set to false.

  Returns:

  The physical attributes of the segment.

• getRoadUsages

  @Nullable public RoadUsages getRoadUsages()

  Gets the road usages.

  Returns null if SegmentDataLoaderOptions.loadRoadAttributes is set to false.

  Returns:

  The road usages of the segment.

• getAdministrativeRules

  @Nullable public AdministrativeRules getAdministrativeRules()

  Gets the AdministrativeRules for the segment.

  Returns null if SegmentDataLoaderOptions.loadAdministrativeRules is set to false.

  Returns:

  The AdministrativeRules for the segment, containing information about country code, state code, unit system, tolls, pre-trip planning and other administrative information.

• isUrban

  @Nullable public Boolean isUrban()

  Gets the urban attribute of the segment.

  Returns null if SegmentDataLoaderOptions.loadUrban is set to false.

  Returns:

  The urban attribute of the segment.

• getSpecialSpeedSituations

  @Nullable public List<SegmentSpecialSpeedSituation> getSpecialSpeedSituations()

  Gets the list of SegmentSpecialSpeedSituation.

  Will be loaded if SegmentDataLoaderOptions.loadSpecialSpeedSituations is true. Note: To get timezone offset and daylight saving time values for TimeRule, [sdk.mapdata.SegmentDataLoaderOptions.load_administrative_rules] must also be set to true.

  Returns:

  The special speed situations of the segment.