SYPosition Class Reference

Represents position, speed, and course information as provided by a positioning source for a distinct moment in time. More...

#import <SYPositioning.h>

Inheritance diagram for SYPosition:
Collaboration diagram for SYPosition:

Public Types

typedef void(^ SYLastKnownLocationCompletionBlock) (SYPosition *_Nullable position)
 Represents a completion block of getLastKnownLocationWithCompletion. More...
 

Instance Methods

(nonnull instancetype) - initWithCoordinate:latitudeAccuracy:longitudeAccuracy:altitudeAccuracy:speed:course:timestamp:
 
() - __deprecated_msg
 The last known SYPosition. More...
 

Class Methods

(nullable SYPosition *) + lastKnownLocation
 
(void) + getLastKnownLocationWithCompletion:
 The last known SYPosition. More...
 

Properties

SYGeoCoordinatecoordinate
 The geographical location of the position. More...
 
SYAccuracy latitudeAccuracy
 The accuracy of the latitude coordinate, in meters. More...
 
SYAccuracy longitudeAccuracy
 The accuracy of the longitude coordinate, in meters. More...
 
SYAccuracy altitudeAccuracy
 The accuracy of the altitude, in meters. More...
 
SYSpeed speed
 The movement speed of the position. More...
 
SYAngle course
 The course (direction of travel) of the position, in degrees. Valid course values are in the range [0, 360), with 0 degrees representing north and values increasing clockwise. More...
 
NSDate * timestamp
 The timestamp of acquired data. More...
 

Detailed Description

Represents position, speed, and course information as provided by a positioning source for a distinct moment in time.

Member Typedef Documentation

◆ SYLastKnownLocationCompletionBlock

- (typedef void(^ SYLastKnownLocationCompletionBlock) (SYPosition *_Nullable position))

Represents a completion block of getLastKnownLocationWithCompletion.

Method Documentation

◆ initWithCoordinate:latitudeAccuracy:longitudeAccuracy:altitudeAccuracy:speed:course:timestamp:

- (nonnull instancetype) initWithCoordinate: (nonnull SYGeoCoordinate *)  coordinate
latitudeAccuracy: (SYAccuracy)  latitudeAccuracy
longitudeAccuracy: (SYAccuracy)  longitudeAccuracy
altitudeAccuracy: (SYAccuracy)  altitudeAccuracy
speed: (SYSpeed)  speed
course: (SYAngle)  course
timestamp: (nonnull NSDate *)  timestamp 

◆ __deprecated_msg

- __deprecated_msg ("Use getLastKnownLocationWithCompletion instead.") 

The last known SYPosition.

◆ lastKnownLocation

+ (nullable SYPosition *) lastKnownLocation

◆ getLastKnownLocationWithCompletion:

+ (void) getLastKnownLocationWithCompletion: (nonnull SYLastKnownLocationCompletionBlock completion

The last known SYPosition.

Property Documentation

◆ coordinate

- (SYGeoCoordinate*) coordinate
readnonatomicassign

The geographical location of the position.

◆ latitudeAccuracy

- (SYAccuracy) latitudeAccuracy
readnonatomicassign

The accuracy of the latitude coordinate, in meters.

◆ longitudeAccuracy

- (SYAccuracy) longitudeAccuracy
readnonatomicassign

The accuracy of the longitude coordinate, in meters.

◆ altitudeAccuracy

- (SYAccuracy) altitudeAccuracy
readnonatomicassign

The accuracy of the altitude, in meters.

◆ speed

- (SYSpeed) speed
readnonatomicassign

The movement speed of the position.

◆ course

- (SYAngle) course
readnonatomicassign

The course (direction of travel) of the position, in degrees. Valid course values are in the range [0, 360), with 0 degrees representing north and values increasing clockwise.

◆ timestamp

- (NSDate*) timestamp
readnonatomicassign

The timestamp of acquired data.


The documentation for this class was generated from the following file: