IALocation Class Reference

Inherits from	NSObject
Declared in	IALocationManager.h

Overview

An IALocation object represents the location data generated by an IALocationManager object. This object incorporates the geographical coordinates along with values indicating the accuracy of the measurements and when those measurements were made. This class also reports information about the the course, the direction in which the device is traveling.

Typically, you use an IALocationManager object to create instances of this class based on the last known location of the user’s device. You can create instances yourself, however, if you want to cache custom location data or get the distance between two points.

This class is designed to be used as is and should not be subclassed.

Initializing a Location Object

`+ locationWithCLLocation:`

Initializes and returns a location object with specified CoreLocation information.

+ (nonnull IALocation *)locationWithCLLocation:(nonnull CLLocation *)location

Parameters

`location`	CLLocation object. Might be initialized in code or from CLLocationManager. An explicit location is used as a hint in the system. This means that the inputted location is used only to determine the initial position and setting the location does not lock the floor or venue context.

location

CLLocation object. Might be initialized in code or from CLLocationManager.

An explicit location is used as a hint in the system. This means that the inputted location is used only to determine the initial position and setting the location does not lock the floor or venue context.

Declared In

IALocationManager.h

`+ locationWithFloorPlanId:`

Initializes and returns a location object with specified floor plan id.

+ (nonnull IALocation *)locationWithFloorPlanId:(nonnull NSString *)floorPlanId

Parameters

`floorPlanId`	Identifier of the floor plan. An explicit floor plan is used for initialising and locking the positioning to a certain floor. This means that the position estimate is not free to leave the indicated floor. Using explicit location or venue id inputs is generally not recommended, and should only be used in difficult signal environments where getting first fix is not possible otherwise.

floorPlanId

Identifier of the floor plan.

An explicit floor plan is used for initialising and locking the positioning to a certain floor. This means that the position estimate is not free to leave the indicated floor. Using explicit location or venue id inputs is generally not recommended, and should only be used in difficult signal environments where getting first fix is not possible otherwise.

Declared In

IALocationManager.h

`+ locationWithVenueId:andFloor:`

Initializes and returns a location object with specified venue id (and floor).

+ (nonnull IALocation *)locationWithVenueId:(nonnull NSString *)venueId andFloor:(nullable IAFloor *)floor

Parameters

`venueId`	Identifier of the venue.
`<IAFloor>`	object with level information. Nil IAFloor means that the floor is unknown. An explicit venue is used for locking the positioning to a certain venue context (if a NIL floor is set). This means that the position estimate is not free to leave the indicated venue, but can move between floors. If an explicit floor is also given, the estimate is locked to that floor. Using explicit location or venue id inputs is generally not recommended, and should only be used in difficult signal environments where getting first fix is not possible otherwise.

venueId

Identifier of the venue.

<IAFloor>

object with level information. Nil IAFloor means that the floor is unknown.

An explicit venue is used for locking the positioning to a certain venue context (if a NIL floor is set). This means that the position estimate is not free to leave the indicated venue, but can move between floors. If an explicit floor is also given, the estimate is locked to that floor. Using explicit location or venue id inputs is generally not recommended, and should only be used in difficult signal environments where getting first fix is not possible otherwise.

Declared In

IALocationManager.h

Location Attributes

`location`

CoreLocation compatible location information. (read-only)

@property (nonatomic, readonly, nullable) CLLocation *location

Discussion

When running in the simulator, IALocationManager provides fake values. You must run your application on an actual iOS device to get the actual location of the device.

Declared In

IALocationManager.h

Optional attributes

`floor`

The logical floor of the building.

@property (nonatomic, readwrite, nullable) IAFloor *floor

Discussion

This property is included as CLLocation’s CLFloor is private interface. Thus it may be deprecated in future.

Declared In

IALocationManager.h

`region`

Region this location was obtained from.

@property (nonatomic, readwrite, nullable) IARegion *region

Declared In

IALocationManager.h