LocationSimulatorOptions Structure Reference
- Last UpdatedJun 10, 2025
- 2 minute read
public struct LocationSimulatorOptions : Hashable
Options to specify how the location simulator will behave.
-
A factor to scale the speed. Useful to speed up (or down) the simulation. By default, the speed factor is 1.0, which is equal to the speed that one normally drives along each route segment without taking into account any traffic-related constraints. The default speed may vary based on the road geometry, road condition and other statistical data. Values above 1.0 will increase the speed, values below 1.0 will reduce the speed. For example, a value of 2.0 will double the speed.
Declaration
Swift
public var speedFactor: Double
-
Interval between notifications. Defaults to 1 second. Note that
TimeInterval
accepts seconds as double, so 500 ms can be set as 0.5 s. Values less than 1 ms are not acceptable and the interval is raised to this minimum in object constructors.Note: This value does not affect
LocationSimulator
when created with aGPXTrack
.Declaration
Swift
public var notificationInterval: TimeInterval
-
Creates a new instance of this class.
Parameters
- speedFactor: A factor to scale the speed. Useful to speed up (or down) the simulation. By default, the speed factor is 1.0, which is equal to the speed that one normally drives along each route segment without taking into account any traffic-related constraints. The default speed may vary based on the road geometry, road condition and other statistical data. Values above 1.0 will increase the speed, values below 1.0 will reduce the speed. For example, a value of 2.0 will double the speed.
- notificationInterval: Interval between notifications.
Defaults to 1 second.
Note that
TimeInterval
accepts seconds as double, so 500 ms can be set as 0.5 s. Values less than 1 ms are not acceptable and the interval is raised to this minimum in object constructors.
Note: This value does not affect
LocationSimulator
when created with aGPXTrack
.
Declaration
Swift
public init(speedFactor: Double = 1.0, notificationInterval: TimeInterval = 1000 * 0.001)