SITDirectionsRequest Class Reference
Inherits from | NSObject |
---|---|
Declared in | SITDirectionsRequest.h |
requestID
Identifier of the request. (You should not fill this property, it will be completed automatically for you).
@property (nonatomic, readonly) NSInteger requestID
Declared In
SITDirectionsRequest.h
origin
Initial point of the route (Outdoor points are not allowed for now. Both origin and destination should belong to the same building).
@property (nonatomic, readonly) SITPoint *origin
Declared In
SITDirectionsRequest.h
destination
Destination point of the route (Outdoor points are not allowed for now. Both origin and destination should belong to the same building).
@property (nonatomic, readonly) SITPoint *destination
Declared In
SITDirectionsRequest.h
options
Additional options to be considered when computing a route. You can use the following keys to modify the behaviour of computing a route: key: accessible -> BOOL value that indicates if route has to be suitable for wheel chairs (YES) or not (NO) (this is the default case) key: minimizeFloorChanges -> BOOL value that indicates if the route should have as less floor changes as possible
@property (nonatomic, readonly) NSDictionary *options
Declared In
SITDirectionsRequest.h
– initWithRequestID:location:destination:options:
Constructor. This method is now deprecated, please consider using: - (instancetype) initWithLocation:(SITLocation)location withDestination:(SITPoint)destination;
- (instancetype)initWithRequestID:(NSInteger)requestID location:(SITLocation *)location destination:(SITPoint *)destination options:(NSDictionary *)options
Parameters
requestID |
should be empty (0). |
---|---|
location |
SITLocation object (usually an object provided by SITLocationManager). |
destination |
the end point of the route. |
options |
additional parameters to modify the internal behaviour of the route (see options). |
Return Value
initialized object.
Declared In
SITDirectionsRequest.h
– initWithRequestID:origin:destination:options:
Constructor. This method is now deprecated, please consider using: - (instancetype) initWithOrigin:(SITPoint)origin withDestination:(SITPoint)destination.
- (instancetype)initWithRequestID:(NSInteger)requestID origin:(SITPoint *)origin destination:(SITPoint *)destination options:(NSDictionary *)options
Parameters
requestID |
requestID should be empty (0). |
---|---|
origin |
initial point of the route. |
destination |
the end point of the route. |
options |
additional parameters to modify the internal behaviour of the route (see options). |
Return Value
initialized object.
Declared In
SITDirectionsRequest.h
– initWithLocation:withDestination:
Constructor.
- (instancetype)initWithLocation:(SITLocation *)location withDestination:(SITPoint *)destination
Parameters
location |
SITLocation object (usually an object provided by SITLocationManager). |
---|---|
destination |
the end point of the route. |
Return Value
initialized object.
Declared In
SITDirectionsRequest.h
– initWithOrigin:withDestination:
Constructor.
- (instancetype)initWithOrigin:(SITPoint *)origin withDestination:(SITPoint *)destination
Parameters
origin |
initial point of the route. |
---|---|
destination |
the end point of the route. |
Return Value
initialized object.
Declared In
SITDirectionsRequest.h
– setAccessible:
Setter for the accessible option. This should be used to request an accessible route for handicaped users.
- (void)setAccessible:(BOOL)isAccessible
Parameters
isAccessible |
Boolean indicating if the route should be accessible for all users. |
---|
Declared In
SITDirectionsRequest.h
– setMinimizeFloorChanges:
Setter for the minimize floor changes option. This should be used to request a route with the minimun possible amount of floor changes.
- (void)setMinimizeFloorChanges:(BOOL)minimizeFloorChanges
Parameters
minimizeFloorChanges |
Boolean indicating if the route should minimize the amount of floor changes. |
---|
Declared In
SITDirectionsRequest.h