YMKLocationSettings

@interface YMKLocationSettings : NSObject

Summary

Class methods

+ (nonnull YMKLocationSettings *)locationSettingsWithProvideAccuracy:( BOOL)provideAccuracy
                                                            accuracy:(nullable YMKRange *)accuracy
                                                locationTimeInterval:(nullable YMKTimeInterval *)locationTimeInterval
                                                        provideSpeed:( BOOL)provideSpeed
                                                               speed:( double)speed
                                                      provideHeading:( BOOL)provideHeading
                                                        headingError:(nullable YMKRange *)headingError
                                                       locationError:(nullable YMKLocationError *)locationError
                                                   provideWheelSpeed:( BOOL)provideWheelSpeed
                                              wheelSpeedTimeInterval:(nullable YMKTimeInterval *)wheelSpeedTimeInterval;

Instance methods

- (nonnull YMKLocationSettings *)init;

Properties

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL provideAccuracy;
Flag whether to provide accuracy value

@property (nonatomic, strong, readwrite, nullable) YMKRange *accuracy;
Location accuracy range in meters

@property (nonatomic, strong, readwrite, nullable)
    YMKTimeInterval *locationTimeInterval;

Location time interval in milliseconds

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL provideSpeed;
Flag whether to provide speed value

@property (nonatomic, assign, unsafe_unretained, readwrite) double speed;
The speed in meters per second

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL provideHeading;
Flag whether to provide error of heading

@property (nonatomic, strong, readwrite, nullable) YMKRange *headingError;
The current heading error range in degrees relative to true heading, clockwise

@property (nonatomic, strong, readwrite, nullable)
    YMKLocationError *locationError;

Optional field, can be nil

@property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL provideWheelSpeed;

Flag whether to provide wheel speed value

@property (nonatomic, strong, readwrite, nullable)
    YMKTimeInterval *wheelSpeedTimeInterval;

Time interval of getting the wheel speed in milliseconds

Class methods

locationSettingsWithProvideAccuracy:accuracy:locationTimeInterval:provideSpeed:speed:provideHeading:headingError:locationError:provideWheelSpeed:wheelSpeedTimeInterval:

+ (nonnull YMKLocationSettings *)locationSettingsWithProvideAccuracy:( BOOL)provideAccuracy
                                                            accuracy:(nullable YMKRange *)accuracy
                                                locationTimeInterval:(nullable YMKTimeInterval *)locationTimeInterval
                                                        provideSpeed:( BOOL)provideSpeed
                                                               speed:( double)speed
                                                      provideHeading:( BOOL)provideHeading
                                                        headingError:(nullable YMKRange *)headingError
                                                       locationError:(nullable YMKLocationError *)locationError
                                                   provideWheelSpeed:( BOOL)provideWheelSpeed
                                              wheelSpeedTimeInterval:(nullable YMKTimeInterval *)wheelSpeedTimeInterval;


Instance methods

init

- (nonnull YMKLocationSettings *)init;


Properties

provideAccuracy

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL provideAccuracy;

Flag whether to provide accuracy value.


accuracy

@property (nonatomic, strong, readwrite, nullable) YMKRange *accuracy;

Location accuracy range in meters.

Optional field, can be nil.


locationTimeInterval

@property (nonatomic, strong, readwrite, nullable)
    YMKTimeInterval *locationTimeInterval;

Location time interval in milliseconds.

Optional field, can be nil.


provideSpeed

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL provideSpeed;

Flag whether to provide speed value.


speed

@property (nonatomic, assign, unsafe_unretained, readwrite) double speed;

The speed in meters per second.


provideHeading

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL provideHeading;

Flag whether to provide error of heading.


headingError

@property (nonatomic, strong, readwrite, nullable) YMKRange *headingError;

The current heading error range in degrees relative to true heading, clockwise.

Optional field, can be nil.


locationError

@property (nonatomic, strong, readwrite, nullable)
    YMKLocationError *locationError;

Optional field, can be nil.


provideWheelSpeed

@property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL provideWheelSpeed;

Flag whether to provide wheel speed value.


wheelSpeedTimeInterval

@property (nonatomic, strong, readwrite, nullable)
    YMKTimeInterval *wheelSpeedTimeInterval;

Time interval of getting the wheel speed in milliseconds. After publication the wheel speed corresponds to the speed value.

Optional field, can be nil.