AdministrativeRules (API Reference)
Class AdministrativeRules
Represents a set of administrative rules for a country or a state.
-
Field Summary
FieldsModifier and TypeFieldDescriptionIndicates the rules regarding alcohol in blood content limit in a country or state for all types of drivers.Country code for which the administrative rules apply.Time rule indicating the time periods in which daylight savings applies.The side of the road used for driving in the country or state.Indicates in which conditions should the headlights be turned on.booleanIndicates if the country or state requires an ecological sticker.booleanIndicates if the country or state requires paid fees for usage of the motorways / controlled access roads.booleanIndicates if the country or state requires a toll sticker.booleanIndicates if performing a u-turn maneuver is restricted.Indicates the regulations for parking on the side of the road.Indicates the legal requirements to be considered before a trip for all vehicles types.The general speed limits in the country or state.The state code for which the administrative rules apply.The time zone offset from UTC of the country or state expressed in minutes.Indicates the toll systems present in a country or state.Indicates the regulations for turning on the red color of the traffic light.Defines the measurement system used for distances. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
countryCode
Country code for which the administrative rules apply.
-
stateCode
The state code for which the administrative rules apply. It represents the state / province code. It is a 1 to 3 upper-case characters string that follows the ISO 3166-2 standard, but without the preceding country code (e.g. for Texas, the state code will be TX). It will be
nullif the rules are applying to the entire country and not just a specific state. -
drivingSide
The side of the road used for driving in the country or state. Defaults to right driving side.
-
unitSystem
Defines the measurement system used for distances. Defaults to metric measurement system.
-
speedLimits
The general speed limits in the country or state.
-
timeZoneOffsetsInMinutes
The time zone offset from UTC of the country or state expressed in minutes. The value can also be negative (e.g.: Eastern Standard Time (EST) will be -360 minutes, Central European Time (CET) will be 60 minutes). Defaults to 0 minutes. Note: A time zone with a positive shift of 1 hour and 30 minutes will result in a time zone offset of 90 minutes. A time zone with a negative shift of 3 hour and 30 minutes will result in an time zone offset of -210 minutes. In order to properly calculate the time zone offset, the [AdministrativeRules.daylight_saving_period] should be taken into consideration and if the daylight savings time is observed at the time of the calculation, then a value of 60 minutes should be substracted from the time zone offset.
-
daylightSavingPeriod
Time rule indicating the time periods in which daylight savings applies. If the field is 'null' then daylight savings time is not observed in the country or state. Note: In order to properly calculate the time zone offset, if the daylight savings time is observed at the time of the calculation, then a value of 60 minutes should be substracted from the time zone offset.
-
isUturnRestricted
public boolean isUturnRestrictedIndicates if performing a u-turn maneuver is restricted. Defaults to
false. -
headlightsRequirements
Indicates in which conditions should the headlights be turned on. Defaults to an empty list, which means that by default there are no special situations in which the headlights should be turned on.
-
isTollRequired
public boolean isTollRequiredIndicates if the country or state requires paid fees for usage of the motorways / controlled access roads. Defaults to
false. -
isTollStickerRequired
public boolean isTollStickerRequiredIndicates if the country or state requires a toll sticker. Defaults to
false. -
turnOnRedRegulations
Indicates the regulations for turning on the red color of the traffic light.
-
parkingSideRegulations
Indicates the regulations for parking on the side of the road.
-
isCleanAirStickerRequired
public boolean isCleanAirStickerRequiredIndicates if the country or state requires an ecological sticker. Defaults to
false. -
bloodAlcoholContentLimit
Indicates the rules regarding alcohol in blood content limit in a country or state for all types of drivers.
-
tollSystems
Indicates the toll systems present in a country or state.
-
preTripPlanning
Indicates the legal requirements to be considered before a trip for all vehicles types.
-
-
Constructor Details
-
AdministrativeRules
public AdministrativeRules()Creates a new instance.
-
-
Method Details