MPPositionResult Class Reference

#include <MPPositionResult.h>

Inheritance diagram for MPPositionResult:

Instance Methods
(_Nullable instancetype)	- initWithWirelessPositionData:
(double)	- getProbability
(double)	- getRoundtrip
(double)	- getHeadingDegrees
(nullable NSNumber *)	- getAge
(nullable NSNumber *)	- getFloor
(void)	- setProbability:
(void)	- setHeadingDegrees:

Properties
MPPoint *	geometry
BOOL	headingAvailable
NSMutableDictionary *	properties
NSString *	type
id< Optional >	provider

Detailed Description

Position result model

Method Documentation

getAge

- (nullable NSNumber *) getAge

Get the age of the this position result; the time in seconds since the position was first determined.

Returns

The age property as a number

Deprecated

getFloor

- (nullable NSNumber *) getFloor

Get the floor index property

Returns

The floor index property

getHeadingDegrees

- (double) getHeadingDegrees

Get the heading in degrees from north

Returns

The heading value in degrees from north as a double

getProbability

- (double) getProbability

Get the probability of the position. This is a radius in meters. Can be used to generate an approximation circle.

Returns

A double representing the positions accuracy in meters.

getRoundtrip

- (double) getRoundtrip

Get the roundtrip property

Returns

The roundtrip value.

Deprecated

initWithWirelessPositionData:

- (_Nullable instancetype) initWithWirelessPositionData:

(nonnull NSData *)

positionData

setHeadingDegrees:

- (void) setHeadingDegrees:

(double)

heading

Set the heading of the position result in degrees from north

Parameters

heading

The heading value in degrees from north as a double

setProbability:

- (void) setProbability:

(double)

probability

Property Documentation

geometry

- (MPPoint*) geometry

readwritenonatomicstrong

The geographic point geometry of the position

headingAvailable

- (BOOL) headingAvailable

readwritenonatomicassign

The availability of the heading, returns NO if heading is not available, default is YES

properties

- (NSMutableDictionary*) properties

readwritenonatomicstrong

Properties dictionary

provider

- (id<Optional>) provider

readwritenonatomicweak

Position provider that delivered this position

type

- (NSString*) type

readwritenonatomicstrong

Type property

Deprecated