public class

ClosestFacilityParameters

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

Class Overview

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

In this class, you can define:

  • a set of facilities to choose from
  • a set of incidents to route from
  • a set of point 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 facilities should be returned
  • if the incidents should be returned
  • if the route point 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
  • how the route lines should be output
  • 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
  • the default cutoff to stop traversing
  • the default number of facilities to target
  • travel direction of the facilities (to/from)
  • the time of day at which to solve
  • how that time of day should be used (start/end)
  • 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
  • See also:

    Summary

    [Expand]
    Inherited Fields
    From class com.esri.core.tasks.na.NAParameters
    Public Constructors
    ClosestFacilityParameters()
    Constructor; to obtain a new ClosestFacilityParameters object for a certain service, use getDefaultParameters().
    Public Methods
    Double getDefaultCutoff()
    Gets the default cutoff value to stop traversing.
    Integer getDefaultTargetFacilityCount()
    Gets the default number of target facilities to find.
    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.
    NAFeatures getFacilities()
    Gets the facilities set for the closest facility task.
    NAFeatures getIncidents()
    Gets the incidents used for the closest facility task.
    Long getTimeOfDay()
    Gets what time of day the closest facility should be computed at.
    NATimeOfDayUsage getTimeOfDayUsage()
    Gets how the time of day should be used (start or end).
    NATravelDirection getTravelDirection()
    Gets the travel direction for the closest facility computation (to or from facility).
    boolean isReturnCFRoutes()
    Gets whether or not return routes are to be returned.
    boolean isReturnDirections()
    Gets whether or not turn-by-turn directions for the closest facility routes are to be returned.
    boolean isReturnFacilities()
    Gets whether or not facilities should be returned.
    boolean isReturnIncidents()
    Gets whether or not to return the incidents used in the closest facility task.
    void setDefaultCutoff(Double defaultCutoff)
    Sets the default cutoff value to stop traversing.
    void setDefaultTargetFacilityCount(Integer defaultTargetFacilityCount)
    Sets the default number of target facilities to find.
    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 setFacilities(NAFeatures facilities)
    Sets the facilities for the closest facility task.
    void setIncidents(NAFeatures incidents)
    Sets the incidents used for the closest facility task.
    void setReturnCFRoutes(boolean returnCFRoutes)
    Sets whether or not to return routes.
    void setReturnDirections(boolean returnDirections)
    Sets whether or not to return turn-by-turn directions for the closest facility routes.
    void setReturnFacilities(boolean returnFacilities)
    Sets whether or not facilities should be returned.
    void setReturnIncidents(boolean returnIncidents)
    Sets whether or not to return the incidents used in the closest facility task.
    void setTimeOfDay(Long timeOfDay)
    Sets what time of day the closest facility should be computed at.
    void setTimeOfDayUsage(NATimeOfDayUsage timeOfDayUsage)
    Sets how the time of day should be used (start or end).
    void setTravelDirection(NATravelDirection travelDirection)
    Sets the travel direction for the closest facility computation (to or from facility).
    [Expand]
    Inherited Methods
    From class com.esri.core.tasks.na.NAParameters
    From class java.lang.Object

    Public Constructors

    public ClosestFacilityParameters ()

    Constructor; to obtain a new ClosestFacilityParameters object for a certain service, use getDefaultParameters().

    Public Methods

    public Double getDefaultCutoff ()

    Gets the default cutoff value to stop traversing.

    Returns
    Double the default cutoff value to stop traversing

    public Integer getDefaultTargetFacilityCount ()

    Gets the default number of target facilities to find.

    Returns
    Integer the default number of target facilities to find

    public String getDirectionsLanguage ()

    Returns the language in which to return the directions.

    Returns
    String the language in which to return the directions

    public DirectionsLengthUnit getDirectionsLengthUnit ()

    Returns the unit type of the length of the directions.

    Returns
    DirectionsLengthUnit the unit type of the length of the directions

    public DirectionsOutputType getDirectionsOutputType ()

    Returns the type in which the directions are output.

    Returns
    DirectionsOutputType the type in which the directions are output

    public String getDirectionsStyleName ()

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

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

    public String getDirectionsTimeAttributeName ()

    Returns the name of the directions time attribute.

    Returns
    String the name of the directions time attribute

    public NAFeatures getFacilities ()

    Gets the facilities set for the closest facility task.

    Returns
    NAFeatures facilities the facilities

    public NAFeatures getIncidents ()

    Gets the incidents used for the closest facility task.

    Returns
    NAFeatures the incidents used for the closest facility task

    public Long getTimeOfDay ()

    Gets what time of day the closest facility should be computed at.

    Returns
    Long the time of day the closest facility should be computed at

    public NATimeOfDayUsage getTimeOfDayUsage ()

    Gets how the time of day should be used (start or end).

    Returns
    NATimeOfDayUsage how the time of day should be used

    public NATravelDirection getTravelDirection ()

    Gets the travel direction for the closest facility computation (to or from facility).

    Returns
    NATravelDirection the travel direction for the closest facility computation

    public boolean isReturnCFRoutes ()

    Gets whether or not return routes are to be returned.

    Returns
    boolean true if routes are to be returned

    public boolean isReturnDirections ()

    Gets whether or not turn-by-turn directions for the closest facility routes are to be returned.

    Returns
    boolean true if directions are to be returned

    public boolean isReturnFacilities ()

    Gets whether or not facilities should be returned.

    Returns
    boolean whether or not facilities should be returned

    public boolean isReturnIncidents ()

    Gets whether or not to return the incidents used in the closest facility task.

    Returns
    boolean whether or not to return the incidents

    public void setDefaultCutoff (Double defaultCutoff)

    Sets the default cutoff value to stop traversing.

    Parameters
    defaultCutoff Double: the default cutoff value to stop traversing

    public void setDefaultTargetFacilityCount (Integer defaultTargetFacilityCount)

    Sets the default number of target facilities to find.

    Parameters
    defaultTargetFacilityCount Integer: the default number of target facilities to find

    public void setDirectionsLanguage (String directionsLanguage)

    Sets the language in which to return the directions.

    Parameters
    directionsLanguage String: 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 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 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 String: 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 String: the name of the directions time attribute

    public void setFacilities (NAFeatures facilities)

    Sets the facilities for the closest facility task.

    Parameters
    facilities NAFeatures: the facilities

    public void setIncidents (NAFeatures incidents)

    Sets the incidents used for the closest facility task.

    Parameters
    incidents NAFeatures: the incidents used for the closest facility task

    public void setReturnCFRoutes (boolean returnCFRoutes)

    Sets whether or not to return routes.

    Parameters
    returnCFRoutes boolean: true if routes should be returned

    public void setReturnDirections (boolean returnDirections)

    Sets whether or not to return turn-by-turn directions for the closest facility routes.

    Parameters
    returnDirections boolean: true if directions should be returned

    public void setReturnFacilities (boolean returnFacilities)

    Sets whether or not facilities should be returned.

    Parameters
    returnFacilities boolean: true if facilities should be returned

    public void setReturnIncidents (boolean returnIncidents)

    Sets whether or not to return the incidents used in the closest facility task.

    Parameters
    returnIncidents boolean: true to return the incidents

    public void setTimeOfDay (Long timeOfDay)

    Sets what time of day the closest facility should be computed at.

    Parameters
    timeOfDay Long: the time of day the closest facility should be computed at

    public void setTimeOfDayUsage (NATimeOfDayUsage timeOfDayUsage)

    Sets how the time of day should be used (start or end).

    Parameters
    timeOfDayUsage NATimeOfDayUsage: how the time of day should be used

    public void setTravelDirection (NATravelDirection travelDirection)

    Sets the travel direction for the closest facility computation (to or from facility).

    Parameters
    travelDirection NATravelDirection: the travel direction for the closest facility computation