PathSearchDistance

public struct PathSearchDistance : Equatable

Horizon path search distance configuration. It specifies the maximum horizon length.

Important

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

Lifecycle

  • Creates a distance with the maximum horizon length.

    Throws

    An exception of the type PathSearchDistance.InitializationError if maxHorizonLength is negative.

    Declaration

    Swift

    public init(maxHorizonLength: Measurement<UnitLength> = Defaults.maxHorizonLength) throws

    Parameters

    maxHorizonLength

    The maximum length of the path in the horizon. If it is not specified, a default value of 0 is used.

Public

PathSearchDistance.InitializationError

  • An error that occurs during the creation of the instance.

    See more

    Declaration

    Swift

    public enum InitializationError : Error