com.esri.arcgis.networkanalyst
Class NAServerLocationAllocationParams

java.lang.Object
  extended by com.esri.arcgis.networkanalyst.NAServerLocationAllocationParams
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INALocationAllocationSolver, INAServerLocationAllocationParams, INAServerSolverParams, INAServerSolverParams2, INASolverSettings, INASolverSettings2, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NAServerLocationAllocationParams
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerSolverParams2, INAServerLocationAllocationParams, INASolverSettings, INASolverSettings2, INALocationAllocationSolver, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable

A container for the Location-Allocation solver settings and return parameters used by NAServer.

Remarks

NAServerLocationAllocationParams 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
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INASolverSettings
IID5a8dc105_0e57_45c8_a01d_0188ce7f7b52
 
Constructor Summary
NAServerLocationAllocationParams()
          Constructs a NAServerLocationAllocationParams using ArcGIS Engine.
NAServerLocationAllocationParams(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerLocationAllocationParams theNAServerLocationAllocationParams = (NAServerLocationAllocationParams) 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.
 Object getDefaultCutoff()
          Determines the default cutoff beyond which no demand point can be allocated to a facility
 INAServerLocations getDemandPoints()
          RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.
 INAServerLocations getFacilities()
          RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
 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.
 int getImpedanceTransformation()
          Determines which formula will modify the impedance.
 String getLayerToken()
          Token identifying the network analysis layer on the server to use.
 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 getNumberFacilitiesToLocate()
          Determines how many facilities will be present in the solution.
 int getNumTransitionToHierarchy(int toLevel)
          The number of lower level junctions to explore before searching the next hierarchy level.
 int getOutputLines()
          Specifies what if any shape geometry will be output
 ISpatialReference getOutputSpatialReference()
          Spatial reference of the geometries returned with the analysis results.
 INAServerLocations getPolygonBarriers()
          RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
 INAServerLocations getPolylineBarriers()
          RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
 int getProblemType()
          Specifies which location-allocation problem type to solve.
 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.
 double getTargetMarketSharePercentage()
          Applies to the target market share problem, the minimum number of facilites will be placed to obtain the target market share.
 double getTransformationParameter()
          Applies to the impedance transformation.
 int getTravelDirection()
          Specifies which direction the network will be traversed
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void isDirty()
          isDirty
 boolean isIgnoreInvalidLocations()
          Indicates if invalid locations should be ignored or raise an error.
 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 isReturnDemandPoints()
          Indicates if the output DemandPoints recordset should be returned with the analysis results.
 boolean isReturnFacilities()
          Indicates if the output Facilities recordset should be returned with the analysis results.
 boolean isReturnLALines()
          Indicates if the output LALines recordset should be returned with the analysis results.
 boolean isReturnMap()
          Indicates if a MapImage should be generated and returned with the analysis results.
 boolean isReturnPartialResultsOnError()
          Indicates if the result object should be returned even if an error was generated during the solve operation.
 boolean isReturnPolygonBarriers()
          Indicates if the output polygon barriers recordset should be returned with the analysis results.
 boolean isReturnPolylineBarriers()
          Indicates if the output polyline barriers recordset should be returned with the analysis results.
 boolean isSaveLayerOnServer()
          Indicates if the resulting analysis layer should be saved on the server.
 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 setDefaultCutoff(Object value)
          Determines the default cutoff beyond which no demand point can be allocated to a facility
 void setDemandPointsByRef(INAServerLocations demandPoints)
          RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.
 void setFacilitiesByRef(INAServerLocations facilities)
          RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
 void 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 setImpedanceTransformation(int value)
          Determines which formula will modify the impedance.
 void setLayerToken(String layerToken)
          Token identifying the network analysis layer on the server to use.
 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 setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
          Array of NAClassCandidateFieldMaps .
 void setNALayerName(String nALayerName)
          Network analysis layer name.
 void setNumberFacilitiesToLocate(int value)
          Determines how many facilities will be present in the solution.
 void setNumTransitionToHierarchy(int toLevel, int value)
          The number of lower level junctions to explore before searching the next hierarchy level.
 void setOutputLines(int value)
          Specifies what if any shape geometry will be output
 void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
          Spatial reference of the geometries returned with the analysis results.
 void setPolygonBarriersByRef(INAServerLocations polygonBarriers)
          RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
 void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
          RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
 void setProblemType(int value)
          Specifies which location-allocation problem type to solve.
 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 setReturnDemandPoints(boolean returnDemandPoints)
          Indicates if the output DemandPoints recordset should be returned with the analysis results.
 void setReturnFacilities(boolean returnFacilities)
          Indicates if the output Facilities recordset should be returned with the analysis results.
 void setReturnLALines(boolean returnLALines)
          Indicates if the output LALines recordset should be returned with the analysis results.
 void setReturnMap(boolean returnMap)
          Indicates if a MapImage should be generated and returned with the analysis results.
 void setReturnPartialResultsOnError(boolean returnPartialResultsOnError)
          Indicates if the result object should be returned even if an error was generated during the solve operation.
 void setReturnPolygonBarriers(boolean returnBarriers)
          Indicates if the output polygon barriers recordset should be returned with the analysis results.
 void setReturnPolylineBarriers(boolean returnBarriers)
          Indicates if the output polyline barriers recordset should be returned with the analysis results.
 void setSaveLayerOnServer(boolean saveLayerOnServer)
          Indicates if the resulting analysis layer should be saved on the server.
 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 setTargetMarketSharePercentage(double value)
          Applies to the target market share problem, the minimum number of facilites will be placed to obtain the target market share.
 void setTransformationParameter(double value)
          Applies to the impedance transformation.
 void setTravelDirection(int value)
          Specifies which direction the network will be traversed
 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

NAServerLocationAllocationParams

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

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

NAServerLocationAllocationParams

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

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

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.

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.

setReturnPartialResultsOnError

public void setReturnPartialResultsOnError(boolean returnPartialResultsOnError)
                                    throws IOException,
                                           AutomationException
Indicates if the result object should be returned even if an error was generated during the solve operation.

Remarks

ReturnPartialResultsOnError: in cases when Solve fails, it allows to get available results objects back. For example, if less than two Stops were located, Route Solve operation can still return NAServerRouteResults object with Stops recordset populated.

Product Availability

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

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

isReturnPartialResultsOnError

public boolean isReturnPartialResultsOnError()
                                      throws IOException,
                                             AutomationException
Indicates if the result object should be returned even if an error was generated during the solve operation.

Product Availability

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

Specified by:
isReturnPartialResultsOnError in interface INAServerSolverParams2
Returns:
The returnPartialResultsOnError
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSaveLayerOnServer

public void setSaveLayerOnServer(boolean saveLayerOnServer)
                          throws IOException,
                                 AutomationException
Indicates if the resulting analysis layer should be saved on the server.

Remarks

SaveLayerOnServer indicates if the network analysis layer should be saved on server for future reuse. If True, the NAServerSolverResults.LayerToken property will contain token assigned to the saved layer on server. In order to reuse this layer, set returned token value on NAServerSolverParams.LayerToken in subsequent requests.

Product Availability

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

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

isSaveLayerOnServer

public boolean isSaveLayerOnServer()
                            throws IOException,
                                   AutomationException
Indicates if the resulting analysis layer should be saved on the server.

Product Availability

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

Specified by:
isSaveLayerOnServer in interface INAServerSolverParams2
Returns:
The saveLayerOnServer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerToken

public void setLayerToken(String layerToken)
                   throws IOException,
                          AutomationException
Token identifying the network analysis layer on the server to use.

Remarks

LayerToken contains token corresponding to an existing network analysis layer saved on the server to use during Solve rather than the default network analysis layer. The token value to use can be retrieved from NAServerSolverResults.LayerToken that was returned from a previous call to Solve with NAServerSolverParams.SaveLayerOnServer set to True.

Product Availability

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

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

getLayerToken

public String getLayerToken()
                     throws IOException,
                            AutomationException
Token identifying the network analysis layer on the server to use.

Product Availability

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

Specified by:
getLayerToken in interface INAServerSolverParams2
Returns:
The layerToken
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 an instance of NAServerLocations class to take into account when solving a Location-Allocation problem.

Product Availability

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

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

Product Availability

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

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

setDemandPointsByRef

public void setDemandPointsByRef(INAServerLocations demandPoints)
                          throws IOException,
                                 AutomationException
RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.

Remarks

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

Product Availability

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

Specified by:
setDemandPointsByRef in interface INAServerLocationAllocationParams
Parameters:
demandPoints - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDemandPoints

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

Product Availability

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

Specified by:
getDemandPoints in interface INAServerLocationAllocationParams
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 an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

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

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

Product Availability

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

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

setPolylineBarriersByRef

public void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
                              throws IOException,
                                     AutomationException
RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Remarks

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

Product Availability

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

Specified by:
setPolylineBarriersByRef in interface INAServerLocationAllocationParams
Parameters:
polylineBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolylineBarriers

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

Product Availability

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

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

setPolygonBarriersByRef

public void setPolygonBarriersByRef(INAServerLocations polygonBarriers)
                             throws IOException,
                                    AutomationException
RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Remarks

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

Product Availability

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

Specified by:
setPolygonBarriersByRef in interface INAServerLocationAllocationParams
Parameters:
polygonBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonBarriers

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

Product Availability

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

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

setReturnLALines

public void setReturnLALines(boolean returnLALines)
                      throws IOException,
                             AutomationException
Indicates if the output LALines recordset should be returned with the analysis results.

Remarks

ReturnLALines specifies if the resulting LALines features are returned.

Product Availability

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

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

isReturnLALines

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

Product Availability

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

Specified by:
isReturnLALines in interface INAServerLocationAllocationParams
Returns:
The returnLALines
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 INAServerLocationAllocationParams
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.

Product Availability

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

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

setReturnDemandPoints

public void setReturnDemandPoints(boolean returnDemandPoints)
                           throws IOException,
                                  AutomationException
Indicates if the output DemandPoints recordset should be returned with the analysis results.

Remarks

ReturnDemandPoints specifies if the resulting DemandPoints features are returned.

Product Availability

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

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

isReturnDemandPoints

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

Product Availability

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

Specified by:
isReturnDemandPoints in interface INAServerLocationAllocationParams
Returns:
The returnDemandPoints
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 Barriers are returned.

Product Availability

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

Specified by:
setReturnBarriers in interface INAServerLocationAllocationParams
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.

Product Availability

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

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

setReturnPolylineBarriers

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

Remarks

ReturnPolylineBarriers specifies if the PolylineBarriers are returned.

Product Availability

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

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

isReturnPolylineBarriers

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

Product Availability

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

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

setReturnPolygonBarriers

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

Remarks

ReturnPolygonBarriers specifies if the PolygonBarriers are returned.

Product Availability

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

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

isReturnPolygonBarriers

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

Product Availability

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

Specified by:
isReturnPolygonBarriers in interface INAServerLocationAllocationParams
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.

setTravelDirection

public void setTravelDirection(int value)
                        throws IOException,
                               AutomationException
Specifies which direction the network will be traversed

Remarks

TravelDirection can be set to travel from the facility (default) or travel to the facility. This can make a difference in finding the closest facility to a demand point if there are oneway restrictions, turn restrictions, or different travel cost attributes for each side of the street in the network. This property sets and gets the travel direction for the NALocationAllocationSolver.

Product Availability

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

Specified by:
setTravelDirection in interface INALocationAllocationSolver
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.

getTravelDirection

public int getTravelDirection()
                       throws IOException,
                              AutomationException
Specifies which direction the network will be traversed

Remarks

TravelDirection can be set to travel from the facility (default) or travel to the facility. This can make a difference in finding the closest facility to a demand point if there are oneway restrictions, turn restrictions, or different travel cost attributes for each side of the street in the network. This property sets and gets the travel direction for the NALocationAllocationSolver.

Product Availability

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

Specified by:
getTravelDirection in interface INALocationAllocationSolver
Returns:
A com.esri.arcgis.networkanalyst.esriNATravelDirection 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
Specifies what if any shape geometry will be output

Remarks

OutputLines specifies the type of lines to be generated by the location-allocation solver. The choice is to generate straight lines, or to generate no lines. This property sets and gets the output line type for the NALocationAllocationSolver.

Product Availability

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

Specified by:
setOutputLines in interface INALocationAllocationSolver
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.

getOutputLines

public int getOutputLines()
                   throws IOException,
                          AutomationException
Specifies what if any shape geometry will be output

Remarks

OutputLines specifies the type of lines to be generated by the location-allocation solver. The choice is to generate straight lines, or to generate no lines. This property sets and gets the output line type for the NALocationAllocationSolver.

Product Availability

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

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

setProblemType

public void setProblemType(int value)
                    throws IOException,
                           AutomationException
Specifies which location-allocation problem type to solve.

Remarks

ProblemType specifies the type of problem to be solved by the NALocationAllocationSolver.

The choices for the problem type are available via the enum esriNALocationAllocationProblemType are MinimizeWeightedImpedance, MaximizeCoverage, MaximizeCoverageMinimizeFacilities, MaximizeAttendance, MaximizeMarketShare, and TargetMarketShare. This property sets or gets the problem type for the NALocationAllocationSolver.

Product Availability

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

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

getProblemType

public int getProblemType()
                   throws IOException,
                          AutomationException
Specifies which location-allocation problem type to solve.

Remarks

ProblemType specifies the type of problem to be solved by the NALocationAllocationSolver.

The choices for the problem type are available via the enum esriNALocationAllocationProblemType are MinimizeWeightedImpedance, MaximizeCoverage, MaximizeCoverageMinimizeFacilities, MaximizeAttendance, MaximizeMarketShare, and TargetMarketShare. This property sets or gets the problem type for the NALocationAllocationSolver.

Product Availability

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

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

getNumberFacilitiesToLocate

public int getNumberFacilitiesToLocate()
                                throws IOException,
                                       AutomationException
Determines how many facilities will be present in the solution.

Remarks

The NumberFacilitiesToLocate specifies how many facilities to locate from the existing facilities. Solving for 10 facilities will select the 10 best sites from the existing facilities. Facilities with esriNALocationAllocationFacilityType of esriNALAFTRequired will be chosen before facilities with a status of esriNALAFTCandidate are selected. An error is returned if the number of facilities to locate is less than the number of required facilities.

Product Availability

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

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

setNumberFacilitiesToLocate

public void setNumberFacilitiesToLocate(int value)
                                 throws IOException,
                                        AutomationException
Determines how many facilities will be present in the solution.

Remarks

The NumberFacilitiesToLocate specifies how many facilities to locate from the existing facilities. Solving for 10 facilities will select the 10 best sites from the existing facilities. Facilities with esriNALocationAllocationFacilityType of esriNALAFTRequired will be chosen before facilities with a status of esriNALAFTCandidate are selected. An error is returned if the number of facilities to locate is less than the number of required facilities.

Product Availability

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

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

getDefaultCutoff

public Object getDefaultCutoff()
                        throws IOException,
                               AutomationException
Determines the default cutoff beyond which no demand point can be allocated to a facility

Remarks

The DefaultCutoff specifies how far a facility should look to allocate demand points. Any facilities further than the default cutoff are not evaluated. Individual demand points can override this setting with their own cutoff length.

The MaximizeAttendance problem type does not require a cutoff. All other problem types require a cutoff to be specified.

Product Availability

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

Specified by:
getDefaultCutoff in interface INALocationAllocationSolver
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultCutoff

public void setDefaultCutoff(Object value)
                      throws IOException,
                             AutomationException
Determines the default cutoff beyond which no demand point can be allocated to a facility

Remarks

The DefaultCutoff specifies how far a facility should look to allocate demand points. Any facilities further than the default cutoff are not evaluated. Individual demand points can override this setting with their own cutoff length.

The MaximizeAttendance problem type does not require a cutoff. All other problem types require a cutoff to be specified.

Product Availability

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

Specified by:
setDefaultCutoff in interface INALocationAllocationSolver
Parameters:
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImpedanceTransformation

public int getImpedanceTransformation()
                               throws IOException,
                                      AutomationException
Determines which formula will modify the impedance.

Remarks

The ImpedanceTransformation specifies the type of scaling to be performed on the results of the OD Cost Matrix computed between the facilities and the demand points. The options for the distance scaling are linear, power and exponential and they can be specified by using the esriNAImpedanceTransformationType enum.

The amount of scaling for each transformation is specified by the TransformationParameter.

Product Availability

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

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

setImpedanceTransformation

public void setImpedanceTransformation(int value)
                                throws IOException,
                                       AutomationException
Determines which formula will modify the impedance.

Remarks

The ImpedanceTransformation specifies the type of scaling to be performed on the results of the OD Cost Matrix computed between the facilities and the demand points. The options for the distance scaling are linear, power and exponential and they can be specified by using the esriNAImpedanceTransformationType enum.

The amount of scaling for each transformation is specified by the TransformationParameter.

Product Availability

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

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

getTransformationParameter

public double getTransformationParameter()
                                  throws IOException,
                                         AutomationException
Applies to the impedance transformation.

Remarks

The TransformationParameter specifies the amount of scaling to be done on the distances computed between the facilities and demand points. It type of transformation to be applied is specified by the ImpedanceTransformation.

Product Availability

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

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

setTransformationParameter

public void setTransformationParameter(double value)
                                throws IOException,
                                       AutomationException
Applies to the impedance transformation.

Remarks

The TransformationParameter specifies the amount of scaling to be done on the distances computed between the facilities and demand points. It type of transformation to be applied is specified by the ImpedanceTransformation.

Product Availability

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

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

getTargetMarketSharePercentage

public double getTargetMarketSharePercentage()
                                      throws IOException,
                                             AutomationException
Applies to the target market share problem, the minimum number of facilites will be placed to obtain the target market share.

Remarks

The TargetMarketSharePercentage specifies the target market share to achieve by the esriNALAPTTargetMarketShare problem type. The Location-Allocation solver finds the minimum number of facilities needed to achieve this market share. The market share is determined by using a Huff (gravity) model. If the target market share can not be achieved then it locates as many facilities to attain the maximum target share possible.

Product Availability

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

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

setTargetMarketSharePercentage

public void setTargetMarketSharePercentage(double value)
                                    throws IOException,
                                           AutomationException
Applies to the target market share problem, the minimum number of facilites will be placed to obtain the target market share.

Remarks

The TargetMarketSharePercentage specifies the target market share to achieve by the esriNALAPTTargetMarketShare problem type. The Location-Allocation solver finds the minimum number of facilities needed to achieve this market share. The market share is determined by using a Huff (gravity) model. If the target market share can not be achieved then it locates as many facilities to attain the maximum target share possible.

Product Availability

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

Specified by:
setTargetMarketSharePercentage in interface INALocationAllocationSolver
Parameters:
value - The value (in)
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