com.esri.arcgis.networkanalyst.NAServerLocationAllocationParams
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class NAServerLocationAllocationParams
Deprecated as of 10.0. A container for the Location-Allocation solver settings and return parameters used by NAServer.
At version 10.1, ArcGIS for Server no longer supports performing network analysis via local connections using the GISServer and GISClient APIs. Use the SOAP or REST API instead.
NAServerLocationAllocationParams is used to pass solver settings and return parameters to the NAServer when performing stateless network analysis.
| 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. |
Date |
getTimeOfDay()
The date-time value used in time-aware solvers. |
int |
getTimeOfDayUsage()
The usage type for the TimeOfDay property. |
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 |
setTimeOfDay(Date timeOfDay)
The date-time value used in time-aware solvers. |
void |
setTimeOfDayUsage(int timeOfDayUsage)
The usage type for the TimeOfDay property. |
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 |
|---|
public NAServerLocationAllocationParams()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public NAServerLocationAllocationParams(Object obj)
throws IOException
NAServerLocationAllocationParams theNAServerLocationAllocationParams = (NAServerLocationAllocationParams) obj;
obj to NAServerLocationAllocationParams.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void setNALayerName(String nALayerName)
throws IOException,
AutomationException
NALayerName specifies the Network Analyst Layer Name used within this NAContext.
setNALayerName in interface INAServerSolverParamsnALayerName - The nALayerName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getNALayerName()
throws IOException,
AutomationException
NALayerName specifies the Network Analyst Layer Name used within this NAContext.
getNALayerName in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSnapTolerance(double snapTolerance)
throws IOException,
AutomationException
SnapTolerance specifies the minimum search tolerance used when finding network locations.
setSnapTolerance in interface INAServerSolverParamssnapTolerance - The snapTolerance (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getSnapTolerance()
throws IOException,
AutomationException
SnapTolerance specifies the minimum search tolerance used when finding network locations.
getSnapTolerance in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaxSnapTolerance(double maxSnapTolerance)
throws IOException,
AutomationException
MaxSnapTolerance specifies the maximum search tolerance used when finding network locations.
setMaxSnapTolerance in interface INAServerSolverParamsmaxSnapTolerance - The maxSnapTolerance (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMaxSnapTolerance()
throws IOException,
AutomationException
MaxSnapTolerance specifies the maximum search tolerance used when finding network locations.
getMaxSnapTolerance in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSnapToleranceUnits(int snapToleranceUnits)
throws IOException,
AutomationException
SnapToleranceUnits specifies the units of the search tolerance in esriUnits type.
setSnapToleranceUnits in interface INAServerSolverParamssnapToleranceUnits - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSnapToleranceUnits()
throws IOException,
AutomationException
getSnapToleranceUnits in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
throws IOException,
AutomationException
NAClassCandidateFieldMaps specifies the candidate fields for each NAClass. These field maps are used when loading network locations to map input fields with NAClass fields.
setNAClassCandidateFieldMaps in interface INAServerSolverParamsppNAClassCandidateFieldMaps - A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
throws IOException,
AutomationException
NAClassCandidateFieldMaps specifies the candidate fields for each NAClass. These field maps are used when loading network locations to map input fields with NAClass fields.
getNAClassCandidateFieldMaps in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnMap(boolean returnMap)
throws IOException,
AutomationException
ReturnMap specifies if the map is returned by the solve.
setReturnMap in interface INAServerSolverParamsreturnMap - The returnMap (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnMap()
throws IOException,
AutomationException
ReturnMap specifies if the map is returned by the solve.
isReturnMap in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMapDescriptionByRef(IMapDescription mapDescription)
throws IOException,
AutomationException
MapDescription specifies the MapDescription object to use when drawing the map with the analysis results.
setMapDescriptionByRef in interface INAServerSolverParamsmapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IMapDescription getMapDescription()
throws IOException,
AutomationException
MapDescription specifies the MapDescription object to use when drawing the map with the analysis results.
getMapDescription in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setImageDescriptionByRef(IImageDescription imageDescription)
throws IOException,
AutomationException
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
setImageDescriptionByRef in interface INAServerSolverParamsimageDescription - A reference to a com.esri.arcgis.carto.IImageDescription (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IImageDescription getImageDescription()
throws IOException,
AutomationException
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
getImageDescription in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
throws IOException,
AutomationException
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.
setOutputSpatialReferenceByRef in interface INAServerSolverParamsspatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISpatialReference getOutputSpatialReference()
throws IOException,
AutomationException
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.
getOutputSpatialReference in interface INAServerSolverParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnPartialResultsOnError(boolean returnPartialResultsOnError)
throws IOException,
AutomationException
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.
setReturnPartialResultsOnError in interface INAServerSolverParams2returnPartialResultsOnError - The returnPartialResultsOnError (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnPartialResultsOnError()
throws IOException,
AutomationException
isReturnPartialResultsOnError in interface INAServerSolverParams2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSaveLayerOnServer(boolean saveLayerOnServer)
throws IOException,
AutomationException
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.
setSaveLayerOnServer in interface INAServerSolverParams2saveLayerOnServer - The saveLayerOnServer (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSaveLayerOnServer()
throws IOException,
AutomationException
isSaveLayerOnServer in interface INAServerSolverParams2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLayerToken(String layerToken)
throws IOException,
AutomationException
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.
setLayerToken in interface INAServerSolverParams2layerToken - The layerToken (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getLayerToken()
throws IOException,
AutomationException
getLayerToken in interface INAServerSolverParams2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFacilitiesByRef(INAServerLocations facilities)
throws IOException,
AutomationException
Facilities specifies an instance of NAServerLocations class to take into account when solving a Location-Allocation problem.
setFacilitiesByRef in interface INAServerLocationAllocationParamsfacilities - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INAServerLocations getFacilities()
throws IOException,
AutomationException
getFacilities in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDemandPointsByRef(INAServerLocations demandPoints)
throws IOException,
AutomationException
DemandPoints specifies an instance of NAServerLocations class to take into account when solving a Location-Allocation problem.
setDemandPointsByRef in interface INAServerLocationAllocationParamsdemandPoints - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INAServerLocations getDemandPoints()
throws IOException,
AutomationException
getDemandPoints in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBarriersByRef(INAServerLocations barriers)
throws IOException,
AutomationException
Barriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.
setBarriersByRef in interface INAServerLocationAllocationParamsbarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INAServerLocations getBarriers()
throws IOException,
AutomationException
getBarriers in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
throws IOException,
AutomationException
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.
setPolylineBarriersByRef in interface INAServerLocationAllocationParamspolylineBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INAServerLocations getPolylineBarriers()
throws IOException,
AutomationException
getPolylineBarriers in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPolygonBarriersByRef(INAServerLocations polygonBarriers)
throws IOException,
AutomationException
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.
setPolygonBarriersByRef in interface INAServerLocationAllocationParamspolygonBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INAServerLocations getPolygonBarriers()
throws IOException,
AutomationException
getPolygonBarriers in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnLALines(boolean returnLALines)
throws IOException,
AutomationException
ReturnLALines specifies if the resulting LALines features are returned.
setReturnLALines in interface INAServerLocationAllocationParamsreturnLALines - The returnLALines (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnLALines()
throws IOException,
AutomationException
isReturnLALines in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnFacilities(boolean returnFacilities)
throws IOException,
AutomationException
ReturnFacilities specifies if the resulting Facility features are returned.
setReturnFacilities in interface INAServerLocationAllocationParamsreturnFacilities - The returnFacilities (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnFacilities()
throws IOException,
AutomationException
isReturnFacilities in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnDemandPoints(boolean returnDemandPoints)
throws IOException,
AutomationException
ReturnDemandPoints specifies if the resulting DemandPoints features are returned.
setReturnDemandPoints in interface INAServerLocationAllocationParamsreturnDemandPoints - The returnDemandPoints (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnDemandPoints()
throws IOException,
AutomationException
isReturnDemandPoints in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnBarriers(boolean returnBarriers)
throws IOException,
AutomationException
ReturnBarriers specifies if the Barriers are returned.
setReturnBarriers in interface INAServerLocationAllocationParamsreturnBarriers - The returnBarriers (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnBarriers()
throws IOException,
AutomationException
isReturnBarriers in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnPolylineBarriers(boolean returnBarriers)
throws IOException,
AutomationException
ReturnPolylineBarriers specifies if the PolylineBarriers are returned.
setReturnPolylineBarriers in interface INAServerLocationAllocationParamsreturnBarriers - The returnBarriers (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnPolylineBarriers()
throws IOException,
AutomationException
isReturnPolylineBarriers in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnPolygonBarriers(boolean returnBarriers)
throws IOException,
AutomationException
ReturnPolygonBarriers specifies if the PolygonBarriers are returned.
setReturnPolygonBarriers in interface INAServerLocationAllocationParamsreturnBarriers - The returnBarriers (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnPolygonBarriers()
throws IOException,
AutomationException
isReturnPolygonBarriers in interface INAServerLocationAllocationParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IStringArray getAccumulateAttributeNames()
throws IOException,
AutomationException
getAccumulateAttributeNames in interface INASolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAccumulateAttributeNamesByRef(IStringArray attributeNames)
throws IOException,
AutomationException
setAccumulateAttributeNamesByRef in interface INASolverSettingsattributeNames - A reference to a com.esri.arcgis.system.IStringArray (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setImpedanceAttributeName(String attributeName)
throws IOException,
AutomationException
setImpedanceAttributeName in interface INASolverSettingsattributeName - The attributeName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getImpedanceAttributeName()
throws IOException,
AutomationException
getImpedanceAttributeName in interface INASolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setIgnoreInvalidLocations(boolean ignoreInvalidLocations)
throws IOException,
AutomationException
setIgnoreInvalidLocations in interface INASolverSettingsignoreInvalidLocations - The ignoreInvalidLocations (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIgnoreInvalidLocations()
throws IOException,
AutomationException
isIgnoreInvalidLocations in interface INASolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IStringArray getRestrictionAttributeNames()
throws IOException,
AutomationException
getRestrictionAttributeNames in interface INASolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRestrictionAttributeNamesByRef(IStringArray attributeName)
throws IOException,
AutomationException
setRestrictionAttributeNamesByRef in interface INASolverSettingsattributeName - A reference to a com.esri.arcgis.system.IStringArray (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRestrictUTurns(int backtrack)
throws IOException,
AutomationException
setRestrictUTurns in interface INASolverSettingsbacktrack - A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getRestrictUTurns()
throws IOException,
AutomationException
getRestrictUTurns in interface INASolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseHierarchy(boolean useHierarchy)
throws IOException,
AutomationException
setUseHierarchy in interface INASolverSettingsuseHierarchy - The useHierarchy (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUseHierarchy()
throws IOException,
AutomationException
isUseHierarchy in interface INASolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setHierarchyAttributeName(String attributeName)
throws IOException,
AutomationException
setHierarchyAttributeName in interface INASolverSettingsattributeName - The attributeName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getHierarchyAttributeName()
throws IOException,
AutomationException
getHierarchyAttributeName in interface INASolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setHierarchyLevelCount(int count)
throws IOException,
AutomationException
setHierarchyLevelCount in interface INASolverSettingscount - The count (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getHierarchyLevelCount()
throws IOException,
AutomationException
getHierarchyLevelCount in interface INASolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaxValueForHierarchy(int level,
int value)
throws IOException,
AutomationException
setMaxValueForHierarchy in interface INASolverSettingslevel - The level (in)value - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getMaxValueForHierarchy(int level)
throws IOException,
AutomationException
getMaxValueForHierarchy in interface INASolverSettingslevel - The level (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNumTransitionToHierarchy(int toLevel,
int value)
throws IOException,
AutomationException
setNumTransitionToHierarchy in interface INASolverSettingstoLevel - The toLevel (in)value - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getNumTransitionToHierarchy(int toLevel)
throws IOException,
AutomationException
getNumTransitionToHierarchy in interface INASolverSettingstoLevel - The toLevel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isResetHierarchyRangesOnBind()
throws IOException,
AutomationException
isResetHierarchyRangesOnBind in interface INASolverSettings2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setResetHierarchyRangesOnBind(boolean value)
throws IOException,
AutomationException
setResetHierarchyRangesOnBind in interface INASolverSettings2value - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getAttributeParameterValue(String attributeName,
String paramName)
throws IOException,
AutomationException
getAttributeParameterValue in interface INASolverSettings2attributeName - The attributeName (in)paramName - The paramName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAttributeParameterValue(String attributeName,
String paramName,
Object value)
throws IOException,
AutomationException
setAttributeParameterValue in interface INASolverSettings2attributeName - The attributeName (in)paramName - The paramName (in)value - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTravelDirection(int value)
throws IOException,
AutomationException
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.
setTravelDirection in interface INALocationAllocationSolvervalue - A com.esri.arcgis.networkanalyst.esriNATravelDirection constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getTravelDirection()
throws IOException,
AutomationException
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.
getTravelDirection in interface INALocationAllocationSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutputLines(int value)
throws IOException,
AutomationException
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.
setOutputLines in interface INALocationAllocationSolvervalue - A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getOutputLines()
throws IOException,
AutomationException
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.
getOutputLines in interface INALocationAllocationSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setProblemType(int value)
throws IOException,
AutomationException
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.
setProblemType in interface INALocationAllocationSolvervalue - A com.esri.arcgis.networkanalyst.esriNALocationAllocationProblemType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getProblemType()
throws IOException,
AutomationException
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.
getProblemType in interface INALocationAllocationSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getNumberFacilitiesToLocate()
throws IOException,
AutomationException
getNumberFacilitiesToLocate in interface INALocationAllocationSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNumberFacilitiesToLocate(int value)
throws IOException,
AutomationException
setNumberFacilitiesToLocate in interface INALocationAllocationSolvervalue - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getDefaultCutoff()
throws IOException,
AutomationException
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 MinimizeImpedance problem type does not require a cutoff. All other problem types require a cutoff to be specified.
getDefaultCutoff in interface INALocationAllocationSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultCutoff(Object value)
throws IOException,
AutomationException
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.
setDefaultCutoff in interface INALocationAllocationSolvervalue - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getImpedanceTransformation()
throws IOException,
AutomationException
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.
getImpedanceTransformation in interface INALocationAllocationSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setImpedanceTransformation(int value)
throws IOException,
AutomationException
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.
setImpedanceTransformation in interface INALocationAllocationSolvervalue - A com.esri.arcgis.networkanalyst.esriNAImpedanceTransformationType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getTransformationParameter()
throws IOException,
AutomationException
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.
getTransformationParameter in interface INALocationAllocationSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTransformationParameter(double value)
throws IOException,
AutomationException
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.
setTransformationParameter in interface INALocationAllocationSolvervalue - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getTargetMarketSharePercentage()
throws IOException,
AutomationException
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.
getTargetMarketSharePercentage in interface INALocationAllocationSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTargetMarketSharePercentage(double value)
throws IOException,
AutomationException
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.
setTargetMarketSharePercentage in interface INALocationAllocationSolvervalue - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Date getTimeOfDay()
throws IOException,
AutomationException
getTimeOfDay in interface INATimeAwareSolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeOfDay(Date timeOfDay)
throws IOException,
AutomationException
TimeOfDay, in conjunction with TimeOfDayUsage, provides the time input to time-aware solvers. The time value is considered local time.
setTimeOfDay in interface INATimeAwareSolverSettingstimeOfDay - The timeOfDay (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getTimeOfDayUsage()
throws IOException,
AutomationException
getTimeOfDayUsage in interface INATimeAwareSolverSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeOfDayUsage(int timeOfDayUsage)
throws IOException,
AutomationException
TimeOfDayUsage specifies how TimeOfDay is used by the solver. Please see esriNATimeOfDayUsage for a description of the possible usage types.
setTimeOfDayUsage in interface INATimeAwareSolverSettingstimeOfDayUsage - A com.esri.arcgis.networkanalyst.esriNATimeOfDayUsage constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void serialize(IXMLSerializeData data)
throws IOException,
AutomationException
serialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deserialize(IXMLSerializeData data)
throws IOException,
AutomationException
deserialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void interfaceSupportsErrorInfo(GUID riid)
throws IOException,
AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getMinNamespaceSupported()
throws IOException,
AutomationException
getMinNamespaceSupported in interface IXMLVersionSupportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||