SITRouteStep Class Reference

Inherits from NSObject
Declared in SITRouteStep.h

Overview

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

  index

Unique integer identifier of the step.

@property (nonatomic) NSInteger index

Discussion

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

Declared In

SITRouteStep.h

  from

Start point of the step

@property (nonatomic, strong) SITPoint *from

Declared In

SITRouteStep.h

  to

End point of the step

@property (nonatomic, strong) SITPoint *to

Declared In

SITRouteStep.h

  isFirst

Indicates if this is the first step of the route

@property (nonatomic) BOOL isFirst

Declared In

SITRouteStep.h

  isLast

Indicates if this is the last step of the route

@property (nonatomic) BOOL isLast

Declared In

SITRouteStep.h

  nextStepIndex

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

@property (nonatomic) NSInteger nextStepIndex

Declared In

SITRouteStep.h

– stepDistance

Distance between from and to.

- (float)stepDistance

Return Value

distance in meters between from and to.

Declared In

SITRouteStep.h

– distanceToGoal

Distance to destination.

- (float)distanceToGoal

Return Value

distance between from and the last point of the route.

Declared In

SITRouteStep.h

– distanceToFloorChange

Distance to floor change.

- (NSNumber *)distanceToFloorChange

Return Value

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

Declared In

SITRouteStep.h

– hasNext

Indicates if the route has more steps

- (BOOL)hasNext

Return Value

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

Declared In

SITRouteStep.h

– initWithIndex:from:to:isFirst:isLast:nextStepIndex:stepDistance:distanceToGoal:distanceToFloorChange:

Private method

- (instancetype)initWithIndex:(NSInteger)index from:(SITPoint *)from to:(SITPoint *)to isFirst:(BOOL)isFirst isLast:(BOOL)isLast nextStepIndex:(NSInteger)nextStepIndex stepDistance:(float)stepDistance distanceToGoal:(float)distanceToGoal distanceToFloorChange:(NSNumber *)distanceToFloorChange

Parameters

index

index of the step.

from

origin of the step.

to

destination of the step.

isFirst

indicates if the step is the first of the route.

isLast

indicates if the step is the last of the route.

nextStepIndex

index of the next step of the route (if any).

stepDistance

Distance between from and to.

distanceToGoal

distance between from of the step and destination of the route

distanceToFloorChange

distance to the next floor change

Return Value

SITRouteStep object

Discussion

You should not create instances of this class directly. You you use the ones returned by SITDirectionsManager instead.

Declared In

SITRouteStep.h

– initWithIndex:from:to:isFirst:isLast:nextStepIndex:stepDistance:distanceToGoal:

Private method

- (instancetype)initWithIndex:(NSInteger)index from:(SITPoint *)from to:(SITPoint *)to isFirst:(BOOL)isFirst isLast:(BOOL)isLast nextStepIndex:(NSInteger)nextStepIndex stepDistance:(float)stepDistance distanceToGoal:(float)distanceToGoal

Parameters

index

index of the step.

from

origin of the step.

to

destination of the step.

isFirst

indicates if the step is the first of the route.

isLast

indicates if the step is the last of the route.

nextStepIndex

index of the next step of the route (if any).

stepDistance

Distance between from and to.

distanceToGoal

distance between from of the step and destination of the route

Return Value

SITRouteStep object

Discussion

You should not create instances of this class directly. You you use the ones returned by SITDirectionsManager instead.

Declared In

SITRouteStep.h

– initWithIndex:from:to:isFirst:isLast:nextStepIndex:distanceToGoal:

Private method

- (instancetype)initWithIndex:(NSInteger)index from:(SITPoint *)from to:(SITPoint *)to isFirst:(BOOL)isFirst isLast:(BOOL)isLast nextStepIndex:(NSInteger)nextStepIndex distanceToGoal:(float)distanceToGoal

Parameters

index

index of the step.

from

origin of the step.

to

destination of the step.

isFirst

indicates if the step is the first of the route.

isLast

indicates if the step is the last of the route.

nextStepIndex

index of the next step of the route (if any).

distanceToGoal

distance between from of the step and destination of the route

Return Value

SITRouteStep object

Discussion

You should not create instances of this class directly. You you use the ones returned by SITDirectionsManager instead.

Declared In

SITRouteStep.h

– initWithIndex:from:to:isFirst:isLast:nextStepIndex:distanceToGoal:distanceToFloorChange:

Private method

- (instancetype)initWithIndex:(NSInteger)index from:(SITPoint *)from to:(SITPoint *)to isFirst:(BOOL)isFirst isLast:(BOOL)isLast nextStepIndex:(NSInteger)nextStepIndex distanceToGoal:(float)distanceToGoal distanceToFloorChange:(NSNumber *)distanceToFloorChange

Parameters

index

index of the step.

from

origin of the step.

to

destination of the step.

isFirst

indicates if the step is the first of the route.

isLast

indicates if the step is the last of the route.

nextStepIndex

index of the next step of the route (if any).

distanceToGoal

distance between from of the step and destination of the route

distanceToFloorChange

distance to the next floor change

Return Value

SITRouteStep object

Discussion

You should not create instances of this class directly. You you use the ones returned by SITDirectionsManager instead.

Declared In

SITRouteStep.h