MapData

  • Represents a set of administrative rules for a country or a state.

    See more

    Declaration

    Swift

    public struct AdminContextId : Hashable
  • Commercial vehicle regulations for an administrative region (country or state). Contains access restrictions, speed limits, and drive/rest rules applicable to commercial vehicles on road segments within the region.

    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.

    See more

    Declaration

    Swift

    public struct AdministrativeCommercialVehicleRules : Hashable
  • Represents a set of administrative rules for a country or a state.

    See more

    Declaration

    Swift

    public struct AdministrativeRules : Hashable
  • Provides the protocol for the access to the administrative rules available for a country or a state in the local OCM map. Please be aware that the methods within this classload map data synchronously. In the event of absent data in the disk cache, the data will be retrieved from the remote server. To mitigate the potential freezing of the calling thread, it is advisable to proactively prefetch map data around the working area.

    Note: Loading map data can be time-consuming, so AdministrativeRulesLoader can be used in a background thread to avoid blocking the main thread. However, this class is not thread-safe, and each instance should be used exclusively by a single thread.

    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.

    See more

    Declaration

    Swift

    public class AdministrativeRulesLoader
    extension AdministrativeRulesLoader: NativeBase
    extension AdministrativeRulesLoader: Hashable
  • Specifies which transport modes are allowed in a particular direction.

    Note: This struct specifies a general restriction to that transport mode, but additional restriction are possible.

    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.

    See more

    Declaration

    Swift

    public struct AllowedTransportModes : Hashable
  • Represents the rules regarding alcohol in blood content limit in a country or state for all types of drivers.

    See more

    Declaration

    Swift

    public struct BloodAlcoholContentLimit : Hashable
  • Concise description of road type used in commercial vehicle regulations.

    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.

    See more

    Declaration

    Swift

    public enum CommercialVehicleRoadType : UInt32, CaseIterable, Codable
  • A struct that provides information about link id and accessibility.

    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.

    See more

    Declaration

    Swift

    public struct Connectivity : Hashable
  • OCM Segment ID with travel direction of segment.

    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.

    See more

    Declaration

    Swift

    public struct DirectedOCMSegmentId : Hashable
  • A struct which identifies the configuration when downloading a file reference.

    See more

    Declaration

    Swift

    public struct DownloadingFileOptions : Hashable
  • Drive-rest regulation defining mandatory rest requirements for commercial vehicle drivers.

    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.

    See more

    Declaration

    Swift

    public struct DriveRestRegulation : Hashable
  • The side of the road on which the driving is done.

    See more

    Declaration

    Swift

    public enum DrivingSide : UInt32, CaseIterable, Codable
  • A struct that provides information for a file reference.

    See more

    Declaration

    Swift

    public struct FileReference : Hashable
  • Type of reference file.

    See more

    Declaration

    Swift

    public enum FileReferenceType : UInt32, CaseIterable, Codable
  • Hazardous material type as defined in the enum applicable for those that carry these

    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.

    See more

    Declaration

    Swift

    public enum HazardousMaterialType : UInt32, CaseIterable, Codable
  • The situations in which headlights are required to be turned on.

    See more

    Declaration

    Swift

    public enum HeadlightsRequirement : UInt32, CaseIterable, Codable
  • Specifies the local road characteristics: frontage, parking lot road, poi access.

    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.

    See more

    Declaration

    Swift

    public enum LocalRoadCharacteristic : UInt32, CaseIterable, Codable
  • Error occurred during obtaining data form the map. MapDataLoaderErrorCode represents possible errors.

    Declaration

    Swift

    public typealias MapDataLoaderError = MapDataLoaderErrorCode
  • Specifies possible errors from map data accessing.

    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.

    See more

    Declaration

    Swift

    public enum MapDataLoaderErrorCode : UInt32, CaseIterable, Codable
    extension MapDataLoaderErrorCode : Error
  • OCM Segment ID of particular matched SegmentReference from OCM map, represented in form: Tile + Local ID’s .

    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.

    See more

    Declaration

    Swift

    public struct OCMSegmentId : Hashable
  • The regulations for parking on the side of the road.

    See more

    Declaration

    Swift

    public enum ParkingSideRegulation : UInt32, CaseIterable, Codable
  • Physical attributes of the segment.

    Note a road can have more than one attribute at the same time.

    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.

    See more

    Declaration

    Swift

    public struct PhysicalAttributes : Hashable
  • Physical structure of a road feature that causes an access restriction, such as a bridge or tunnel that may limit vehicle dimensions or weight.

    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.

    See more

    Declaration

    Swift

    public enum PhysicalStructure : UInt32, CaseIterable, Codable
  • Represents the legal requirements to be considered before a trip for all vehicles types.

    See more

    Declaration

    Swift

    public struct PreTripPlanning : Hashable
  • Identifies the presence and the location of railway corssings. Included in SegmentData only if SegmentDataLoaderOptions.loadRailwayCrossings is set to true.

    See more

    Declaration

    Swift

    public struct RailwayCrossing
  • Type of railway crossing.

    See more

    Declaration

    Swift

    public enum RailwayCrossingType : UInt32, CaseIterable, Codable
  • A physical structure or painted road marking intended to legally prohibit left turns in right-side driving countries, right turns in left-side driving countries, and U-turns at divided intersections or in the middle of divided segments.

    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.

    See more

    Declaration

    Swift

    public enum RoadDivider : UInt32, CaseIterable, Codable
  • Road profile conditions that must be met for a regulation to apply.

    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.

    See more

    Declaration

    Swift

    public struct RoadProfileCondition : Hashable
  • Road Usages of the segment.

    Note a road can have more than one attribute at the same time.

    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.

    See more

    Declaration

    Swift

    public struct RoadUsages : Hashable
  • A struct that provides information about segment one direction source and target connectivities.

    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.

    See more

    Declaration

    Swift

    public struct SegmentConnectivities : Hashable
  • Contains the requested information for a segment

    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.

    See more

    Declaration

    Swift

    public class SegmentData
    extension SegmentData: NativeBase
    extension SegmentData: Hashable
  • Provides the protocol for the access to the segments data available in the local OCM map. Please be aware that the methods within this class load map data synchronously. In the event of absent data in the disk cache, the data will be retrieved from the remote server. To mitigate the potential freezing of the calling thread, it is advisable to proactively prefetch map data around the working area.

    Note: Loading map data can be time-consuming, so SegmentDataLoader can be used in a background thread to avoid blocking the main thread. However, this class is not thread-safe, and each instance should be used exclusively by a single thread.

    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.

    See more

    Declaration

    Swift

    public class SegmentDataLoader
    extension SegmentDataLoader: NativeBase
    extension SegmentDataLoader: Hashable
  • Specifies which data should be loaded by the SegmentDataLoader.loadData(...) or SegmentDataLoader.loadDirectedSegmentData(...) function.

    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.

    See more

    Declaration

    Swift

    public struct SegmentDataLoaderOptions : Hashable
  • A SegmentReferenceConverter provides possibility to convert mapmatched instances of SegmentReference to corresponding instances of DirectedOCMSegmentId.

    Note: Loading map data can be time-consuming, so SegmentReferenceConverter can be used in a background thread to avoid blocking the main thread. However, this class is not thread-safe, and each instance should be used exclusively by a single thread.

    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.

    See more

    Declaration

    Swift

    public class SegmentReferenceConverter
    extension SegmentReferenceConverter: NativeBase
    extension SegmentReferenceConverter: Hashable
  • Contains attributes that are not necessarily constant on a full segment. A Span is a portion of a Segment where the requested attributes are constant.

    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.

    See more

    Declaration

    Swift

    public class SegmentSpanData
    extension SegmentSpanData: NativeBase
    extension SegmentSpanData: Hashable
  • A special speed situation indicates a speed that exists under special circumstances. It can be used to further refine the estimation of traversal times, route calculation and calculation of route guidance timing.

    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.

    See more

    Declaration

    Swift

    public struct SegmentSpecialSpeedSituation : Hashable
  • Describes the posted speed limit on the segment span.

    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.

    See more

    Declaration

    Swift

    public struct SegmentSpeedLimit : Hashable
  • Represents the speed situation type.

    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.

    See more

    Declaration

    Swift

    public enum SpecialSpeedType : UInt32, CaseIterable, Codable
  • Contains informations about the toll costs for a specific vehicle profile.

    See more

    Declaration

    Swift

    public struct TollCost : Hashable
  • A struct to represent the toll point attributes of a segment.

    See more

    Declaration

    Swift

    public struct TollPoint
  • A struct that defines tolling configuration for a lane. It describes which types of toll structures apply and the acceptable payment methods. This information can be used to guide drivers through toll roads based on their preferences or vehicle capabilities.

    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.

    See more

    Declaration

    Swift

    public struct TollStructure : Hashable
  • A struct that provides information for a toll structure at a toll point.

    See more

    Declaration

    Swift

    public struct TollStructureManeuver
  • This enum defines the type of toll structure used on a road segment or lane. Each value represents a different tolling mechanism used in road infrastructure. This enum helps in providing detailed tolling information for routing and navigation.

    See more

    Declaration

    Swift

    public enum TollStructureType : UInt32, CaseIterable, Codable
  • Contains informations about a toll system.

    See more

    Declaration

    Swift

    public struct TollSystem : Hashable
  • Identifies the presence and the location of traffic lights at an intersection

    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.

    See more

    Declaration

    Swift

    public struct TrafficSignal
  • Indicates the location of a traffic signal.

    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.

    See more

    Declaration

    Swift

    public enum TrafficSignalLocation : UInt32, CaseIterable, Codable
  • The regulations for turning on the red color of the traffic light.

    See more

    Declaration

    Swift

    public enum TurnOnRedRegulation : UInt32, CaseIterable, Codable
  • Physical and cargo profile of a vehicle that triggers a regulation.

    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.

    See more

    Declaration

    Swift

    public struct VehicleProfileRestriction : Hashable
  • Combined set of conditions that must all be satisfied for a regulation to apply.

    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.

    See more

    Declaration

    Swift

    public struct VehicleRestrictionCondition : Hashable
  • Access regulation for a specific vehicle type on a road segment.

    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.

    See more

    Declaration

    Swift

    public struct VehicleSpecificAccess : Hashable
  • Speed limit regulation specific to a vehicle type.

    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.

    See more

    Declaration

    Swift

    public struct VehicleSpecificSpeedLimit : Hashable
  • Type of commercial vehicle to which a regulation applies.

    See more

    Declaration

    Swift

    public enum VehicleTypeCondition : UInt32, CaseIterable, Codable