SITNavigationRequest Class Reference
Inherits from | NSObject |
---|---|
Declared in | SITNavigationRequest.h |
distanceToGoalThreshold
Distance in meters at which will be consider that the user has arrived to the destination of a route
@property (nonatomic) NSInteger distanceToGoalThreshold
Discussion
The minimum value for this parameter is 3 meters and maximum is 15 meters. Default value is 10 meters.
Declared In
SITNavigationRequest.h
outsideRouteThreshold
Distance in meters at which the Navigation Component should consider that the user is outside a route and it’s recommended to recompute a new one.
@property (nonatomic) NSInteger outsideRouteThreshold
Return Value
distance in meters.
Discussion
The minimum value is 3 meters and maximum is 15 meters. Default value is 9 meters.
Declared In
SITNavigationRequest.h
distanceToFloorChangeThreshold
Distance in meters at which will be consider that the user has arrived to a change floor indication
@property (nonatomic) NSInteger distanceToFloorChangeThreshold
Return Value
distance in meters.
Discussion
Default value is 10 meters.
Declared In
SITNavigationRequest.h
distanceToChangeIndicationThreshold
Distance in meters at which will be consider that the user has arrived to the next indication
@property (nonatomic) NSInteger distanceToChangeIndicationThreshold
Return Value
distance in meters.
Discussion
Default value is 5 meters.
Declared In
SITNavigationRequest.h
route
SITRoute object considered to navigate
@property (nonatomic, strong) SITRoute *route
Declared In
SITNavigationRequest.h
indicationsInterval
Time to wait between indications
@property (nonatomic) NSInteger indicationsInterval
Return Value
time in milliseconds
Discussion
Default value is 0 milliseconds, which means a new indication will be returned every time a new position is computed. If the value is different than 0 the indications may not be synchronized with the SITRouteStep in SITNavigationProgress.
Declared In
SITNavigationRequest.h
timeToFirstIndication
Time to wait until the first indication is returned
@property (nonatomic) NSInteger timeToFirstIndication
Return Value
time in milliseconds
Discussion
Default value is 0 milliseconds, which means the first indication will be returned as soon as it is calculated.
Declared In
SITNavigationRequest.h
roundIndicationsStep
The step that will be used to round indications distance.
@property (nonatomic) NSInteger roundIndicationsStep
Return Value
step in meters
Discussion
Default value is 0, which means the indications will not be rounded.
Declared In
SITNavigationRequest.h
– initWithRoute:
Initializes a request to navigate through a route
- (instancetype)initWithRoute:(SITRoute *)route
Parameters
route |
the route (returned by SITDirectionManager) you want to navigate |
---|
Return Value
initialized request
Discussion
this request will have default values for the distanceToGoalThreshold and outsideRouteThreshold.
Declared In
SITNavigationRequest.h
– setDistanceToChangeIndicationThreshold:
Set a threshold within which the next indication will be returned
- (void)setDistanceToChangeIndicationThreshold:(NSInteger)distanceToChangeIndicationThreshold
Parameters
distanceToChangeIndicationThreshold |
distance to change indication threshold |
---|
Declared In
SITNavigationRequest.h
– setDistanceToChangeFloorThreshold:
Set a threshold within which the next change floor indication will be returned
- (void)setDistanceToChangeFloorThreshold:(NSInteger)distanceToChangeFloorThreshold
Parameters
distanceToChangeFloorThreshold |
distance to change floor threshold |
---|
Declared In
SITNavigationRequest.h
– setDistanceToGoalThreshold:
Set a threshold within which the goal change floor indication will be considered as reached
- (void)setDistanceToGoalThreshold:(NSInteger)distanceToGoalThreshold
Parameters
distanceToGoalThreshold |
distance to change goal threshold |
---|
Declared In
SITNavigationRequest.h
– setIndicationsInterval:
Sets indications frequency. By default, indications will be delivered every time a new position is calculated.
- (void)setIndicationsInterval:(NSInteger)millis
Parameters
millis |
desired indications interval in milliseconds. |
---|
Declared In
SITNavigationRequest.h
– setTimeToFirstIndication:
Sets the time to wait before returning the first indication. A value of 5000 or more is recommended when positioning is started along with navigation, in order to provide more accurate and stable indications.
- (void)setTimeToFirstIndication:(NSInteger)millis
Parameters
millis |
desired time to wait before returning the first indication. |
---|
Declared In
SITNavigationRequest.h
– setRoundIndicationsStep:
Sets the step that will be used to round indications distance. For example, with a∫ step of 5, a 13 meters indication will be transformed into a 15 meters indication.
- (void)setRoundIndicationsStep:(NSInteger)meters
Parameters
meters |
desired step for indications distance in meters. |
---|
Declared In
SITNavigationRequest.h