Class RoadSign

java.lang.Object
com.here.sdk.navigation.RoadSign

public final class RoadSign extends Object

Describes a road sign.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

  • Field Details

    • offsetInMeters

      public int offsetInMeters

      The offset in meters from the beginning of the segment to the location of the road sign in positive direction.

    • travelDirection

      @NonNull public TravelDirection travelDirection

      Segment direction which the road sign is applied.

    • roadSignType

      @NonNull public RoadSignType roadSignType

      Type of the road sign.

    • roadSignCategory

      @NonNull public RoadSignCategory roadSignCategory

      The main category to which the road sign belongs.

    • isPrioritySign

      public boolean isPrioritySign

      Flag indicating if the road sign is a priority sign.

    • generalWarningType

      @NonNull public GeneralWarningRoadSignType generalWarningType

      Specifies the general warning to which the road sign belongs.

    • 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.

    • localizedSignValue

      @Nullable public LocalizedText localizedSignValue

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

    • localizedPreWarning

      @Nullable public LocalizedText localizedPreWarning

      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.

    • localizedDuration

      @Nullable public LocalizedText localizedDuration

      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.

    • localizedValidityTime

      @Nullable public LocalizedText localizedValidityTime

      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.

  • Constructor Details

    • RoadSign

      public RoadSign(int offsetInMeters, @NonNull TravelDirection travelDirection, @NonNull RoadSignType roadSignType, @NonNull RoadSignCategory roadSignCategory, boolean isPrioritySign, @NonNull GeneralWarningRoadSignType generalWarningType, @NonNull List<RoadSignVehicleType> vehicleTypes, @NonNull WeatherType weatherType)

      Creates a new instance with default values.

      Parameters:
      offsetInMeters -

      The offset in meters from the beginning of the segment to the location of the road sign in positive direction.

      travelDirection -

      Segment direction which the road sign is applied.

      roadSignType -

      Type of the road sign.

      roadSignCategory -

      The main category to which the road sign belongs.

      isPrioritySign -

      Flag indicating if the road sign is a priority sign.

      generalWarningType -

      Specifies the general warning to which the road sign belongs.

      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.

  • Method Details