RouteMatrixOptions Class

Initializes a new RouteMatrixOptions instance for mocking.

Initializes a new RouteMatrixOptions instance.

The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with DepartAt, MinDeviationDistance or MinDeviationTime.

Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request. In calculateReachableRange requests, the value alreadyUsedRoads must not be used.

The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00).

Degree of hilliness for thrilling route. This parameter can only be used in conjunction with routeType=thrilling. Allowed values: InclineLevel.Low, InclineLevel.Normal, or InclineLevel.High.

An object with a matrix of coordinates.

The type of route requested. Allowed values: RouteType.Fastest, RouteType.Shortest, RouteType.Economy, or RouteType.Thrilling.

Specifies which of the section types is reported in the route response. For example if sectionType = SectionType.Pedestrian the sections which are suited for pedestrians only are returned. Multiple types can be used. The default sectionType refers to the travelMode input. By default travelMode is set to car. Allowed values: SectionType.CarOrTrain, SectionType.Country, SectionType.Ferry, SectionType.MotorWay, SectionType.Pedestrian, SectionType.TollRoad, SectionType.TollVignette, SectionType.Traffic, SectionType.TravelModel, SectionType.Tunnel, SectionType.Carpool, or SectionType.Urban

The mode of travel for the requested route. If not defined, default is car. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In CalculateReachableRange requests, the values bicycle and pedestrian must not be used. Allowed values: TravelModel.Car, TravelModel.Truck, TravelModel.Taxi, TravelModel.Bus, TravelModel.Van, TravelModel.Motorcycle, TravelModel.Bicycle, or TravelModel.Pedestrian.

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. Allowed values: TravelTimeType.None or TravelTimeType.All.

Possible values:

• true - Do consider all available traffic information during routing
• false - Ignore current traffic data during routing. Note that although the current traffic data is ignored

Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.

Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.

Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.

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/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. VehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. Allowed values: VehicleLoadType.USHazmatClass1, VehicleLoadType.USHazmatClass2, VehicleLoadType.USHazmatClass3, VehicleLoadType.USHazmatClass4, VehicleLoadType.USHazmatClass5, VehicleLoadType.USHazmatClass6, VehicleLoadType.USHazmatClass7, VehicleLoadType.USHazmatClass8, VehicleLoadType.USHazmatClass9, VehicleLoadType.OtherHazmatExplosive, VehicleLoadType.OtherHazmatGeneral, or VehicleLoadType.OtherHazmatHarmfulToWater.

Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.

• A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.
• A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.

Weight of the vehicle in kilograms.

Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.

Level of turns for thrilling route. This parameter can only be used in conjunction with routeType=thrilling. Allowed values: WindingnessLevel.Low, WindingnessLevel.Normal, or WindingnessLevel.High.