RoadSignWarning constructor

  1. @Deprecated("Will be removed in v4.29.0. Use the constructor without deprecated fields instead.")
RoadSignWarning(
  1. int id,
  2. double distanceToRoadSignInMeters,
  3. RoadSignType type,
  4. RoadSignCategory category,
  5. GeneralWarningRoadSignType generalWarningType,
  6. bool isPrioritySign,
  7. List<RoadSignVehicleType> vehicleTypes,
  8. WeatherType weatherType,
  9. LocalizedText? signValue,
  10. LocalizedText? preWarning,
  11. LocalizedText? duration,
  12. LocalizedText? validityTime,
  13. SegmentReference roadSignSegment,
  14. DistanceType distanceType,
)

Creates a new instance.

  • id Unique identifier for this specific road sign warning instance. Each warning type (truck restrictions, speed warnings, etc.) maintains its own independent ID namespace. Use this ID to track, update, or dismiss individual warning instances of this type.
  • 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.
  • signValue Optional value visible on the main sign related to specific road sign types, as it is printed on the local road sign.
  • 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 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 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 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.segmentReference 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.

Implementation

@Deprecated("Will be removed in v4.29.0. Use the constructor without deprecated fields instead.")
RoadSignWarning(this.id, this.distanceToRoadSignInMeters, this.type, this.category, this.generalWarningType, this.isPrioritySign, this.vehicleTypes, this.weatherType, this.signValue, this.preWarning, this.duration, this.validityTime, this.roadSignSegment, this.distanceType);