com.esri.arcgis.networkanalyst
Interface INAServiceAreaSolver2

All Superinterfaces:
INAServiceAreaSolver, Serializable
All Known Implementing Classes:
NAServerServiceAreaParams, NAServiceAreaSolver

public interface INAServiceAreaSolver2
extends INAServiceAreaSolver, Serializable

Provides access to the service area solver.

Remarks

INAServiceAreaSolver2 is the interface provided on the NASolver object to access additional properties of the service area solver.

Product Availability

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


Method Summary
 double getTrimPolygonDistance()
          If polygons are being trimmed, provides the distance to trim.
 int getTrimPolygonDistanceUnits()
          If polygons are being trimmed, provides the units of the distance to trim.
 boolean isCreateTraversalResult()
          Indicates if a traversal result is created.
 boolean isIncludeSourceInformationOnLines()
          Indicates if the lines will have SourceID, SourceOID, from and to position information added.
 boolean isOverlapPolygons()
          Indicates if the polygons for all facilities should not overlap.
 boolean isTrimOuterPolygon()
          Indicates if the outermost polygon (at the maximum break value) will be trimmed.
 void setCreateTraversalResult(boolean value)
          Indicates if a traversal result is created.
 void setIncludeSourceInformationOnLines(boolean value)
          Indicates if the lines will have SourceID, SourceOID, from and to position information added.
 void setOverlapPolygons(boolean value)
          Indicates if the polygons for all facilities should not overlap.
 void setTrimOuterPolygon(boolean value)
          Indicates if the outermost polygon (at the maximum break value) will be trimmed.
 void setTrimPolygonDistance(double distance)
          If polygons are being trimmed, provides the distance to trim.
 void setTrimPolygonDistanceUnits(int units)
          If polygons are being trimmed, provides the units of the distance to trim.
 
Methods inherited from interface com.esri.arcgis.networkanalyst.INAServiceAreaSolver
getDefaultBreaks, getExcludeSourcesFromPolygons, getOutputLines, getOutputPolygons, getTravelDirection, isMergeSimilarPolygonRanges, isOverlapLines, isSplitLinesAtBreaks, isSplitPolygonsAtBreaks, setDefaultBreaks, setExcludeSourcesFromPolygons, setMergeSimilarPolygonRanges, setOutputLines, setOutputPolygons, setOverlapLines, setSplitLinesAtBreaks, setSplitPolygonsAtBreaks, setTravelDirection
 

Method Detail

setOverlapPolygons

void setOverlapPolygons(boolean value)
                        throws IOException,
                               AutomationException
Indicates if the polygons for all facilities should not overlap.

Remarks

If OverlapPolygons is true, service area polygons from multiple facilities may overlap. If set to false, the service area polygons generated will not overlap and each polygon will encompass the area reached by the closest facility.

Product Availability

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

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverlapPolygons

boolean isOverlapPolygons()
                          throws IOException,
                                 AutomationException
Indicates if the polygons for all facilities should not overlap.

Remarks

If OverlapPolygons is true, service area polygons from multiple facilities may overlap. If set to false, the service area polygons generated will not overlap and each polygon will encompass the area reached by the closest facility.

Product Availability

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

Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIncludeSourceInformationOnLines

void setIncludeSourceInformationOnLines(boolean value)
                                        throws IOException,
                                               AutomationException
Indicates if the lines will have SourceID, SourceOID, from and to position information added.

Remarks

IncludeSourceInformationOnLines specifies if the SourceID, SourceOID, FromPosition and ToPosition fields on the SALines feature class will be populated or not. If this property is set to true, you can use these fields on the SALines to determine the source features and position along the feature that were part of the service area.

Product Availability

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

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIncludeSourceInformationOnLines

boolean isIncludeSourceInformationOnLines()
                                          throws IOException,
                                                 AutomationException
Indicates if the lines will have SourceID, SourceOID, from and to position information added.

Remarks

IncludeSourceInformationOnLines specifies if the SourceID, SourceOID, FromPosition and ToPosition fields on the SALines feature class will be populated or not. If this property is set to true, you can use these fields on the SALines to determine the source features and position along the feature that were part of the service area.

Product Availability

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

Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrimOuterPolygon

void setTrimOuterPolygon(boolean value)
                         throws IOException,
                                AutomationException
Indicates if the outermost polygon (at the maximum break value) will be trimmed.

Remarks

If this is true, the outer polygon will be adjusted to be within the TrimPolygonDistance of the source features. It is used to make the outer ring more cartographically pleasing by shrinking it to within a specified distance. This operation is not the same as clipping or buffering.

Small values for TrimPolygonDistance will increase processing time and may result in unusual looking polygons.

Product Availability

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

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTrimOuterPolygon

boolean isTrimOuterPolygon()
                           throws IOException,
                                  AutomationException
Indicates if the outermost polygon (at the maximum break value) will be trimmed.

Remarks

If this is true, the outer polygon will be adjusted to be within the TrimPolygonDistance of the source features. It is used to make the outer ring more cartographically pleasing by shrinking it to within a specified distance. This operation is not the same as clipping or buffering.

Small values for TrimPolygonDistance will increase processing time and may result in unusual looking polygons.

Product Availability

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

Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrimPolygonDistance

void setTrimPolygonDistance(double distance)
                            throws IOException,
                                   AutomationException
If polygons are being trimmed, provides the distance to trim.

Remarks

TrimPolygonDistance specifies the distance (based on units specified by TrimPolygonDistanceUnits) that the outer service area polygon should be from the source features. This is useful to reduce the area of the outer service area polygon in sparse networks.

Product Availability

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

Parameters:
distance - The distance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrimPolygonDistance

double getTrimPolygonDistance()
                              throws IOException,
                                     AutomationException
If polygons are being trimmed, provides the distance to trim.

Remarks

TrimPolygonDistance specifies the distance (based on units specified by TrimPolygonDistanceUnits) that the outer service area polygon should be from the source features. This is useful to reduce the area of the outer service area polygon in sparse networks.

Product Availability

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

Returns:
The distance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrimPolygonDistanceUnits

void setTrimPolygonDistanceUnits(int units)
                                 throws IOException,
                                        AutomationException
If polygons are being trimmed, provides the units of the distance to trim.

Remarks

TrimPolygonDistanceUnits specifies the length units used by TrimPolygonDistance to specify the distance the outer service area polygon should be from the source features. This is useful to reduce the area of the outer service area polygon in sparse networks.

Product Availability

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

Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrimPolygonDistanceUnits

int getTrimPolygonDistanceUnits()
                                throws IOException,
                                       AutomationException
If polygons are being trimmed, provides the units of the distance to trim.

Remarks

TrimPolygonDistanceUnits specifies the length units used by TrimPolygonDistance, which in turn limits the distance of the outer service-area polygon from the source features. This is useful to reduce the area of the outer service area polygon in sparse networks.

Product Availability

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

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCreateTraversalResult

void setCreateTraversalResult(boolean value)
                              throws IOException,
                                     AutomationException
Indicates if a traversal result is created.

Product Availability

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

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCreateTraversalResult

boolean isCreateTraversalResult()
                                throws IOException,
                                       AutomationException
Indicates if a traversal result is created.

Product Availability

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

Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.