com.esri.core.tasks.ags.na
Class NATaskParameters

java.lang.Object
  com.esri.core.tasks.ags.na.NATaskParameters

Direct Known Subclasses:

ClosestFacilityTaskParameters, RoutingTaskParameters, ServiceAreaTaskParameters

public abstract class NATaskParameters
extends Object

Constructor Summary

NATaskParameters()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NATaskParameters

public NATaskParameters()

Method Detail

getPointBarriers

public abstract NAFeatures getPointBarriers()

Returns the point barriers to avoid while solving

Returns:

the point barriers to avoid while solving

setPointBarriers

public abstract void setPointBarriers(NAFeatures barriers)

Sets the point barriers to avoid while solving

Parameters:

barriers - the point barriers to avoid while solving

getPolylineBarriers

public abstract NAFeatures getPolylineBarriers()

Returns the polyline barriers to avoid while solving

Returns:

polylineBarriers the polyline barriers to avoid while solving

setPolylineBarriers

public abstract void setPolylineBarriers(NAFeatures polylineBarriers)

Sets the polyline barriers to avoid while solving

Parameters:

polylineBarriers - the polyline barriers to avoid while solving

getPolygonBarriers

public abstract NAFeatures getPolygonBarriers()

Returns the polygon barriers to avoid while solving

Returns:

polygonBarriers the polygon barriers to avoid while solving

setPolygonBarriers

public abstract void setPolygonBarriers(NAFeatures polygonBarriers)

Sets the polygon barriers to avoid while solving

Parameters:

polygonBarriers - the polygon barriers to avoid while solving

getAttributeParameterValues

public abstract AttributeParameterValue[] getAttributeParameterValues()

Returns the list of attribute parameter values

Returns:

attributeParameterValues the list of attribute parameter values

setAttributeParameterValues

public abstract void setAttributeParameterValues(AttributeParameterValue[] attributeParameterValues)

Sets the list of attribute parameter values

Parameters:

attributeParameterValues - the list of attribute parameter values

isReturnPointBarriers

public abstract boolean isReturnPointBarriers()

Gets whether or not to return point barriers

Returns:

true if point barriers should be returned

setReturnPointBarriers

public abstract void setReturnPointBarriers(boolean returnPointBarriers)

Sets whether or not to return point barriers

Parameters:

returnPointBarriers - true if point barriers should be returned

isReturnPolylineBarriers

public abstract boolean isReturnPolylineBarriers()

Gets whether or not to return polyline barriers

Returns:

true if polyline barriers should be returned

setReturnPolylineBarriers

public abstract void setReturnPolylineBarriers(boolean returnPolylineBarriers)

Sets whether or not to return polyline barriers

Parameters:

returnPolylineBarriers - true if polyline barriers should be returned

isReturnPolygonBarriers

public abstract boolean isReturnPolygonBarriers()

Gets whether or not to return polygon barriers

Returns:

true if polygon barriers should be returned

setReturnPolygonBarriers

public abstract void setReturnPolygonBarriers(boolean returnPolygonBarriers)

Sets whether or not to return polygon barriers

Parameters:

returnPolygonBarriers - true if polygon barriers should be returned

getOutSpatialReference

public abstract SpatialReference getOutSpatialReference()

Returns the spatial reference of the output geometry

Returns:

the spatial reference of the output geometry

setOutSpatialReference

public abstract void setOutSpatialReference(SpatialReference outSpatialReference)

Sets the spatial reference of the output geometry

Parameters:

outSpatialReference - the spatial reference of the output geometry

getOutputLines

public abstract NAOutputLine getOutputLines()

Gets the type of output lines of the route

Returns:

the type of lines that the route outputs

setOutputLines

public abstract void setOutputLines(NAOutputLine outputLines)

Sets the type of output lines of the route

Parameters:

outputLines - the type of lines that the route outputs

getAccumulateAttributeNames

public abstract String[] getAccumulateAttributeNames()

Returns the list of accumulate attribute names

Returns:

the list of accumulate attribute names

setAccumulateAttributeNames

public abstract void setAccumulateAttributeNames(String[] accumulateAttributeNames)

Sets the list of accumulate attribute names

Parameters:

accumulateAttributeNames - the list of accumulate attribute names

getImpedanceAttributeName

public abstract String getImpedanceAttributeName()

Returns the name of the impedance attribute to use

Returns:

the name of the impedance attribute to use

setImpedanceAttributeName

public abstract void setImpedanceAttributeName(String impedanceAttributeName)

Sets the name of the impedance attribute to use

Parameters:

impedanceAttributeName - the name of the impedance attribute to use

getRestrictionAttributeNames

public abstract String[] getRestrictionAttributeNames()

Returns the list of restriction attribute names

Returns:

the list of restriction attribute names

setRestrictionAttributeNames

public abstract void setRestrictionAttributeNames(String[] restrictionAttributeNames)

Sets the list of restriction attribute names

Parameters:

restrictionAttributeNames - the list of restriction attribute names

getRestrictUTurns

public abstract UTurnRestriction getRestrictUTurns()

Returns the type of U turn restriction to use

Returns:

the type of U turn restriction to use

setRestrictUTurns

public abstract void setRestrictUTurns(UTurnRestriction restrictUTurns)

Sets the type of U turn restriction to use

Parameters:

restrictUTurns - the type of U turn restriction to use

getUseHierarchy

public abstract Boolean getUseHierarchy()

Gets whether or not to use hierarchy

Returns:

true to use hierarchy

setUseHierarchy

public abstract void setUseHierarchy(Boolean useHierarchy)

Sets whether or not to use hierarchy

Parameters:

useHierarchy - true to use hierarchy

getOutputGeometryPrecision

public abstract Double getOutputGeometryPrecision()

Returns the precision value of the output geometry

Returns:

the precision value of the output geometry

setOutputGeometryPrecision

public abstract void setOutputGeometryPrecision(Double outputGeometryPrecision)

Sets the precision value of the output geometry

Parameters:

outputGeometryPrecision - the precision value of the output geometry

getOutputGeometryPrecisionUnits

public abstract Unit.EsriUnit getOutputGeometryPrecisionUnits()

Returns the unit of the output geometry precision

Returns:

the unit of the output geometry precision

setOutputGeometryPrecisionUnits

public abstract void setOutputGeometryPrecisionUnits(Unit.EsriUnit outputGeometryPrecisionUnit)

Sets the unit of the output geometry precision

Parameters:

outputGeometryPrecisionUnit - the unit of the output geometry precision

isReturnZ

public abstract boolean isReturnZ()

Gets whether or not to return z values

Returns:

true to return z values

setReturnZ

public abstract void setReturnZ(boolean returnZ)

Sets whether or not to return z values

Parameters:

returnZ - true to return z values