com.esri.arcgis.networkanalyst
Class NAServerServiceAreaParams

java.lang.Object
  extended by com.esri.arcgis.networkanalyst.NAServerServiceAreaParams
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INAServerServiceAreaParams, INAServerSolverParams, INAServiceAreaSolver, INAServiceAreaSolver2, INASolverSettings, INASolverSettings2, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NAServerServiceAreaParams
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerServiceAreaParams, INASolverSettings, INASolverSettings2, INAServiceAreaSolver, INAServiceAreaSolver2, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable

A container for the service area solver settings and return parameters used by NAServer.

Remarks

NAServerServiceAreaParams is used to pass solver settings and return parameters to the NAServer when performing stateless network analysis.

Product Availability

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INASolverSettings2
IID, IIDd3696546_2831_4aa5_a879_acd66e50a938, xxDummy
 
Constructor Summary
NAServerServiceAreaParams()
          Constructs a NAServerServiceAreaParams using ArcGIS Engine.
NAServerServiceAreaParams(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerServiceAreaParams theNAServerServiceAreaParams = (NAServerServiceAreaParams) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 IStringArray getAccumulateAttributeNames()
          The collection of network attribute names to be accumulated with the analysis.
 Object getAttributeParameterValue(String attributeName, String paramName)
          The value to use for an attribute parameter within the network dataset.
 INAServerLocations getBarriers()
          RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IDoubleArray getDefaultBreaks()
          The default break(s) of the traversal.
 IStringArray getExcludeSourcesFromPolygons()
          A collection of network source names to NOT use when generating polygons.
 INAServerLocations getFacilities()
          RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
 String getHierarchyAttributeName()
          The name of the hierarchy attribute to be used in analysis.
 int getHierarchyLevelCount()
          The number of levels in the hierarchy attribute.
 IImageDescription getImageDescription()
          ImageDescription used when generating the MapImage returned with the analysis results.
 String getImpedanceAttributeName()
          The network attribute name to be used as the impedance attribute in analysis.
 IMapDescription getMapDescription()
          MapDescription used when generating the MapImage returned with the analysis results.
 double getMaxSnapTolerance()
          Maximum search tolerance used when attempting to load network locations.
 int getMaxValueForHierarchy(int level)
          The maximum value of the hierarchy attribute.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 INAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
          Array of NAClassCandidateFieldMaps .
 String getNALayerName()
          Network analysis layer name.
 int getNumTransitionToHierarchy(int toLevel)
          The number of lower level junctions to explore before searching the next hierarchy level.
 int getOutputLines()
          The type of line(s) generated.
 int getOutputPolygons()
          The type of polygon(s) generated.
 ISpatialReference getOutputSpatialReference()
          Spatial reference of the geometries returned with the analysis results.
 IStringArray getRestrictionAttributeNames()
          The collection of network attribute names to be used as restrictions with the analysis.
 int getRestrictUTurns()
          Indicates how U-Turns should be restricted in the analysis.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 double getSnapTolerance()
          Minimum search tolerance used when attempting to load network locations.
 int getSnapToleranceUnits()
          Length units of the SnapTolerance and MaxSnapTolerance.
 int getTravelDirection()
          The direction of the traversal.
 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.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isCreateTraversalResult()
          Indicates if a traversal result is created.
 void isDirty()
          isDirty
 boolean isIgnoreInvalidLocations()
          Indicates if invalid locations should be ignored or raise an error.
 boolean isIncludeSourceInformationOnLines()
          Indicates if the lines will have SourceID, SourceOID, from and to position information added.
 boolean isMergeSimilarPolygonRanges()
          Indicates if similar ranges should be merged in the result polygons.
 boolean isOverlapLines()
          Indicates if lines should overlap from multiple facilities.
 boolean isOverlapPolygons()
          Indicates if the polygons for all facilities should not overlap.
 boolean isResetHierarchyRangesOnBind()
          Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.
 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 isReturnMap()
          Indicates if a MapImage should be generated and 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.
 boolean isSplitLinesAtBreaks()
          Indicates if lines should be split at breaks.
 boolean isSplitPolygonsAtBreaks()
          Indicates if polygons should be split at break values.
 boolean isTrimOuterPolygon()
          Indicates if the outermost polygon (at the maximum break value) will be trimmed.
 boolean isUseHierarchy()
          Indicates if the hierarchy attribute for the network should be used in analysis.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAccumulateAttributeNamesByRef(IStringArray attributeNames)
          The collection of network attribute names to be accumulated with the analysis.
 void setAttributeParameterValue(String attributeName, String paramName, Object value)
          The value to use for an attribute parameter within the network dataset.
 void setBarriersByRef(INAServerLocations barriers)
          RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
 void setCreateTraversalResult(boolean value)
          Indicates if a traversal result is created.
 void setDefaultBreaks(IDoubleArray value)
          The default break(s) of the traversal.
 void setExcludeSourcesFromPolygons(IStringArray networkSourceNames)
          A collection of network source names to NOT use when generating polygons.
 void setFacilitiesByRef(INAServerLocations facilities)
          RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
 void setHierarchyAttributeName(String attributeName)
          The name of the hierarchy attribute to be used in analysis.
 void setHierarchyLevelCount(int count)
          The number of levels in the hierarchy attribute.
 void setIgnoreInvalidLocations(boolean ignoreInvalidLocations)
          Indicates if invalid locations should be ignored or raise an error.
 void setImageDescriptionByRef(IImageDescription imageDescription)
          ImageDescription used when generating the MapImage returned with the analysis results.
 void setImpedanceAttributeName(String attributeName)
          The network attribute name to be used as the impedance attribute in analysis.
 void setIncludeSourceInformationOnLines(boolean value)
          Indicates if the lines will have SourceID, SourceOID, from and to position information added.
 void setMapDescriptionByRef(IMapDescription mapDescription)
          MapDescription used when generating the MapImage returned with the analysis results.
 void setMaxSnapTolerance(double maxSnapTolerance)
          Maximum search tolerance used when attempting to load network locations.
 void setMaxValueForHierarchy(int level, int value)
          The maximum value of the hierarchy attribute.
 void setMergeSimilarPolygonRanges(boolean value)
          Indicates if similar ranges should be merged in the result polygons.
 void setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
          Array of NAClassCandidateFieldMaps .
 void setNALayerName(String nALayerName)
          Network analysis layer name.
 void setNumTransitionToHierarchy(int toLevel, int value)
          The number of lower level junctions to explore before searching the next hierarchy level.
 void setOutputLines(int value)
          The type of line(s) generated.
 void setOutputPolygons(int value)
          The type of polygon(s) generated.
 void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
          Spatial reference of the geometries returned with the analysis results.
 void setOverlapLines(boolean value)
          Indicates if lines should overlap from multiple facilities.
 void setOverlapPolygons(boolean value)
          Indicates if the polygons for all facilities should not overlap.
 void setResetHierarchyRangesOnBind(boolean value)
          Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.
 void setRestrictionAttributeNamesByRef(IStringArray attributeName)
          The collection of network attribute names to be used as restrictions with the analysis.
 void setRestrictUTurns(int backtrack)
          Indicates how U-Turns should be restricted in the 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 setReturnMap(boolean returnMap)
          Indicates if a MapImage should be generated and 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.
 void setSnapTolerance(double snapTolerance)
          Minimum search tolerance used when attempting to load network locations.
 void setSnapToleranceUnits(int snapToleranceUnits)
          Length units of the SnapTolerance and MaxSnapTolerance.
 void setSplitLinesAtBreaks(boolean value)
          Indicates if lines should be split at breaks.
 void setSplitPolygonsAtBreaks(boolean value)
          Indicates if polygons should be split at break values.
 void setTravelDirection(int value)
          The direction of the traversal.
 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.
 void setUseHierarchy(boolean useHierarchy)
          Indicates if the hierarchy attribute for the network should be used in analysis.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

NAServerServiceAreaParams

public NAServerServiceAreaParams()
                          throws IOException,
                                 UnknownHostException
Constructs a NAServerServiceAreaParams using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

NAServerServiceAreaParams

public NAServerServiceAreaParams(Object obj)
                          throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerServiceAreaParams theNAServerServiceAreaParams = (NAServerServiceAreaParams) obj;

Construct a NAServerServiceAreaParams using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NAServerServiceAreaParams.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setNALayerName

public void setNALayerName(String nALayerName)
                    throws IOException,
                           AutomationException
Network analysis layer name.

Remarks

NALayerName specifies the Network Analyst Layer Name used within this NAContext.

Product Availability

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

Specified by:
setNALayerName in interface INAServerSolverParams
Parameters:
nALayerName - The nALayerName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNALayerName

public String getNALayerName()
                      throws IOException,
                             AutomationException
Network analysis layer name.

Remarks

NALayerName specifies the Network Analyst Layer Name used within this NAContext.

Product Availability

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

Specified by:
getNALayerName in interface INAServerSolverParams
Returns:
The nALayerName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

public void setSnapTolerance(double snapTolerance)
                      throws IOException,
                             AutomationException
Minimum search tolerance used when attempting to load network locations.

Remarks

SnapTolerance specifies the minimum search tolerance used when finding network locations.

Product Availability

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

Specified by:
setSnapTolerance in interface INAServerSolverParams
Parameters:
snapTolerance - The snapTolerance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

public double getSnapTolerance()
                        throws IOException,
                               AutomationException
Minimum search tolerance used when attempting to load network locations.

Remarks

SnapTolerance specifies the minimum search tolerance used when finding network locations.

Product Availability

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

Specified by:
getSnapTolerance in interface INAServerSolverParams
Returns:
The snapTolerance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxSnapTolerance

public void setMaxSnapTolerance(double maxSnapTolerance)
                         throws IOException,
                                AutomationException
Maximum search tolerance used when attempting to load network locations.

Remarks

MaxSnapTolerance specifies the maximum search tolerance used when finding network locations.

Product Availability

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

Specified by:
setMaxSnapTolerance in interface INAServerSolverParams
Parameters:
maxSnapTolerance - The maxSnapTolerance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxSnapTolerance

public double getMaxSnapTolerance()
                           throws IOException,
                                  AutomationException
Maximum search tolerance used when attempting to load network locations.

Remarks

MaxSnapTolerance specifies the maximum search tolerance used when finding network locations.

Product Availability

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

Specified by:
getMaxSnapTolerance in interface INAServerSolverParams
Returns:
The maxSnapTolerance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSnapToleranceUnits

public void setSnapToleranceUnits(int snapToleranceUnits)
                           throws IOException,
                                  AutomationException
Length units of the SnapTolerance and MaxSnapTolerance.

Remarks

SnapToleranceUnits specifies the units of the search tolerance in esriUnits type.

Product Availability

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

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

getSnapToleranceUnits

public int getSnapToleranceUnits()
                          throws IOException,
                                 AutomationException
Length units of the SnapTolerance and MaxSnapTolerance.

Remarks

SnapToleranceUnits specifies the units of the search tolerance in esriUnits type.

Product Availability

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

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

setNAClassCandidateFieldMaps

public void setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
                                  throws IOException,
                                         AutomationException
Array of NAClassCandidateFieldMaps .

Remarks

NAClassCandidateFieldMaps specifies the candidate fields for each NAClass. These field maps are used when loading network locations to map input fields with NAClass fields.

Product Availability

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

Specified by:
setNAClassCandidateFieldMaps in interface INAServerSolverParams
Parameters:
ppNAClassCandidateFieldMaps - A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNAClassCandidateFieldMaps

public INAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
                                                         throws IOException,
                                                                AutomationException
Array of NAClassCandidateFieldMaps .

Remarks

NAClassCandidateFieldMaps specifies the candidate fields for each NAClass. These field maps are used when loading network locations to map input fields with NAClass fields.

Product Availability

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

Specified by:
getNAClassCandidateFieldMaps in interface INAServerSolverParams
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnMap

public void setReturnMap(boolean returnMap)
                  throws IOException,
                         AutomationException
Indicates if a MapImage should be generated and returned with the analysis results.

Remarks

ReturnMap specifies if the map is returned by the solve.

Product Availability

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

Specified by:
setReturnMap in interface INAServerSolverParams
Parameters:
returnMap - The returnMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnMap

public boolean isReturnMap()
                    throws IOException,
                           AutomationException
Indicates if a MapImage should be generated and returned with the analysis results.

Remarks

ReturnMap specifies if the map is returned by the solve.

Product Availability

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

Specified by:
isReturnMap in interface INAServerSolverParams
Returns:
The returnMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapDescriptionByRef

public void setMapDescriptionByRef(IMapDescription mapDescription)
                            throws IOException,
                                   AutomationException
MapDescription used when generating the MapImage returned with the analysis results.

Remarks

MapDescription specifies the MapDescription object to use when drawing the map with the analysis results.

Product Availability

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

Specified by:
setMapDescriptionByRef in interface INAServerSolverParams
Parameters:
mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapDescription

public IMapDescription getMapDescription()
                                  throws IOException,
                                         AutomationException
MapDescription used when generating the MapImage returned with the analysis results.

Remarks

MapDescription specifies the MapDescription object to use when drawing the map with the analysis results.

Product Availability

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

Specified by:
getMapDescription in interface INAServerSolverParams
Returns:
A reference to a com.esri.arcgis.carto.IMapDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImageDescriptionByRef

public void setImageDescriptionByRef(IImageDescription imageDescription)
                              throws IOException,
                                     AutomationException
ImageDescription used when generating the MapImage returned with the analysis results.

Remarks

Specifies the ImageDescription used when creating maps during solve. Setting the Width and Height of the output map to be 200x200 pixels would look something like:

routeParams.ImageDescription.Display.Width = 200

routeParams.ImageDescription.Display.Height = 200

Product Availability

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

Specified by:
setImageDescriptionByRef in interface INAServerSolverParams
Parameters:
imageDescription - A reference to a com.esri.arcgis.carto.IImageDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImageDescription

public IImageDescription getImageDescription()
                                      throws IOException,
                                             AutomationException
ImageDescription used when generating the MapImage returned with the analysis results.

Remarks

Specifies the ImageDescription used when creating maps during solve. Setting the Width and Height of the output map to be 200x200 pixels would look something like:

routeParams.ImageDescription.Display.Width = 200

routeParams.ImageDescription.Display.Height = 200

Product Availability

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

Specified by:
getImageDescription in interface INAServerSolverParams
Returns:
A reference to a com.esri.arcgis.carto.IImageDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                                    throws IOException,
                                           AutomationException
Spatial reference of the geometries returned with the analysis results.

Remarks

OutputSpatialReference specifies the spatial reference of the resulting geometry arrays returned from Solve. This does not change the spatial reference of the recordsets returned which are in the spatial reference of the network dataset.

Product Availability

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

Specified by:
setOutputSpatialReferenceByRef in interface INAServerSolverParams
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference()
                                            throws IOException,
                                                   AutomationException
Spatial reference of the geometries returned with the analysis results.

Remarks

OutputSpatialReference specifies the spatial reference of the resulting geometry arrays returned from Solve. This does not change the spatial reference of the recordsets returned which are in the spatial reference of the network dataset.

Product Availability

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

Specified by:
getOutputSpatialReference in interface INAServerSolverParams
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFacilitiesByRef

public void setFacilitiesByRef(INAServerLocations facilities)
                        throws IOException,
                               AutomationException
RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.

Remarks

Facilities specifies the NALocations to use as input when solving a service area problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:
setFacilitiesByRef in interface INAServerServiceAreaParams
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

public INAServerLocations getFacilities()
                                 throws IOException,
                                        AutomationException
RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.

Remarks

Facilities specifies the NALocations to use as input when solving a service area problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:
getFacilities in interface INAServerServiceAreaParams
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

public void setBarriersByRef(INAServerLocations barriers)
                      throws IOException,
                             AutomationException
RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Remarks

Barriers specifies the NALocations to use in order to restrict network elements when solving a service area problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:
setBarriersByRef in interface INAServerServiceAreaParams
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

public INAServerLocations getBarriers()
                               throws IOException,
                                      AutomationException
RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Remarks

Barriers specifies the NALocations to use in order to restrict network elements when solving a service area problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:
getBarriers in interface INAServerServiceAreaParams
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

public 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 Polylines for the resulting SALine features are returned.

Product Availability

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

Specified by:
setReturnSALineGeometries in interface INAServerServiceAreaParams
Parameters:
returnSALineGeometries - The returnSALineGeometries (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnSALineGeometries

public boolean isReturnSALineGeometries()
                                 throws IOException,
                                        AutomationException
Indicates if the SALine geometries should be generated and returned with the analysis results.

Remarks

ReturnSALineGeometries specifies if the Polylines for the resulting SALine features are returned.

Product Availability

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

Specified by:
isReturnSALineGeometries in interface INAServerServiceAreaParams
Returns:
The returnSALineGeometries
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnSALines

public 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 SALine features are returned.

Product Availability

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

Specified by:
setReturnSALines in interface INAServerServiceAreaParams
Parameters:
returnSALines - The returnSALines (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnSALines

public boolean isReturnSALines()
                        throws IOException,
                               AutomationException
Indicates if the output SALines recordset should be returned with the analysis results.

Remarks

ReturnSALines specifies if the resulting SALine features are returned.

Product Availability

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

Specified by:
isReturnSALines in interface INAServerServiceAreaParams
Returns:
The returnSALines
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnSAPolygonGeometries

public 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 Polygons for the resulting SAPolygon features are returned.

Product Availability

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

Specified by:
setReturnSAPolygonGeometries in interface INAServerServiceAreaParams
Parameters:
returnSAPolygonGeometries - The returnSAPolygonGeometries (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnSAPolygonGeometries

public boolean isReturnSAPolygonGeometries()
                                    throws IOException,
                                           AutomationException
Indicates if the SAPolygon geometries should be generated and returned with the analysis results.

Remarks

ReturnSAPolygonGeometries specifies if the Polygons for the resulting SAPolygon features are returned.

Product Availability

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

Specified by:
isReturnSAPolygonGeometries in interface INAServerServiceAreaParams
Returns:
The returnSAPolygonGeometries
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnSAPolygons

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

Specified by:
setReturnSAPolygons in interface INAServerServiceAreaParams
Parameters:
returnSAPolygons - The returnSAPolygons (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnSAPolygons

public boolean isReturnSAPolygons()
                           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.

Specified by:
isReturnSAPolygons in interface INAServerServiceAreaParams
Returns:
The returnSAPolygons
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnFacilities

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

Specified by:
setReturnFacilities in interface INAServerServiceAreaParams
Parameters:
returnFacilities - The returnFacilities (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnFacilities

public boolean isReturnFacilities()
                           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.

Specified by:
isReturnFacilities in interface INAServerServiceAreaParams
Returns:
The returnFacilities
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

public 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 resulting Barrier features are returned.

Product Availability

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

Specified by:
setReturnBarriers in interface INAServerServiceAreaParams
Parameters:
returnBarriers - The returnBarriers (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

public boolean isReturnBarriers()
                         throws IOException,
                                AutomationException
Indicates if the output barriers recordset should be returned with the analysis results.

Remarks

ReturnBarriers specifies if the resulting Barrier features are returned.

Product Availability

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

Specified by:
isReturnBarriers in interface INAServerServiceAreaParams
Returns:
The returnBarriers
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAccumulateAttributeNames

public IStringArray getAccumulateAttributeNames()
                                         throws IOException,
                                                AutomationException
The collection of network attribute names to be accumulated with the analysis.

Specified by:
getAccumulateAttributeNames in interface INASolverSettings
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAccumulateAttributeNamesByRef

public void setAccumulateAttributeNamesByRef(IStringArray attributeNames)
                                      throws IOException,
                                             AutomationException
The collection of network attribute names to be accumulated with the analysis.

Specified by:
setAccumulateAttributeNamesByRef in interface INASolverSettings
Parameters:
attributeNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImpedanceAttributeName

public void setImpedanceAttributeName(String attributeName)
                               throws IOException,
                                      AutomationException
The network attribute name to be used as the impedance attribute in analysis.

Specified by:
setImpedanceAttributeName in interface INASolverSettings
Parameters:
attributeName - The attributeName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImpedanceAttributeName

public String getImpedanceAttributeName()
                                 throws IOException,
                                        AutomationException
The network attribute name to be used as the impedance attribute in analysis.

Specified by:
getImpedanceAttributeName in interface INASolverSettings
Returns:
The attributeName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIgnoreInvalidLocations

public void setIgnoreInvalidLocations(boolean ignoreInvalidLocations)
                               throws IOException,
                                      AutomationException
Indicates if invalid locations should be ignored or raise an error.

Specified by:
setIgnoreInvalidLocations in interface INASolverSettings
Parameters:
ignoreInvalidLocations - The ignoreInvalidLocations (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIgnoreInvalidLocations

public boolean isIgnoreInvalidLocations()
                                 throws IOException,
                                        AutomationException
Indicates if invalid locations should be ignored or raise an error.

Specified by:
isIgnoreInvalidLocations in interface INASolverSettings
Returns:
The ignoreInvalidLocations
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRestrictionAttributeNames

public IStringArray getRestrictionAttributeNames()
                                          throws IOException,
                                                 AutomationException
The collection of network attribute names to be used as restrictions with the analysis.

Specified by:
getRestrictionAttributeNames in interface INASolverSettings
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRestrictionAttributeNamesByRef

public void setRestrictionAttributeNamesByRef(IStringArray attributeName)
                                       throws IOException,
                                              AutomationException
The collection of network attribute names to be used as restrictions with the analysis.

Specified by:
setRestrictionAttributeNamesByRef in interface INASolverSettings
Parameters:
attributeName - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRestrictUTurns

public void setRestrictUTurns(int backtrack)
                       throws IOException,
                              AutomationException
Indicates how U-Turns should be restricted in the analysis.

Specified by:
setRestrictUTurns in interface INASolverSettings
Parameters:
backtrack - A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRestrictUTurns

public int getRestrictUTurns()
                      throws IOException,
                             AutomationException
Indicates how U-Turns should be restricted in the analysis.

Specified by:
getRestrictUTurns in interface INASolverSettings
Returns:
A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseHierarchy

public void setUseHierarchy(boolean useHierarchy)
                     throws IOException,
                            AutomationException
Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:
setUseHierarchy in interface INASolverSettings
Parameters:
useHierarchy - The useHierarchy (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseHierarchy

public boolean isUseHierarchy()
                       throws IOException,
                              AutomationException
Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:
isUseHierarchy in interface INASolverSettings
Returns:
The useHierarchy
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHierarchyAttributeName

public void setHierarchyAttributeName(String attributeName)
                               throws IOException,
                                      AutomationException
The name of the hierarchy attribute to be used in analysis.

Specified by:
setHierarchyAttributeName in interface INASolverSettings
Parameters:
attributeName - The attributeName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHierarchyAttributeName

public String getHierarchyAttributeName()
                                 throws IOException,
                                        AutomationException
The name of the hierarchy attribute to be used in analysis.

Specified by:
getHierarchyAttributeName in interface INASolverSettings
Returns:
The attributeName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHierarchyLevelCount

public void setHierarchyLevelCount(int count)
                            throws IOException,
                                   AutomationException
The number of levels in the hierarchy attribute.

Specified by:
setHierarchyLevelCount in interface INASolverSettings
Parameters:
count - The count (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHierarchyLevelCount

public int getHierarchyLevelCount()
                           throws IOException,
                                  AutomationException
The number of levels in the hierarchy attribute.

Specified by:
getHierarchyLevelCount in interface INASolverSettings
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxValueForHierarchy

public void setMaxValueForHierarchy(int level,
                                    int value)
                             throws IOException,
                                    AutomationException
The maximum value of the hierarchy attribute.

Specified by:
setMaxValueForHierarchy in interface INASolverSettings
Parameters:
level - The level (in)
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxValueForHierarchy

public int getMaxValueForHierarchy(int level)
                            throws IOException,
                                   AutomationException
The maximum value of the hierarchy attribute.

Specified by:
getMaxValueForHierarchy in interface INASolverSettings
Parameters:
level - The level (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumTransitionToHierarchy

public void setNumTransitionToHierarchy(int toLevel,
                                        int value)
                                 throws IOException,
                                        AutomationException
The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:
setNumTransitionToHierarchy in interface INASolverSettings
Parameters:
toLevel - The toLevel (in)
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumTransitionToHierarchy

public int getNumTransitionToHierarchy(int toLevel)
                                throws IOException,
                                       AutomationException
The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:
getNumTransitionToHierarchy in interface INASolverSettings
Parameters:
toLevel - The toLevel (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isResetHierarchyRangesOnBind

public boolean isResetHierarchyRangesOnBind()
                                     throws IOException,
                                            AutomationException
Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:
isResetHierarchyRangesOnBind in interface INASolverSettings2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResetHierarchyRangesOnBind

public void setResetHierarchyRangesOnBind(boolean value)
                                   throws IOException,
                                          AutomationException
Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

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

getAttributeParameterValue

public Object getAttributeParameterValue(String attributeName,
                                         String paramName)
                                  throws IOException,
                                         AutomationException
The value to use for an attribute parameter within the network dataset.

Specified by:
getAttributeParameterValue in interface INASolverSettings2
Parameters:
attributeName - The attributeName (in)
paramName - The paramName (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttributeParameterValue

public void setAttributeParameterValue(String attributeName,
                                       String paramName,
                                       Object value)
                                throws IOException,
                                       AutomationException
The value to use for an attribute parameter within the network dataset.

Specified by:
setAttributeParameterValue in interface INASolverSettings2
Parameters:
attributeName - The attributeName (in)
paramName - The paramName (in)
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTravelDirection

public int getTravelDirection()
                       throws IOException,
                              AutomationException
The direction of the traversal.

Remarks

TravelDirection specifies if it is traveling from the facility (default) or traveling to the facility.

This can make a difference in the computed service area if there are oneway restrictions, turn restrictions, or different travel cost attributes for each side of the street in the network.

Product Availability

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

Specified by:
getTravelDirection in interface INAServiceAreaSolver
Returns:
A com.esri.arcgis.networkanalyst.esriNATravelDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTravelDirection

public void setTravelDirection(int value)
                        throws IOException,
                               AutomationException
The direction of the traversal.

Remarks

TravelDirection specifies if it is traveling from the facility (default) or traveling to the facility.

This can make a difference in the computed service area if there are oneway restrictions, turn restrictions, or different travel cost attributes for each side of the street in the network.

Product Availability

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

Specified by:
setTravelDirection in interface INAServiceAreaSolver
Parameters:
value - A com.esri.arcgis.networkanalyst.esriNATravelDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultBreaks

public IDoubleArray getDefaultBreaks()
                              throws IOException,
                                     AutomationException
The default break(s) of the traversal.

Remarks

DefaultBreaks specifies how many rings to compute around each facility.

The breaks are specified as a double array of numbers like 2.0, 4.0, 6.0. This will result in three polygons around the facility at 2.0, 4.0 and 6.0 cumulative attribute value units from each facility.

Product Availability

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

Specified by:
getDefaultBreaks in interface INAServiceAreaSolver
Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultBreaks

public void setDefaultBreaks(IDoubleArray value)
                      throws IOException,
                             AutomationException
The default break(s) of the traversal.

Remarks

DefaultBreaks specifies how many rings to compute around each facility.

The breaks are specified as a double array of numbers like 2.0, 4.0, 6.0. This will result in three polygons around the facility at 2.0, 4.0 and 6.0 cumulative attribute value units from each facility.

Product Availability

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

Specified by:
setDefaultBreaks in interface INAServiceAreaSolver
Parameters:
value - A reference to a com.esri.arcgis.system.IDoubleArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSplitPolygonsAtBreaks

public boolean isSplitPolygonsAtBreaks()
                                throws IOException,
                                       AutomationException
Indicates if polygons should be split at break values.

Remarks

SplitPolygonsAtBreaks specifies to the solver if the service area polygons will be split at the specified breaks. If they are not split, each break value gets a polygon starting from the start facility. If they are split at break values, then each polygon is like a donut (i.e., starts at the previous break value and ends at the next break value).

Product Availability

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

Specified by:
isSplitPolygonsAtBreaks in interface INAServiceAreaSolver
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSplitPolygonsAtBreaks

public void setSplitPolygonsAtBreaks(boolean value)
                              throws IOException,
                                     AutomationException
Indicates if polygons should be split at break values.

Remarks

SplitPolygonsAtBreaks specifies to the solver if the service area polygons will be split at the specified breaks. If they are not split then each break value gets a polygon starting from the start facility. If they are split at break values, then each polygon is like a donut (i.e. starts at the previous break value and ends at the next break value).

Product Availability

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

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

isOverlapLines

public boolean isOverlapLines()
                       throws IOException,
                              AutomationException
Indicates if lines should overlap from multiple facilities.

Remarks

OverlapLines specifies if the service area lines of two or more facilities will overlap and return coincident features.

A break value of 3.0 minutes will return all of the lines that can be reached within 3.0 minutes of the facility. If OverlapLines is set to false then only the line to the closest facility will be returned. In cases where parts of a line correspond to different facilities, the single line will be split and the two resulting lines will be apportioned appropriately.

Product Availability

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

Specified by:
isOverlapLines in interface INAServiceAreaSolver
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverlapLines

public void setOverlapLines(boolean value)
                     throws IOException,
                            AutomationException
Indicates if lines should overlap from multiple facilities.

Remarks

OverlapLines specifies if the service area lines of two or more facilities will overlap and return coincident features.

A break value of 3.0 minutes will return all of the lines that can be reached within 3.0 minutes of the facility. If OverlapLines is set to false then only the line to the closest facility will be returned. In cases where parts of a line correspond to different facilities, the single line will be split and the two resulting lines will be apportioned appropriately.

Product Availability

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

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

getExcludeSourcesFromPolygons

public IStringArray getExcludeSourcesFromPolygons()
                                           throws IOException,
                                                  AutomationException
A collection of network source names to NOT use when generating polygons.

Remarks

ExcludeSourcesFromPolygons specifies if certain network sources should be excluded from the service area polygon generation. A service area on a multi-modal network where only one mode is being used to compute the service area would get a more appropriate shape if other modes are excluded from the polygons.

Product Availability

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

Specified by:
getExcludeSourcesFromPolygons in interface INAServiceAreaSolver
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludeSourcesFromPolygons

public void setExcludeSourcesFromPolygons(IStringArray networkSourceNames)
                                   throws IOException,
                                          AutomationException
A collection of network source names to NOT use when generating polygons.

Remarks

ExcludeSourcesFromPolygons specifies if certain network sources should be excluded from the service area polygon generation. A service area on a multi-modal network where only one mode is being used to compute the service area would get a more appropriate shape if other modes are excluded from the polygons.

Product Availability

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

Specified by:
setExcludeSourcesFromPolygons in interface INAServiceAreaSolver
Parameters:
networkSourceNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMergeSimilarPolygonRanges

public boolean isMergeSimilarPolygonRanges()
                                    throws IOException,
                                           AutomationException
Indicates if similar ranges should be merged in the result polygons.

Remarks

MergeSimillarPolygons specifies if polygons with same break values from different facilities should be merged together.

Product Availability

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

Specified by:
isMergeSimilarPolygonRanges in interface INAServiceAreaSolver
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMergeSimilarPolygonRanges

public void setMergeSimilarPolygonRanges(boolean value)
                                  throws IOException,
                                         AutomationException
Indicates if similar ranges should be merged in the result polygons.

Remarks

MergeSimillarPolygons specifies if polygons with same break values from different facilities should be merged together.

Product Availability

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

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

isSplitLinesAtBreaks

public boolean isSplitLinesAtBreaks()
                             throws IOException,
                                    AutomationException
Indicates if lines should be split at breaks.

Remarks

SplitLinesAtBreaks specifies if the service area lines will be split at the break values.

A service area with a set of break values like 2.0, 4.0, 6.0 will normally only return each edge in the input network with its from and to cumulative cost attribute. If this property is set to true, service area lines are also split at the location where the actual value of the break is reached.

Product Availability

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

Specified by:
isSplitLinesAtBreaks in interface INAServiceAreaSolver
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSplitLinesAtBreaks

public void setSplitLinesAtBreaks(boolean value)
                           throws IOException,
                                  AutomationException
Indicates if lines should be split at breaks.

Remarks

SplitLinesAtBreaks specifies if the service area lines will be split at the break values.

A service area with a set of break values like 2.0, 4.0, 6.0 will normally only return each edge in the input network with its from and to cumulative cost attribute. If this property is set to true, service area lines are also split at the location where the actual value of the break is reached.

Product Availability

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

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

getOutputPolygons

public int getOutputPolygons()
                      throws IOException,
                             AutomationException
The type of polygon(s) generated.

Remarks

OutputPolygons specifies if the service area polygons should be generated or not.

If they are to be generated, it specifies the type of polygons to be generated. For example, the choice could be simplified, detailed, or none. The detailed option accurately models the service area lines and may contain islands of unreached areas. The simplified option runs faster but is not as accurate at some fringes.

Product Availability

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

Specified by:
getOutputPolygons in interface INAServiceAreaSolver
Returns:
A com.esri.arcgis.networkanalyst.esriNAOutputPolygonType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputPolygons

public void setOutputPolygons(int value)
                       throws IOException,
                              AutomationException
The type of polygon(s) generated.

Remarks

OutputPolygons specifies if the service area polygons should be generated or not.

If they are to be generated it specifies the type of polygons to be generated. For example, the choice could be simplified, detailed or none. The detailed option accurately models the service area lines and may contain islands of unreached areas. The simplified option runs faster but is not as accurate at some fringes.

Product Availability

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

Specified by:
setOutputPolygons in interface INAServiceAreaSolver
Parameters:
value - A com.esri.arcgis.networkanalyst.esriNAOutputPolygonType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputLines

public int getOutputLines()
                   throws IOException,
                          AutomationException
The type of line(s) generated.

Remarks

OutputLines specifies the type of lines to be generated by the service area solver. The choice is to the generate the lines with or without measures or to generate no lines.

Product Availability

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

Specified by:
getOutputLines in interface INAServiceAreaSolver
Returns:
A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputLines

public void setOutputLines(int value)
                    throws IOException,
                           AutomationException
The type of line(s) generated.

Remarks

OutputLines specifies the type of lines to be generated by the service area solver. The choice is to the generate the lines with or without measures or to generate no lines.

Product Availability

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

Specified by:
setOutputLines in interface INAServiceAreaSolver
Parameters:
value - A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverlapPolygons

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

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

isOverlapPolygons

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

Specified by:
isOverlapPolygons in interface INAServiceAreaSolver2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIncludeSourceInformationOnLines

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

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

isIncludeSourceInformationOnLines

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

Specified by:
isIncludeSourceInformationOnLines in interface INAServiceAreaSolver2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrimOuterPolygon

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

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

isTrimOuterPolygon

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

Specified by:
isTrimOuterPolygon in interface INAServiceAreaSolver2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrimPolygonDistance

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

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

getTrimPolygonDistance

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

Specified by:
getTrimPolygonDistance in interface INAServiceAreaSolver2
Returns:
The distance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrimPolygonDistanceUnits

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

Specified by:
setTrimPolygonDistanceUnits in interface INAServiceAreaSolver2
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

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

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

setCreateTraversalResult

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

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

isCreateTraversalResult

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

Product Availability

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

Specified by:
isCreateTraversalResult in interface INAServiceAreaSolver2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException