Package com.azure.maps.route.models

Class RouteMatrixOptions

java.lang.Object
com.azure.maps.route.models.RouteMatrixOptions
public class RouteMatrixOptions extends Object
Represents the options for requesting a route matrix.

  • Constructor Details

    • RouteMatrixOptions

      public RouteMatrixOptions(RouteMatrixQuery routeMatrixQuery)
      Constructs a RouteMatrixOptions with the required RouteMatrixQuery parameters.
      Parameters:
      routeMatrixQuery - the RouteMatrixQuery

  • Method Details

    • getRouteMatrixQuery

      public RouteMatrixQuery getRouteMatrixQuery()
      Returns the query matrix used to search for a route.
      Returns:
      the RouteMatrixQuery

    • getWaitForResults

      public Boolean getWaitForResults()
      Boolean to indicate whether to execute the request synchronously.
      Returns:
      waitForResults

    • getComputeTravelTime

      public ComputeTravelTime getComputeTravelTime()
      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.
      Returns:
      the compute travel time option

    • getFilterSectionType

      public SectionType getFilterSectionType()
      Specifies which of the section types is reported in the route response.
      Returns:
      the SectionType

    • getArriveAt

      public OffsetDateTime getArriveAt()
      Returns the arrival time.
      Returns:
      the arrival time.

    • getDepartAt

      public OffsetDateTime getDepartAt()
      Returns the departure time.
      Returns:
      the departure time.

    • getVehicleAxleWeight

      public Integer getVehicleAxleWeight()
      Returns the vehicle axle weight.
      Returns:
      the vehicle axle weight.

    • getVehicleLength

      public Double getVehicleLength()
      Returns the vehicle length.
      Returns:
      the vehicle length.

    • getVehicleHeight

      public Double getVehicleHeight()
      Returns the vehicle height.
      Returns:
      the vehicle height

    • getVehicleWidth

      public Double getVehicleWidth()
      Returns the vehicle width
      Returns:
      the vehicle width

    • getVehicleMaxSpeed

      public Integer getVehicleMaxSpeed()
      Returns the vehicle max speed.
      Returns:
      the vehicle max speed

    • getVehicleWeight

      public Integer getVehicleWeight()
      Returns the vehicle weight.
      Returns:
      the vehicle weight.

    • getWindingness

      public WindingnessLevel getWindingness()
      Returns the windingness level
      Returns:
      the WindingnessLevel

    • getInclineLevel

      public InclineLevel getInclineLevel()
      Returns the incline level InclineLevel
      Returns:
      the InclineLevel

    • getTravelMode

      public TravelMode getTravelMode()
      Returns the travel mode TravelMode
      Returns:
      the TravelMode

    • getAvoid

      public List<RouteAvoidType> getAvoid()
      Returns the list of route types to avoid.
      Returns:
      a list of RouteAvoidType

    • getUseTrafficData

      public Boolean getUseTrafficData()
      Returns whether to use the traffic data
      Returns:
      whether to use the traffic data.

    • getRouteType

      public RouteType getRouteType()
      Returns the RouteType
      Returns:
      the RouteType

    • getVehicleLoadType

      public VehicleLoadType getVehicleLoadType()
      Returns the vehicle load type
      Returns:
      the VehicleLoadType

    • setRouteMatrixQuery

      public RouteMatrixOptions setRouteMatrixQuery(RouteMatrixQuery routeMatrixQuery)
      Sets the RouteMatrixQuery representing the desired route matrix.
      Parameters:
      routeMatrixQuery - the RouteMatrixQuery
      Returns:
      a reference to this RouteMatrixOptions

    • setWaitForResults

      public RouteMatrixOptions setWaitForResults(Boolean waitForResults)
      Wait for the results of the call
      Parameters:
      waitForResults - wait for the results of the call
      Returns:
      a reference to this RouteMatrixOptions

    • setComputeTravelTime

      public RouteMatrixOptions setComputeTravelTime(ComputeTravelTime computeTravelTime)
      Options for computing the travel time.
      Parameters:
      computeTravelTime - the ComputeTravelTime
      Returns:
      a reference to this RouteMatrixOptions

    • setFilterSectionType

      public RouteMatrixOptions setFilterSectionType(SectionType filterSectionType)
      Filter by certain SectionType
      Parameters:
      filterSectionType - the section type
      Returns:
      a reference to this RouteMatrixOptions

    • setArriveAt

      public RouteMatrixOptions setArriveAt(OffsetDateTime arriveAt)
      Sets the arrival time.
      Parameters:
      arriveAt - the arrival time.
      Returns:
      a reference to this RouteMatrixOptions

    • setDepartAt

      public RouteMatrixOptions setDepartAt(OffsetDateTime departAt)
      Sets the departure time.
      Parameters:
      departAt - the departure time.
      Returns:
      a reference to this RouteMatrixOptions

    • setVehicleAxleWeight

      public RouteMatrixOptions setVehicleAxleWeight(Integer vehicleAxleWeight)
      Sets the vehicle axle weight.
      Parameters:
      vehicleAxleWeight - the axle weight.
      Returns:
      a reference to this RouteMatrixOptions

    • setVehicleLength

      public RouteMatrixOptions setVehicleLength(Double vehicleLength)
      Sets the vehicle length.
      Parameters:
      vehicleLength - the vehicle length.
      Returns:
      a reference to this RouteMatrixOptions

    • setVehicleHeight

      public RouteMatrixOptions setVehicleHeight(Double vehicleHeight)
      Sets the vehicle height.
      Parameters:
      vehicleHeight - the vehicle height.
      Returns:
      a reference to this RouteMatrixOptions

    • setVehicleWidth

      public RouteMatrixOptions setVehicleWidth(Double vehicleWidth)
      Sets the vehicle width.
      Parameters:
      vehicleWidth - the vehicle width.
      Returns:
      a reference to this RouteMatrixOptions

    • setVehicleMaxSpeed

      public RouteMatrixOptions setVehicleMaxSpeed(Integer vehicleMaxSpeed)
      Sets the vehicle max speed.
      Parameters:
      vehicleMaxSpeed - the max speed.
      Returns:
      a reference to this RouteMatrixOptions

    • setVehicleWeight

      public RouteMatrixOptions setVehicleWeight(Integer vehicleWeight)
      Sets the vehicle weight.
      Parameters:
      vehicleWeight - the vehicle weight.
      Returns:
      a reference to this RouteMatrixOptions

    • setWindingness

      public RouteMatrixOptions setWindingness(WindingnessLevel windingness)
      Sets the windingness level Windingness
      Parameters:
      windingness - the windingness level
      Returns:
      a reference to this RouteMatrixOptions

    • setInclineLevel

      public RouteMatrixOptions setInclineLevel(InclineLevel inclineLevel)
      Sets the incline level InclineLevel
      Parameters:
      inclineLevel - the incline level.
      Returns:
      a reference to this RouteMatrixOptions

    • setTravelMode

      public RouteMatrixOptions setTravelMode(TravelMode travelMode)
      Sets the travel mode TravelMode
      Parameters:
      travelMode - the travel mode.
      Returns:
      a reference to this RouteMatrixOptions

    • setAvoid

      public RouteMatrixOptions setAvoid(List<RouteAvoidType> avoid)
      Avoid certain types of routes.
      Parameters:
      avoid - list of types to avoid.
      Returns:
      a reference to this RouteMatrixOptions

    • setUseTrafficData

      public RouteMatrixOptions setUseTrafficData(Boolean useTrafficData)
      Use traffic data when calculating the range.
      Parameters:
      useTrafficData - use traffic data.
      Returns:
      a reference to this RouteMatrixOptions

    • setRouteType

      public RouteMatrixOptions setRouteType(RouteType routeType)
      Sets the route type RouteType
      Parameters:
      routeType - the route type.
      Returns:
      a reference to this RouteMatrixOptions

    • setVehicleLoadType

      public RouteMatrixOptions setVehicleLoadType(VehicleLoadType vehicleLoadType)
      Sets the vehicle load type VehicleLoadType
      Parameters:
      vehicleLoadType - the vehicle load type.
      Returns:
      a reference to this RouteMatrixOptions