RouteSpecification Class

  • Article

RouteSpecification Class

Contains all the information necessary to describe a route, including the array of route segments that make up a route, the data source, the driver profile, and an indication of whether driving directions and the calculated route representation (used for rendering a highlighted route on a map) should be included in a route.


Public Class RouteSpecification Inherits System.Object



[C#]

public class RouteSpecification : System.Object

Public Properties

Name Description
public propertyDataSourceName

A string representing the name of the data source (DataSource object) in which the route is located. Required.
public propertyDriverProfile

The time to start and end driving each day (DriverProfile object).
public propertyResultMask

Indicates, as a RouteResultMask enumeration, whether a returned route should include driving directions, a calculated route representation, or both.
public propertySegments

The specification of each segment that makes up the route as an array of SegmentSpecification[] objects. The order of the array is the order of the stops on the route. Required.

Remarks

  • The RouteSpecification object is passed in the specification parameter of the RouteServiceSoap.CalculateRoute method.

  • The RouteSpecification object is passed in the Route.Specification property as input to the RenderServiceSoap.GetMap method. In this case, the DriverProfile and ResultMask properties are ignored.

  • The RouteSpecification object is returned from the RouteServiceSoap.CalculateRoute and RouteServiceSoap.CalculateSimpleRoute methods in the Route.Specification property.

  • On output from the RouteServiceSoap.CalculateSimpleRoute method, the DriverProfile and ResultMask properties contain the default values.

See Also

  DataSource Class   |   DriverProfile Class   |   RouteResultMask Enumeration   |   RouteServiceSoap Class   |   Route.Specification Property