public class

RoutingParameters

extends NAParameters
java.lang.Object
   ↳ com.esri.core.tasks.ags.na.NAParameters
     ↳ com.esri.core.tasks.ags.na.RoutingParameters

Class Overview

Class holding the parameters of a route to be solved on the server.

In this class, you can define:

  • a set of stops to route between
  • a set of barriers to avoid when routing
  • a set of polyline barriers to avoid when routing
  • a set of polygon barriers to avoid when routing
  • a list of attribute parameter values
  • if the route directions should be returned
  • if the route information should be returned
  • if the route stops should be returned
  • if the route barriers should be returned
  • if the route polyline barriers should be returned
  • if the route polygon barriers should be returned
  • the spatial reference of the returned geometry
  • if invalid locations should be ignored in the routing
  • how the route lines should be output
  • if stops should be reordered for most efficient routing
  • if the first stop should be preserved
  • if the last stop should be preserved
  • if time windows should be used
  • the time at which to start the route
  • a list of accumulate attribute names
  • the name of the impedance attribute
  • a list of the restriction attribute names
  • how to restrict U turns
  • if a hierarchy should be used
  • what language to return the directions in
  • in which style the directions should be output
  • the unit for reporting the length of directions
  • the name of the directions time attribute
  • a precision value for the output geometry
  • a unit for the output geometry precision
  • if z values should be returned

    • Summary

    [Expand]
    Inherited Fields
    From class com.esri.core.tasks.ags.na.NAParameters
    Public Constructors
    RoutingParameters()
    The Constructor.
    Public Methods
    String getDirectionsLanguage()
    Returns the language in which to return the directions.
    DirectionsLengthUnit getDirectionsLengthUnit()
    Returns the Unit type of the length of the directions.
    DirectionsOutputType getDirectionsOutputType()
    Returns the type in which the directions are output.
    String getDirectionsStyleName()
    Returns the name of the style in which to return the directions.
    String getDirectionsTimeAttributeName()
    Returns the name of the directions time attribute.
    Boolean getFindBestSequence()
    Gets whether or not to find the best sequence of stops.
    Boolean getIgnoreInvalidLocations()
    Gets whether or not invalid locations should be ignored.
    Boolean getPreserveFirstStop()
    Gets whether or not to preserve the first stop.
    Boolean getPreserveLastStop()
    Gets whether or not to preserve the last stop.
    Long getStartTime()
    Returns the time to start the routing.
    NAFeatures getStops()
    Returns the stops to route between.
    Boolean getUseTimeWindows()
    Gets whether or not to use time windows.
    boolean isReturnDirections()
    Gets whether or not to return directions.
    boolean isReturnRoutes()
    Gets whether or not to return routes.
    boolean isReturnStops()
    Gets whether or not to return stops.
    void setDirectionsLanguage(String directionsLanguage)
    Sets the language in which to return the directions.
    void setDirectionsLengthUnit(DirectionsLengthUnit directionsLengthUnit)
    Sets the Unit type of the length of the directions.
    void setDirectionsOutputType(DirectionsOutputType directionsOutputType)
    Sets the type in which the directions are output.
    void setDirectionsStyleName(String directionsStyleName)
    Sets the name of the style in which to return the directions.
    void setDirectionsTimeAttributeName(String directionsTimeAttributeName)
    Sets the name of the directions time attribute.
    void setFindBestSequence(Boolean findBestSequence)
    Sets whether or not to find the best sequence of stops.
    void setIgnoreInvalidLocations(Boolean ignoreInvalidLocations)
    Gets whether or not invalid locations should be ignored.
    void setPreserveFirstStop(Boolean preserveFirstStop)
    Sets whether or not to preserve the first stop.
    void setPreserveLastStop(Boolean preserveLastStop)
    Sets whether or not to preserve the last stop.
    void setReturnDirections(boolean returnDirections)
    Sets whether or not to return directions.
    void setReturnRoutes(boolean returnRoutes)
    Sets whether or not to return routes.
    void setReturnStops(boolean returnStops)
    Sets whether or not to return stops.
    void setStartTime(Long startTime)
    Sets the time to start the routing.
    void setStops(NAFeatures stops)
    Sets the stops to route between.
    void setUseTimeWindows(Boolean useTimeWindows)
    Sets whether or not to use time windows.
    [Expand]
    Inherited Methods
    From class com.esri.core.tasks.ags.na.NAParameters
    From class java.lang.Object

    Public Constructors

    public RoutingParameters ()

    The Constructor.

    Public Methods

    public String getDirectionsLanguage ()

    Returns the language in which to return the directions.

    Returns
    • the language in which to return the directions

    public DirectionsLengthUnit getDirectionsLengthUnit ()

    Returns the Unit type of the length of the directions.

    Returns
    • the Unit type of the length of the directions

    public DirectionsOutputType getDirectionsOutputType ()

    Returns the type in which the directions are output.

    Returns
    • the type in which the directions are output

    public String getDirectionsStyleName ()

    Returns the name of the style in which to return the directions.

    Returns
    • the name of the style in which to return the directions

    public String getDirectionsTimeAttributeName ()

    Returns the name of the directions time attribute.

    Returns
    • the name of the directions time attribute

    public Boolean getFindBestSequence ()

    Gets whether or not to find the best sequence of stops.

    Returns
    • true to find the best sequence of stops

    public Boolean getIgnoreInvalidLocations ()

    Gets whether or not invalid locations should be ignored.

    Returns
    • true if invalid locations should be ignored

    public Boolean getPreserveFirstStop ()

    Gets whether or not to preserve the first stop.

    Returns
    • true to preserve the first stop

    public Boolean getPreserveLastStop ()

    Gets whether or not to preserve the last stop.

    Returns
    • true to preserve the last stop

    public Long getStartTime ()

    Returns the time to start the routing.

    Returns
    • the time to start the routing

    public NAFeatures getStops ()

    Returns the stops to route between.

    Returns
    • the stops to route between

    public Boolean getUseTimeWindows ()

    Gets whether or not to use time windows.

    Returns
    • true to use time windows

    public boolean isReturnDirections ()

    Gets whether or not to return directions.

    Returns
    • true if directions should be returned

    public boolean isReturnRoutes ()

    Gets whether or not to return routes.

    Returns
    • true if routes should be returned

    public boolean isReturnStops ()

    Gets whether or not to return stops.

    Returns
    • true if stops should be returned

    public void setDirectionsLanguage (String directionsLanguage)

    Sets the language in which to return the directions.

    Parameters
    directionsLanguage the language in which to return the directions

    public void setDirectionsLengthUnit (DirectionsLengthUnit directionsLengthUnit)

    Sets the Unit type of the length of the directions.

    Parameters
    directionsLengthUnit the Unit type of the length of the directions

    public void setDirectionsOutputType (DirectionsOutputType directionsOutputType)

    Sets the type in which the directions are output.

    Parameters
    directionsOutputType the type in which the directions are output

    public void setDirectionsStyleName (String directionsStyleName)

    Sets the name of the style in which to return the directions.

    Parameters
    directionsStyleName the name of the style in which to return the directions

    public void setDirectionsTimeAttributeName (String directionsTimeAttributeName)

    Sets the name of the directions time attribute.

    Parameters
    directionsTimeAttributeName the name of the directions time attribute

    public void setFindBestSequence (Boolean findBestSequence)

    Sets whether or not to find the best sequence of stops.

    Parameters
    findBestSequence true to find the best sequence of stops

    public void setIgnoreInvalidLocations (Boolean ignoreInvalidLocations)

    Gets whether or not invalid locations should be ignored.

    Parameters
    ignoreInvalidLocations true if invalid locations should be ignored

    public void setPreserveFirstStop (Boolean preserveFirstStop)

    Sets whether or not to preserve the first stop.

    Parameters
    preserveFirstStop true to preserve the first stop

    public void setPreserveLastStop (Boolean preserveLastStop)

    Sets whether or not to preserve the last stop.

    Parameters
    preserveLastStop true to preserve the last stop

    public void setReturnDirections (boolean returnDirections)

    Sets whether or not to return directions.

    Parameters
    returnDirections true if directions should be returned

    public void setReturnRoutes (boolean returnRoutes)

    Sets whether or not to return routes.

    Parameters
    returnRoutes true if routes should be returned

    public void setReturnStops (boolean returnStops)

    Sets whether or not to return stops.

    Parameters
    returnStops true if stops should be returned

    public void setStartTime (Long startTime)

    Sets the time to start the routing.

    Parameters
    startTime the time to start the routing

    public void setStops (NAFeatures stops)

    Sets the stops to route between.

    Parameters
    stops the stops to route between

    public void setUseTimeWindows (Boolean useTimeWindows)

    Sets whether or not to use time windows.

    Parameters
    useTimeWindows true to use time windows