SITLocation

@interface SITLocation : NSObject <NSCopying>

Describes a geographical position of the user, either indoor or outdoor. A valid indoor location has floorIdentifier and cartesianCoordinate in its position property.

  • Constructor.

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithTimestamp:(NSTimeInterval)timestamp
                                      position:(SITPoint *_Nonnull)position
                                       bearing:(float)bearing
                              cartesianBearing:(float)cartesianBearing
                                       quality:(kSITQualityValues)quality
                                      accuracy:(float)accuracy
                                      provider:(NSString *_Nonnull)provider;

    Parameters

    timestamp

    since 1970 when the location was determined, in milliseconds

    position

    geographical coordinate information.

    bearing

    the direction in which the device is traveling in geographical coordinate system (degrees)

    cartesianBearing

    The direction in which the device is traveling in cartesian coordinate system (radians)

    quality

    indicative of quality calculated with accuracy and building size.

    accuracy

    ccuracy radius (in meters).

    provider

    multiple providers can create locations. Determines which one has determined the location.

    Return Value

    initialized location

  • Constructor.

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithTimestamp:(NSTimeInterval)timestamp
                                      position:(SITPoint *_Nonnull)position
                                       bearing:(float)bearing
                              cartesianBearing:(float)cartesianBearing
                                       quality:(kSITQualityValues)quality
                                bearingQuality:(kSITQualityValues)bearingQuality
                                      accuracy:(float)accuracy
                                      provider:(NSString *_Nonnull)provider;

    Parameters

    timestamp

    since 1970 when the location was determined, in milliseconds

    position

    geographical coordinate information.

    bearing

    the direction in which the device is traveling in geographical coordinate system (degrees)

    cartesianBearing

    The direction in which the device is traveling in cartesian coordinate system (radians)

    quality

    indicative of quality calculated with accuracy and building size.

    bearingQuality

    indication of the quality of the bearing value

    accuracy

    ccuracy radius (in meters).

    provider

    multiple providers can create locations. Determines which one has determined the location.

    Return Value

    initialized location

  • The time interval since 1970 at which this location was determined, expressed in milliseconds

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSTimeInterval timestamp;
  • Geographical coordinate information.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) SITPoint *_Nonnull position;
  • The direction in which the device is traveling in geographical coordinate system (can be directly applied to a map provider)

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) SITAngle *_Nonnull bearing;
  • The direction in which the device is traveling in cartesian coordinate system.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) SITAngle *_Nonnull cartesianBearing;
  • Indication of the quality of the bearing value

    Note

    kSITHigh means the system is very confident on the bearing values. kSITLow means the system is still trying to determine the correct bearing; this situation happens when initializing the system.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) kSITQualityValues bearingQuality;
  • Return an indicative of quality calculated with accuracy and building size.

    Note

    Only used in indoor.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) kSITQualityValues quality;
  • Return the accuracy radius (in meters).

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float accuracy;
  • Multiple providers can create locations. This property determines which one has determined the location.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nonnull provider;
  • Identifier of the device that has generated the location

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nonnull deviceId;
  • Method that determines if the location has a high-quality bearing

    Declaration

    Objective-C

    - (BOOL)hasBearing;

    Return Value

    BOOL Location bearinqQuality is high (YES) or not (NO)