Navmii SDK  2.2.0
Write yourself a navigation system in iOS
Instance Methods | Class Methods | Properties | List of all members
NMDirection Class Reference

Inherits <NSObject>.

Instance Methods

(nullable instancetype) - NS_UNAVAILABLE
 
(nullable instancetype) - initWithType:roadFrom:roadTo:roundaboutAngle:roundaboutExitNumber:motorwayExitNumber:distanceFromPreviousDirection:
 
(nullable instancetype) - initWithType:roadFrom:roadTo:
 

Class Methods

(nullable instancetype) + NS_UNAVAILABLE
 

Properties

NMDirectionType type
 
NMRoadInforoadFrom
 
NMRoadInforoadTo
 
NSNumber * distanceFromPreviousDirection
 
NSNumber * roundaboutAngle
 
NSNumber * roundaboutExitNumber
 
NSString * motorwayExitNumber
 

Detailed Description

Interface describing a direction on route.

Method Documentation

◆ initWithType:roadFrom:roadTo:()

- (nullable instancetype) initWithType: (NMDirectionType type
roadFrom: (nonnull NMRoadInfo *)  roadFrom
roadTo: (nonnull NMRoadInfo *)  roadTo 

Initializes a direction object with the specified parameters.

Parameters
typeDirection type;
roadFrom@nonnull Information on the road from which the direction is leading;
roadTo@nonnull Information on the road to which the direction is leading;

◆ initWithType:roadFrom:roadTo:roundaboutAngle:roundaboutExitNumber:motorwayExitNumber:distanceFromPreviousDirection:()

- (nullable instancetype) initWithType: (NMDirectionType type
roadFrom: (nonnull NMRoadInfo *)  roadFrom
roadTo: (nonnull NMRoadInfo *)  roadTo
roundaboutAngle: (nullable NSNumber *)  roundaboutAngle
roundaboutExitNumber: (nullable NSNumber *)  roundaboutExitNumber
motorwayExitNumber: (nullable NSString *)  motorwayExitNumber
distanceFromPreviousDirection: (nullable NSNumber *)  distanceFromPreviousDirection 

Initializes a direction object with the specified parameters.

Parameters
typeDirection type;
roadFrom@nonnull Information on the road from which the direction is leading;
roadTo@nonnull Information on the road to which the direction is leading;
roundaboutAngleAngle in degrees between roundabout point of entry and point of exit;
roundaboutExitNumberThe number of a roundabout exit starting from roundabout entry;
motorwayExitNumber@nonnull The number or name of a motorway exit.

◆ NS_UNAVAILABLE() [1/2]

- (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

◆ NS_UNAVAILABLE() [2/2]

+ (nullable instancetype) NS_UNAVAILABLE

Property Documentation

◆ distanceFromPreviousDirection

- (NSNumber*) distanceFromPreviousDirection
readnonatomicstrong

Distance from the previous direction in meters.

◆ motorwayExitNumber

- (NSString*) motorwayExitNumber
readnonatomicstrong

The number or name of a motorway exit.

◆ roadFrom

- (NMRoadInfo*) roadFrom
readnonatomicstrong

Information on the road from which the direction is leading.

◆ roadTo

- (NMRoadInfo*) roadTo
readnonatomicstrong

Information on the road to which the direction is leading.

◆ roundaboutAngle

- (NSNumber*) roundaboutAngle
readnonatomicstrong

Angle in degrees between roundabout point of entry and point of exit.

◆ roundaboutExitNumber

- (NSNumber*) roundaboutExitNumber
readnonatomicstrong

The number of a roundabout exit starting from roundabout entry.

◆ type

- (NMDirectionType) type
readnonatomicassign

Direction type.