com.esri.arcgis.networkanalyst
Interface INAServerLocationAllocationParams

All Superinterfaces:

INAServerSolverParams, Serializable

All Known Implementing Classes:

NAServerLocationAllocationParams

public interface INAServerLocationAllocationParams
extends INAServerSolverParams, Serializable

Provides access to properties that specify the Location-Allocation solver settings and return parameters used during network analysis with NAServer.

Remarks

INAServerLocationAllocationParams provides methods to set input parameters on an NAServerLocationAllocationParams object that is then used by the Solve method on INAServer to perform location-allocation network analysis.

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	getDemandPoints() RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.
INAServerLocations	getFacilities() RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
INAServerLocations	getPolygonBarriers() RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
INAServerLocations	getPolylineBarriers() RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
boolean	isReturnBarriers() Indicates if the output Barriers recordset should be returned with the analysis results.
boolean	isReturnDemandPoints() Indicates if the output DemandPoints recordset should be returned with the analysis results.
boolean	isReturnFacilities() Indicates if the output Facilities recordset should be returned with the analysis results.
boolean	isReturnLALines() Indicates if the output LALines recordset should be returned with the analysis results.
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	setBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	setDemandPointsByRef(INAServerLocations demandPoints) RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.
void	setFacilitiesByRef(INAServerLocations facilities) RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
void	setPolygonBarriersByRef(INAServerLocations polygonBarriers) RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
void	setPolylineBarriersByRef(INAServerLocations polylineBarriers) RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
void	setReturnBarriers(boolean returnBarriers) Indicates if the output Barriers recordset should be returned with the analysis results.
void	setReturnDemandPoints(boolean returnDemandPoints) Indicates if the output DemandPoints 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	setReturnLALines(boolean returnLALines) Indicates if the output LALines recordset should be returned with the analysis results.
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.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 take into account when solving a Location-Allocation 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.

setDemandPointsByRef

void setDemandPointsByRef(INAServerLocations demandPoints)
                          throws IOException,
                                 AutomationException

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

Remarks

DemandPoints specifies an instance of NAServerLocations class to take into account when solving a Location-Allocation problem.

Product Availability

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

Parameters:

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

getDemandPoints

INAServerLocations getDemandPoints()
                                   throws IOException,
                                          AutomationException

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

setPolylineBarriersByRef

void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
                              throws IOException,
                                     AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of 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 Location-Allocation problem.

Product Availability

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

Parameters:

polylineBarriers - 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 collections of 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 polygonBarriers)
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of 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 Location-Allocation problem.

Product Availability

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

Parameters:

polygonBarriers - 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 collections of 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.

setReturnLALines

void setReturnLALines(boolean returnLALines)
                      throws IOException,
                             AutomationException

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

Remarks

ReturnLALines specifies if the resulting LALines features are returned.

Product Availability

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

Parameters:

returnLALines - The returnLALines (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnLALines

boolean isReturnLALines()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Returns:

The returnLALines

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.

setReturnDemandPoints

void setReturnDemandPoints(boolean returnDemandPoints)
                           throws IOException,
                                  AutomationException

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

Remarks

ReturnDemandPoints specifies if the resulting DemandPoints features are returned.

Product Availability

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

Parameters:

returnDemandPoints - The returnDemandPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDemandPoints

boolean isReturnDemandPoints()
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Returns:

The returnDemandPoints

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.

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.

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.

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.