SITRouteStep

Objective-C

@interface SITRouteStep : NSObject <SITMapperProtocol>

Swift

class SITRouteStep : NSObject, SITMapperProtocol

A fragment of a route, described by an initial SITPoint (from) and a destination SITPoint (to). It also includes additional information about the fragment.

Properties

  • Unique integer identifier of the step.

    Note

    it is unique between the steps of a particular route, not between different routes.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger index;

    Swift

    var index: Int { get set }

  • Start point of the step

    Declaration

    Objective-C

    @property (nonatomic, strong) SITPoint *_Nonnull from;

    Swift

    var from: SITPoint { get set }
  • to

    End point of the step

    Declaration

    Objective-C

    @property (nonatomic, strong) SITPoint *_Nonnull to;

    Swift

    var to: SITPoint { get set }

  • Indicates if this is the first step of the route

    Declaration

    Objective-C

    @property (nonatomic) BOOL isFirst;

    Swift

    var isFirst: Bool { get set }

  • Indicates if this is the last step of the route

    Declaration

    Objective-C

    @property (nonatomic) BOOL isLast;

    Swift

    var isLast: Bool { get set }

  • Integer identifier of the next step of the route (if any)

    Declaration

    Objective-C

    @property (nonatomic) NSInteger nextStepIndex;

    Swift

    var nextStepIndex: Int { get set }

Methods

  • Distance between from and to.

    Declaration

    Objective-C

    - (float)stepDistance;

    Swift

    func stepDistance() -> Float

    Return Value

    distance in meters between from and to.

  • Distance to destination.

    Declaration

    Objective-C

    - (float)distanceToGoal;

    Swift

    func distanceToGoal() -> Float

    Return Value

    distance between from and the last point of the route.

  • Distance to floor change.

    Declaration

    Objective-C

    - (NSNumber *_Nullable)distanceToFloorChange;

    Swift

    func distanceToFloorChange() -> NSNumber?

    Return Value

    distance between from and the next floor change of the route.

  • Indicates if the route has more steps

    Declaration

    Objective-C

    - (BOOL)hasNext;

    Swift

    func hasNext() -> Bool

    Return Value

    BOOL value that indicates if the route has more steps (YES) or not (NO)

  • Indicates if the step implies to go to another floot

    Declaration

    Objective-C

    - (BOOL)hasFloorChange;

    Swift

    func hasFloorChange() -> Bool

    Return Value

    BOOL value that indicates if the user need to change floor (YES) or not (NO)