sdk-routing / com.tomtom.online.sdk.routing.data

Package com.tomtom.online.sdk.routing.data

Types

AdrTunnelRestrictionCode

class AdrTunnelRestrictionCode

Specifies if the vehicle should be subjected to ADR tunnel restrictions.

AlternativeType

class AlternativeType

Represents the 'alternativeType' parameter in a Request to the Routing API.

Avoid

class Avoid

Represents the 'routeAvoids' parameter in a Request to the Routing API.

Cause

open class Cause : Serializable

The cause of the traffic event.

EffectiveSetting

open class EffectiveSetting : Serializable

The effective setting. It reports the effective parameters or data used when calling the API.

FullRoute

open class FullRoute : MatchingDataProvider, Serializable

A description of a route comprised of a list of legs.

Hilliness

class Hilliness

Represents the 'hilliness' parameter in a Request to the Routing API.

Instruction

open class Instruction : Serializable

A set of attributes describing a maneuver, e.g., 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.

InstructionGroup

open class InstructionGroup : Serializable

This groups a sequence of instruction elements which are related to each other.

InstructionsType

class InstructionsType

Represents the 'instructionsType' parameter in a Request to the Routing API.

IRouteQuery

interface IRouteQuery

The interface Route query which specifies the API to construct the query for the Routing API.

OptimizedWaypoint

open class OptimizedWaypoint : Serializable

The optimized waypoint. If the Routing request contains waypoints and the computeBestOrder parameter, the response will include the optimized waypoint indices.

Report

class Report

This represents the 'report' parameter in a Request to the Routing API.

ResultReport

open class ResultReport : Serializable

The Result report.

RouteGuidance

open class RouteGuidance : Serializable

A set of attributes describing the maneuver information of a route.

RouteLeg

open class RouteLeg : Serializable

A description of the part of a route comprised of a list of points.

RouteQuery

open class RouteQuery : CommonRequestQuery

The default implementation of the RouteQuery object which is used to prepare the query for the Routing API.

RouteQueryBuilder

class RouteQueryBuilder : IRouteQuery

The default implementation of the RouteQuery object which is used to prepare the query for the Routing API.

RouteRepresentation

class RouteRepresentation

Represents the 'routeRepresentation' parameter in a Request to the Routing API.

RouteResponse

open class RouteResponse : ServiceBaseResponse, Serializable, BatchableRoutingResponse

The default route planning result representation when querying the Routing API.

RouteSection

open class RouteSection : Serializable

A set of attributes describing route developer properties.

RouteType

class RouteType

This represents the 'routeType' parameter in a Request to the Routing API.

SectionType

class SectionType

This represents the 'sectionType' parameter in a Request to the Routing API.

Summary

open class Summary : Serializable

The route summary. It contains basic information about the route, e.g., length, travel time, etc.

Tec

open class Tec : Serializable

The details of the traffic event.

TravelMode

class TravelMode

Represents the 'travelMode' parameter in a Request to the Routing API.

TravelTimeType

class TravelTimeType

Represents types of traffic information (e.g., none, historic, live).

VehicleEngineType

class VehicleEngineType

Represents the types of the vehicle engine (e.g., electric).

VehicleLoadType

class VehicleLoadType

Represents types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. For more details, see: https://developer.tomtom.com/routing-api/routing-api-documentation-routing/common-routing-parameters.

Windingness

class Windingness

Represents the 'windingness' parameter in a Request to the Routing API.

Exceptions

RoutingException

open class RoutingException : Exception

An exception that occurs with a routing Request.