TTRouteQueryBuilder Class Reference

Inherits from TTCommonQueryBuilder
Conforms to *
TTRouteQueryBuilder
Declared in TTRouteQuery.h

Overview

Class TTRouteQueryBuilder builds a query, using parameters.

+ createWithDest:andOrig:

The map coordinate whose geographical information your destination position.

+ (TTRouteQueryBuilder *_Nonnull)createWithDest:(CLLocationCoordinate2D)destPosition andOrig:(CLLocationCoordinate2D)origPosition

Parameters

destPosition

The map coordinate whose geographical information your destination position.

origPosition

The map coordinate whose geographical information your start position.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withInstructionsType:

Guidance instructions will be returned

- (TTRouteQueryBuilder *_Nonnull)withInstructionsType:(TTOptionInstructionsType)instructionsType

Parameters

instructionsType

Guidance instructions will be returned

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withLanguage:

The language parameter determines the language of the guidance messages.

- (TTRouteQueryBuilder *_Nonnull)withLanguage:(TTLanguage)language

Parameters

language

The language parameter determines the language of the guidance messages.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withArriveAt:

The date and time of arrival at the destination point.

- (TTRouteQueryBuilder *_Nonnull)withArriveAt:(NSDate *_Nonnull)arriveAt

Parameters

arriveAt

The date and time of arrival at the destination point.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withMaxAlternatives:

Number of desired alternative routes to be calculated.

- (TTRouteQueryBuilder *_Nonnull)withMaxAlternatives:(NSUInteger)maxAlternatives

Parameters

maxAlternatives

Number of desired alternative routes to be calculated.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withComputeBestOrder:

The maximum allowed number of waypoints is 50, reduced to 20

- (TTRouteQueryBuilder *_Nonnull)withComputeBestOrder:(BOOL)isComputeBestOrder

Parameters

isComputeBestOrder

The maximum allowed number of waypoints is 50, reduced to 20

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withRouteRepresentation:

Specifies the representation of the set of routes provided as response.

- (TTRouteQueryBuilder *_Nonnull)withRouteRepresentation:(NSString *_Nonnull)routeRepresentation

Parameters

routeRepresentation

Specifies the representation of the set of routes provided as response.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withComputeTravelTimeFor:

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

- (TTRouteQueryBuilder *_Nonnull)withComputeTravelTimeFor:(NSString *_Nonnull)computeTravelTimeFor

Parameters

computeTravelTimeFor

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withVehicleHeading:

The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction.

- (TTRouteQueryBuilder *_Nonnull)withVehicleHeading:(NSUInteger)vehicleHeading

Parameters

vehicleHeading

The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withMinDeviationDistance:

All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt.

- (TTRouteQueryBuilder *_Nonnull)withMinDeviationDistance:(NSUInteger)minDeviationDistance

Parameters

minDeviationDistance

All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withMinDeviationTime:

All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt.

- (TTRouteQueryBuilder *_Nonnull)withMinDeviationTime:(NSUInteger)minDeviationTime

Parameters

minDeviationTime

All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withSectionType:

Specifies which of the section types is reported in the route response.

- (TTRouteQueryBuilder *_Nonnull)withSectionType:(TTSectionType)sectionType

Parameters

sectionType

Specifies which of the section types is reported in the route response.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– withSupportingPoints:

A list of base route points to be used as input for route reconstruction.

- (TTRouteQueryBuilder *_Nonnull)withSupportingPoints:(NSMutableArray<NSValue*> *_Nonnull)supportingPoints

Parameters

supportingPoints

A list of base route points to be used as input for route reconstruction.

Return Value

TTRouteQueryBuilder

Declared In

TTRouteQuery.h

– build

- (TTRouteQuery *_Nonnull)build

Return Value

TTRouteQuery

Declared In

TTRouteQuery.h