GeneralRoadProperties

public struct GeneralRoadProperties : HorizonElement

Describes the general road properties on the horizon element.

This class holds a horizon element with information regarding general road elements. It contains information regarding number of lanes, functional road class, form of way, road condition, driving side and multiple flags indicating additional properites.

To obtain GeneralRoadProperties horizon elements, the integrator must create an instance of HorizonEngine, register HorizonOptions including elementTypes containing HorizonElementType .generalRoadPropertiesType with a call to HorizonEngine .registerHorizonOptions, and request a HorizonResult using the previously registered HorizonOptions with a call to HorizonEngine .generateHorizon.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Initializes GeneralRoadProperties .

    To obtain GeneralRoadProperties horizon element, user must create instance of HorizonEngine, register HorizonOptions with call registerHorizonOptions including elementTypes containing value HorizonElementType .generalRoadPropertiesType.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public init(
    id: Int,
    pathID: Int,
    startOffset: Measurement<UnitLength>,
    endOffset: Measurement<UnitLength>,
    roadProperties: RoadProperties
) throws

    Parameters

    id

    Identifier of this element.
    pathID

    Identifier of the path this element belongs to.
    startOffset

    Start offset on the path.
    endOffset

    End offset on the path.
    roadProperties

    Information about the properties of the road at the current location such as number of lanes, driving side, road condition etc.

Public

  • Contains threshold values for the parameters used to initialize GeneralRoadProperties.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public enum Constants

  • Type of the element used to filter elements by type.

    Declaration

    Swift

    public let elementType: HorizonElementType
  • id

    Identifier of this element.

    Declaration

    Swift

    public let id: Int

  • Identifier of the path where this element belongs.

    Declaration

    Swift

    public let pathID: Int

  • Start offset on the path.

    Declaration

    Swift

    public let startOffset: Measurement<UnitLength>

  • End offset on the path.

    Declaration

    Swift

    public let endOffset: Measurement<UnitLength>

  • The properties of the road, such as number of lanes, road importance designator, physical properties, surface, driving side and others.

    Declaration

    Swift

    public let roadProperties: RoadProperties