Package com.here.sdk.navigation

Class RoadSignWarning

java.lang.Object
com.here.sdk.navigation.RoadSignWarning
public final class RoadSignWarning extends Object

A road sign. The main field describing the sign is type. Some road types are standardized, others can be country specific. A valid road sign contains known type or category. Use RoadSignWarningListener to get notifications with current road signs.

  • Field Details

    • distanceToRoadSignInMeters

      public double distanceToRoadSignInMeters

      Distance to the road sign in meters.

    • type

      @NonNull public RoadSignType type

      Type of the road sign.

    • category

      @NonNull public RoadSignCategory category

      The main category to which the road sign belongs.

    • generalWarningType

      @NonNull public GeneralWarningRoadSignType generalWarningType

      Specifies the general warning to which the road sign belongs.

    • isPrioritySign

      public boolean isPrioritySign

      Flag indicating if the road sign is a priority sign.

    • vehicleTypes

      @NonNull public List<RoadSignVehicleType> vehicleTypes

      Specifies a list of vehicle types for which the road sign is applicable. The list will be empty when the road sign is applicable for all vehicles including cars.

    • weatherType

      @NonNull public WeatherType weatherType

      Specifies the weather type for which the sign is applicable. If weather type is WeatherType.UNKNOWN, the sign is actual for all weather types.

    • signValue

      @Nullable public LocalizedText signValue

      Optional value visible on the main sign related to specific road sign types, as it is printed on the local road sign.

    • preWarning

      @Nullable public LocalizedText preWarning

      Optional pre-warning in terms of distance, of the upcoming warning or regulation. The pre-warning information is given as printed on the local road sign.

    • duration

      @Nullable public LocalizedText duration

      Optional length information during which the warning is applicable. Usually, this information is shown on a separate shield below the main shield. For example, a sign may warn on playing children for a length of 100 m, starting from the location of the warning sign. The length information (most likely with units) is given as printed on the local road sign.

    • validityTime

      @Nullable public LocalizedText validityTime

      Optional text visible on the supplemental sign indicating specific time(s) at which the road sign is applicable. The time information is given as printed on the local road sign.

    • roadSignSegment

      @NonNull public SegmentReference roadSignSegment

      The reference to the segment where the road sign is located. It can be used to identify the location of the road sign. It allows to compare the road sign location with the MapMatchedLocation.segment_reference provided by the NavigableLocationListener or with the Span.getSegmentReference() available in the Route's Span. By combining it with the geometry of the segment, that can be loaded using SegmentDataLoader, it is possible to identify the road sign's coordinates.

    • distanceType

      @NonNull public DistanceType distanceType

      The distance type for the warning, e.g. a warning for a new road sign ahead or a warning for passing a road sign. Since the road sign warning is given relative to a single position on the route, DistanceType.REACHED will never be given for this warning.

  • Constructor Details

    • RoadSignWarning

      public RoadSignWarning(double distanceToRoadSignInMeters, @NonNull RoadSignType type, @NonNull RoadSignCategory category, @NonNull GeneralWarningRoadSignType generalWarningType, boolean isPrioritySign, @NonNull List<RoadSignVehicleType> vehicleTypes, @NonNull WeatherType weatherType, @NonNull SegmentReference roadSignSegment, @NonNull DistanceType distanceType)

      Creates a new instance.

      Parameters:
      distanceToRoadSignInMeters -

      Distance to the road sign in meters.

      type -

      Type of the road sign.

      category -

      The main category to which the road sign belongs.

      generalWarningType -

      Specifies the general warning to which the road sign belongs.

      isPrioritySign -

      Flag indicating if the road sign is a priority sign.

      vehicleTypes -

      Specifies a list of vehicle types for which the road sign is applicable. The list will be empty when the road sign is applicable for all vehicles including cars.

      weatherType -

      Specifies the weather type for which the sign is applicable. If weather type is WeatherType.UNKNOWN, the sign is actual for all weather types.

      roadSignSegment -

      The reference to the segment where the road sign is located. It can be used to identify the location of the road sign. It allows to compare the road sign location with the MapMatchedLocation.segment_reference provided by the NavigableLocationListener or with the Span.getSegmentReference() available in the Route's Span. By combining it with the geometry of the segment, that can be loaded using SegmentDataLoader, it is possible to identify the road sign's coordinates.

      distanceType -

      The distance type for the warning, e.g. a warning for a new road sign ahead or a warning for passing a road sign. Since the road sign warning is given relative to a single position on the route, DistanceType.REACHED will never be given for this warning.

  • Method Details