RoadSign (API Reference)
Class RoadSign
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 Summary
FieldsModifier and TypeFieldDescriptionSpecifies the general warning to which the road sign belongs.booleanFlag indicating if the road sign is a priority sign.Optional length information during which the warning is applicable.Optional pre-warning in terms of distance, of the upcoming warning or regulation.Optional value visible on the main sign related to specific road sign types, as it is printed on the local road sign.Optional text visible on the supplemental sign indicating specific time(s) at which the road sign is applicable.intThe offset in meters from the beginning of the segment to the location of the road sign in positive direction.The main category to which the road sign belongs.Type of the road sign.Segment direction which the road sign is applied.Specifies a list of vehicle types for which the road sign is applicable.Specifies the weather type for which the sign is applicable. -
Constructor Summary
ConstructorsConstructorDescriptionRoadSign(int offsetInMeters, TravelDirection travelDirection, RoadSignType roadSignType, RoadSignCategory roadSignCategory, boolean isPrioritySign, GeneralWarningRoadSignType generalWarningType, List<RoadSignVehicleType> vehicleTypes, WeatherType weatherType) Creates a new instance with default values. -
Method Summary
-
Field Details
-
offsetInMeters
public int offsetInMetersThe 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
public boolean isPrioritySignFlag 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. -
localizedSignValue
Optional value visible on the main sign related to specific road sign types, as it is printed on the local road sign.
-
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
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
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
-
Method Details