com.esri.arcgis.networkanalyst
Interface INAServerServiceAreaParams2

All Superinterfaces:

INAServerServiceAreaParams, INAServerSolverParams, Serializable

All Known Implementing Classes:

NAServerServiceAreaParams

public interface INAServerServiceAreaParams2
extends INAServerServiceAreaParams, Serializable

Deprecated as of 10.0. Provides access to properties that specify the route solver settings and return parameters used during network analysis with NAServer.

Remarks

At version 10.1, ArcGIS for Server no longer supports performing network analysis via local connections using the GISServer and GISClient APIs. Use the SOAP or REST API instead.

INAServerServiceAreaParams provides methods to set input parameters on an NAServerServiceAreaParams object that is then used by the Solve method on INAServer to perform service area network analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

INAServerLocations	getPolygonBarriers() RecordSet or array of PropertySets representing polygon Barriers loaded as network locations during analysis.
INAServerLocations	getPolylineBarriers() RecordSet or array of PropertySets representing polyline Barriers loaded as network locations during analysis.
boolean	isReturnPolygonBarriers() Indicates if the output polygon barriers recordset should be returned with the analysis results.
boolean	isReturnPolylineBarriers() Indicates if the output polyline barriers recordset should be returned with the analysis results.
void	setPolygonBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing polygon Barriers loaded as network locations during analysis.
void	setPolylineBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing polyline Barriers loaded as network locations during analysis.
void	setReturnPolygonBarriers(boolean returnBarriers) Indicates if the output polygon barriers recordset should be returned with the analysis results.
void	setReturnPolylineBarriers(boolean returnBarriers) Indicates if the output polyline barriers recordset should be returned with the analysis results.

Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerServiceAreaParams

getBarriers, getFacilities, isReturnBarriers, isReturnFacilities, isReturnSALineGeometries, isReturnSALines, isReturnSAPolygonGeometries, isReturnSAPolygons, setBarriersByRef, setFacilitiesByRef, setReturnBarriers, setReturnFacilities, setReturnSALineGeometries, setReturnSALines, setReturnSAPolygonGeometries, setReturnSAPolygons

Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverParams

getImageDescription, getMapDescription, getMaxSnapTolerance, getNAClassCandidateFieldMaps, getNALayerName, getOutputSpatialReference, getSnapTolerance, getSnapToleranceUnits, isReturnMap, setImageDescriptionByRef, setMapDescriptionByRef, setMaxSnapTolerance, setNAClassCandidateFieldMaps, setNALayerName, setOutputSpatialReferenceByRef, setReturnMap, setSnapTolerance, setSnapToleranceUnits

Method Detail

setPolylineBarriersByRef

void setPolylineBarriersByRef(INAServerLocations barriers)
                              throws IOException,
                                     AutomationException

RecordSet or array of PropertySets representing polyline Barriers loaded as network locations during analysis.

Remarks

PolylineBarriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements when solving a Service Area problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

barriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolylineBarriers

INAServerLocations getPolylineBarriers()
                                       throws IOException,
                                              AutomationException

RecordSet or array of PropertySets representing polyline Barriers loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolygonBarriersByRef

void setPolygonBarriersByRef(INAServerLocations barriers)
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing polygon Barriers loaded as network locations during analysis.

Remarks

PolygonBarriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements when solving a Service Area problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

barriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolygonBarriers

INAServerLocations getPolygonBarriers()
                                      throws IOException,
                                             AutomationException

RecordSet or array of PropertySets representing polygon Barriers loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnPolylineBarriers

void setReturnPolylineBarriers(boolean returnBarriers)
                               throws IOException,
                                      AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Remarks

ReturnPolylineBarriers specifies if the PolylineBarriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnPolylineBarriers

boolean isReturnPolylineBarriers()
                                 throws IOException,
                                        AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Remarks

ReturnPolylineBarriers specifies if the PolylineBarriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnPolygonBarriers

void setReturnPolygonBarriers(boolean returnBarriers)
                              throws IOException,
                                     AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Remarks

ReturnPolygonBarriers specifies if the PolygonBarriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnPolygonBarriers

boolean isReturnPolygonBarriers()
                                throws IOException,
                                       AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Remarks

ReturnPolygonBarriers specifies if the PolygonBarriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.