public abstract class

NAParameters

extends Object
java.lang.Object
   ↳ com.esri.core.tasks.na.NAParameters
Known Direct Subclasses

Class Overview

Abstract class holding the common parameters of a network analysis problem

In this class, you can define:

  • a set of point barriers to avoid when solving
  • a set of polyline barriers to avoid when solving
  • a set of polygon barriers to avoid when solving
  • a list of attribute parameter values
  • if the point barriers should be returned
  • if the polyline barriers should be returned
  • if the 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
  • a precision value for the output geometry
  • a unit for the output geometry precision
  • if z values should be returned
  • Summary

    Fields
    protected NATaskParametersInternal _params
    Public Constructors
    NAParameters()
    Public Methods
    boolean equals(Object obj)
    String[] getAccumulateAttributeNames()
    Returns the list of accumulate attribute names.
    AttributeParameterValue[] getAttributeParameterValues()
    Returns the list of attribute parameter values.
    String getImpedanceAttributeName()
    Returns the name of the impedance attribute to use.
    SpatialReference getOutSpatialReference()
    Returns the spatial reference of the output geometry.
    Double getOutputGeometryPrecision()
    Returns the precision value of the output geometry.
    Unit.EsriUnit getOutputGeometryPrecisionUnits()
    Returns the unit of the output geometry precision.
    NAOutputLine getOutputLines()
    Gets the type of output lines of the route.
    NAFeatures getPointBarriers()
    Returns the point barriers to avoid while solving.
    NAFeatures getPolygonBarriers()
    Returns the polygon barriers to avoid while solving.
    NAFeatures getPolylineBarriers()
    Returns the point barriers to avoid while solving.
    UTurnRestriction getRestrictUTurns()
    Returns the type of U turn restriction to use.
    String[] getRestrictionAttributeNames()
    Returns the list of restriction attribute names.
    Boolean getUseHierarchy()
    Gets whether or not to use hierarchy.
    int hashCode()
    boolean isReturnPointBarriers()
    Gets whether or not to return barriers.
    boolean isReturnPolygonBarriers()
    Gets whether or not to return polygon barriers.
    boolean isReturnPolylineBarriers()
    Gets whether or not to return polyline barriers.
    boolean isReturnZ()
    Gets whether or not to return z values.
    void setAccumulateAttributeNames(String[] accumulateAttributeNames)
    Sets the list of accumulate attribute names.
    void setAttributeParameterValues(AttributeParameterValue[] attributeParameterValues)
    Sets the list of attribute parameter values.
    void setImpedanceAttributeName(String impedanceAttributeName)
    Sets the name of the impedance attribute to use.
    void setOutSpatialReference(SpatialReference outSpatialReference)
    Sets the spatial reference of the output geometry.
    void setOutputGeometryPrecision(Double outputGeometryPrecision)
    Sets the precision value of the output geometry.
    void setOutputGeometryPrecisionUnits(Unit.EsriUnit outputGeometryPrecisionUnits)
    Sets the unit of the output geometry precision.
    void setOutputLines(NAOutputLine outputLines)
    Sets the type of output lines of the route.
    void setPointBarriers(NAFeatures pointBarriers)
    Sets the point barriers to avoid while solving.
    void setPolygonBarriers(NAFeatures polygonBarriers)
    Sets the polygon barriers to avoid while solving.
    void setPolylineBarriers(NAFeatures polylineBarriers)
    Sets the polyline barriers to avoid while solving.
    void setRestrictUTurns(UTurnRestriction restrictUTurns)
    Sets the type of U turn restriction to use.
    void setRestrictionAttributeNames(String[] restrictionAttributeNames)
    Sets the list of restriction attribute names.
    void setReturnPointBarriers(boolean returnBarriers)
    Sets whether or not to return barriers.
    void setReturnPolygonBarriers(boolean returnPolygonBarriers)
    Sets whether or not to return polygon barriers.
    void setReturnPolylineBarriers(boolean returnPolylineBarriers)
    Sets whether or not to return polyline barriers.
    void setReturnZ(boolean returnZ)
    Sets whether or not to return z values.
    void setUseHierarchy(Boolean useHierarchy)
    Sets whether or not to use hierarchy.
    [Expand]
    Inherited Methods
    From class java.lang.Object

    Fields

    protected NATaskParametersInternal _params

    Public Constructors

    public NAParameters ()

    Public Methods

    public boolean equals (Object obj)

    Parameters
    obj Object
    Returns
    boolean

    public String[] getAccumulateAttributeNames ()

    Returns the list of accumulate attribute names.

    Returns
    String[] the list of accumulate attribute names

    public AttributeParameterValue[] getAttributeParameterValues ()

    Returns the list of attribute parameter values.

    Returns
    AttributeParameterValue[] attributeParameterValues the list of attribute parameter values

    public String getImpedanceAttributeName ()

    Returns the name of the impedance attribute to use.

    Returns
    String the name of the impedance attribute to use

    public SpatialReference getOutSpatialReference ()

    Returns the spatial reference of the output geometry.

    Returns
    SpatialReference the spatial reference of the output geometry

    public Double getOutputGeometryPrecision ()

    Returns the precision value of the output geometry.

    Returns
    Double the precision value of the output geometry

    public Unit.EsriUnit getOutputGeometryPrecisionUnits ()

    Returns the unit of the output geometry precision.

    Returns
    Unit.EsriUnit the unit of the output geometry precision

    public NAOutputLine getOutputLines ()

    Gets the type of output lines of the route.

    Returns
    NAOutputLine the type of lines that the route outputs

    public NAFeatures getPointBarriers ()

    Returns the point barriers to avoid while solving.

    Returns
    NAFeatures the pointBarriers to avoid while solving

    public NAFeatures getPolygonBarriers ()

    Returns the polygon barriers to avoid while solving.

    Returns
    NAFeatures the polygonBarriers to avoid while solving

    public NAFeatures getPolylineBarriers ()

    Returns the point barriers to avoid while solving.

    Returns
    NAFeatures the pointBarriers to avoid while solving

    public UTurnRestriction getRestrictUTurns ()

    Returns the type of U turn restriction to use.

    Returns
    UTurnRestriction the type of U turn restriction to use

    public String[] getRestrictionAttributeNames ()

    Returns the list of restriction attribute names.

    Returns
    String[] the list of restriction attribute names

    public Boolean getUseHierarchy ()

    Gets whether or not to use hierarchy.

    Returns
    Boolean true to use hierarchy

    public int hashCode ()

    Returns
    int

    public boolean isReturnPointBarriers ()

    Gets whether or not to return barriers.

    Returns
    boolean true if barriers should be returned

    public boolean isReturnPolygonBarriers ()

    Gets whether or not to return polygon barriers.

    Returns
    boolean true if polygon barriers should be returned

    public boolean isReturnPolylineBarriers ()

    Gets whether or not to return polyline barriers.

    Returns
    boolean true if polyline barriers should be returned

    public boolean isReturnZ ()

    Gets whether or not to return z values.

    Returns
    boolean true to return z values

    public void setAccumulateAttributeNames (String[] accumulateAttributeNames)

    Sets the list of accumulate attribute names.

    Parameters
    accumulateAttributeNames String: the list of accumulate attribute names

    public void setAttributeParameterValues (AttributeParameterValue[] attributeParameterValues)

    Sets the list of attribute parameter values.

    Parameters
    attributeParameterValues AttributeParameterValue: the list of attribute parameter values

    public void setImpedanceAttributeName (String impedanceAttributeName)

    Sets the name of the impedance attribute to use.

    Parameters
    impedanceAttributeName String: the name of the impedance attribute to use

    public void setOutSpatialReference (SpatialReference outSpatialReference)

    Sets the spatial reference of the output geometry.

    Parameters
    outSpatialReference SpatialReference: the spatial reference of the output geometry

    public void setOutputGeometryPrecision (Double outputGeometryPrecision)

    Sets the precision value of the output geometry.

    Parameters
    outputGeometryPrecision Double: the precision value of the output geometry

    public void setOutputGeometryPrecisionUnits (Unit.EsriUnit outputGeometryPrecisionUnits)

    Sets the unit of the output geometry precision.

    Parameters
    outputGeometryPrecisionUnits Unit.EsriUnit: the units of the output geometry precision

    public void setOutputLines (NAOutputLine outputLines)

    Sets the type of output lines of the route.

    Parameters
    outputLines NAOutputLine: the type of lines that the route outputs

    public void setPointBarriers (NAFeatures pointBarriers)

    Sets the point barriers to avoid while solving.

    Parameters
    pointBarriers NAFeatures: the point barriers to avoid while solving

    public void setPolygonBarriers (NAFeatures polygonBarriers)

    Sets the polygon barriers to avoid while solving.

    Parameters
    polygonBarriers NAFeatures: the polygon barriers to avoid while solving

    public void setPolylineBarriers (NAFeatures polylineBarriers)

    Sets the polyline barriers to avoid while solving.

    Parameters
    polylineBarriers NAFeatures: the polyline barriers to avoid while solving

    public void setRestrictUTurns (UTurnRestriction restrictUTurns)

    Sets the type of U turn restriction to use.

    Parameters
    restrictUTurns UTurnRestriction: the type of U turn restriction to use

    public void setRestrictionAttributeNames (String[] restrictionAttributeNames)

    Sets the list of restriction attribute names.

    Parameters
    restrictionAttributeNames String: the list of restriction attribute names

    public void setReturnPointBarriers (boolean returnBarriers)

    Sets whether or not to return barriers.

    Parameters
    returnBarriers boolean: true if barriers should be returned

    public void setReturnPolygonBarriers (boolean returnPolygonBarriers)

    Sets whether or not to return polygon barriers.

    Parameters
    returnPolygonBarriers boolean: true if polygon barriers should be returned

    public void setReturnPolylineBarriers (boolean returnPolylineBarriers)

    Sets whether or not to return polyline barriers.

    Parameters
    returnPolylineBarriers boolean: true if polyline barriers should be returned

    public void setReturnZ (boolean returnZ)

    Sets whether or not to return z values.

    Parameters
    returnZ boolean: true to return z values

    public void setUseHierarchy (Boolean useHierarchy)

    Sets whether or not to use hierarchy.

    Parameters
    useHierarchy Boolean: true to use hierarchy