com.esri.arcgis.networkanalyst
Interface INAServerServiceAreaParams

All Superinterfaces:

INAServerSolverParams, Serializable

All Known Subinterfaces:

INAServerServiceAreaParams2

All Known Implementing Classes:

NAServerServiceAreaParams

public interface INAServerServiceAreaParams
extends INAServerSolverParams, Serializable

Provides access to properties that specify the service area solver settings and return parameters used during network analysis with NAServer.

Remarks

INAServerServiceAreaParams has been superseded by INAServerServiceAreaParams2.

Product Availability

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

Method Summary

INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
INAServerLocations	getFacilities() RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
boolean	isReturnBarriers() Indicates if the output barriers recordset should be returned with the analysis results.
boolean	isReturnFacilities() Indicates if the output facilities recordset should be returned with the analysis results.
boolean	isReturnSALineGeometries() Indicates if the SALine geometries should be generated and returned with the analysis results.
boolean	isReturnSALines() Indicates if the output SALines recordset should be returned with the analysis results.
boolean	isReturnSAPolygonGeometries() Indicates if the SAPolygon geometries should be generated and returned with the analysis results.
boolean	isReturnSAPolygons() Indicates if the output SAPolygons recordset should be returned with the analysis results.
void	setBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	setFacilitiesByRef(INAServerLocations facilities) RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
void	setReturnBarriers(boolean returnBarriers) Indicates if the output barriers recordset should be returned with the analysis results.
void	setReturnFacilities(boolean returnFacilities) Indicates if the output facilities recordset should be returned with the analysis results.
void	setReturnSALineGeometries(boolean returnSALineGeometries) Indicates if the SALine geometries should be generated and returned with the analysis results.
void	setReturnSALines(boolean returnSALines) Indicates if the output SALines recordset should be returned with the analysis results.
void	setReturnSAPolygonGeometries(boolean returnSAPolygonGeometries) Indicates if the SAPolygon geometries should be generated and returned with the analysis results.
void	setReturnSAPolygons(boolean returnSAPolygons) Indicates if the output SAPolygons recordset should be returned with the analysis results.

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

setFacilitiesByRef

void setFacilitiesByRef(INAServerLocations facilities)
                        throws IOException,
                               AutomationException

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

Remarks

Facilities specifies an instance of NAServerLocations class to use as input when solving a service area problem.

Product Availability

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

Parameters:

facilities - 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.

getFacilities

INAServerLocations getFacilities()
                                 throws IOException,
                                        AutomationException

RecordSet or array of PropertySets representing Facilities 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.

setBarriersByRef

void setBarriersByRef(INAServerLocations barriers)
                      throws IOException,
                             AutomationException

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

Remarks

Barriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

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.

getBarriers

INAServerLocations getBarriers()
                               throws IOException,
                                      AutomationException

RecordSet or array of PropertySets representing 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.

setReturnSALineGeometries

void setReturnSALineGeometries(boolean returnSALineGeometries)
                               throws IOException,
                                      AutomationException

Indicates if the SALine geometries should be generated and returned with the analysis results.

Remarks

ReturnSALineGeometries specifies if the resulting SALineGeometries are returned.

Product Availability

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

Parameters:

returnSALineGeometries - The returnSALineGeometries (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnSALineGeometries

boolean isReturnSALineGeometries()
                                 throws IOException,
                                        AutomationException

Indicates if the SALine geometries should be generated and returned with the analysis results.

Product Availability

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

Returns:

The returnSALineGeometries

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnSALines

void setReturnSALines(boolean returnSALines)
                      throws IOException,
                             AutomationException

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

Remarks

ReturnSALines specifies if the resulting SALines features are returned.

Product Availability

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

Parameters:

returnSALines - The returnSALines (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnSALines

boolean isReturnSALines()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Returns:

The returnSALines

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnSAPolygonGeometries

void setReturnSAPolygonGeometries(boolean returnSAPolygonGeometries)
                                  throws IOException,
                                         AutomationException

Indicates if the SAPolygon geometries should be generated and returned with the analysis results.

Remarks

ReturnSAPolygonGeometries specifies if the resulting SAPolygonGeometries are returned.

Product Availability

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

Parameters:

returnSAPolygonGeometries - The returnSAPolygonGeometries (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnSAPolygonGeometries

boolean isReturnSAPolygonGeometries()
                                    throws IOException,
                                           AutomationException

Indicates if the SAPolygon geometries should be generated and returned with the analysis results.

Product Availability

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

Returns:

The returnSAPolygonGeometries

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnSAPolygons

void setReturnSAPolygons(boolean returnSAPolygons)
                         throws IOException,
                                AutomationException

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

Remarks

ReturnSAPolygons specifies if the resulting SAPolygon features are returned.

Product Availability

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

Parameters:

returnSAPolygons - The returnSAPolygons (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnSAPolygons

boolean isReturnSAPolygons()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Returns:

The returnSAPolygons

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnFacilities

void setReturnFacilities(boolean returnFacilities)
                         throws IOException,
                                AutomationException

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

Remarks

ReturnFacilities specifies if the resulting Facility features are returned.

Product Availability

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

Parameters:

returnFacilities - The returnFacilities (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnFacilities

boolean isReturnFacilities()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Returns:

The returnFacilities

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

void setReturnBarriers(boolean returnBarriers)
                       throws IOException,
                              AutomationException

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

Remarks

ReturnBarriers specifies if the Barriers 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.

isReturnBarriers

boolean isReturnBarriers()
                         throws IOException,
                                AutomationException

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

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.