com.esri.arcgis.networkanalyst.NAServerODCostMatrixParams
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class NAServerODCostMatrixParams
Deprecated as of 10.0. A container for the Origin-Destination Cost Matrix 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.
NAServerODCostMatrixParams 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 | |
|---|---|
NAServerODCostMatrixParams()
Constructs a NAServerODCostMatrixParams using ArcGIS Engine. |
|
NAServerODCostMatrixParams(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. NAServerODCostMatrixParams theNAServerODCostMatrixParams = (NAServerODCostMatrixParams) 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()
The default cutoff value to stop traversing. |
Object |
getDefaultTargetDestinationCount()
The default number of destinations to find. |
INAServerLocations |
getDestinations()
RecordSet or array of PropertySets representing Destinations 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. |
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. |
int |
getMatrixResultType()
Indicates the type of matrix result to be created. |
double |
getMaxSnapTolerance()
Maximum search tolerance used when attempting to load network locations. |
int |
getMaxValueForHierarchy(int level)
The maximum value of the hierarchy attribute. |
String |
getMinNamespaceSupported()
The minimum namespace the class can serialize to (eg the 90 namespace). |
INAClassCandidateFieldMap[] |
getNAClassCandidateFieldMaps()
Array of NAClassCandidateFieldMaps . |
String |
getNALayerName()
Network analysis layer name. |
int |
getNumTransitionToHierarchy(int toLevel)
The number of lower level junctions to explore before searching the next hierarchy level. |
INAServerLocations |
getOrigins()
RecordSet or array of PropertySets representing Origins loaded as network locations during analysis. |
int |
getOutputLines()
Indicates how lines are generated. |
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. |
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. |
Date |
getTimeOfDay()
The date-time value used in time-aware solvers. |
int |
getTimeOfDayUsage()
The usage type for the TimeOfDay property. |
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 |
isPopulateODLines()
Indicates if the ODLines class is to be populated. |
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 |
isReturnDestinations()
Indicates if the output Destinations recordset should be returned with the analysis results. |
boolean |
isReturnMap()
Indicates if a MapImage should be generated and returned with the analysis results. |
boolean |
isReturnODLines()
Indicates if the output ODRoutes recordset should be returned with the analysis results. |
boolean |
isReturnODMatrix()
Indicates if the caluclated OD-values and index arrays should be returned with the analysis results. |
boolean |
isReturnOrigins()
Indicates if the output Origins recordset should be 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)
The default cutoff value to stop traversing. |
void |
setDefaultTargetDestinationCount(Object value)
The default number of destinations to find. |
void |
setDestinationsByRef(INAServerLocations destinations)
RecordSet or array of PropertySets representing Destinations 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 |
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 |
setMatrixResultType(int type)
Indicates the type of matrix result to be created. |
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 |
setNumTransitionToHierarchy(int toLevel,
int value)
The number of lower level junctions to explore before searching the next hierarchy level. |
void |
setOriginsByRef(INAServerLocations origins)
RecordSet or array of PropertySets representing Origins loaded as network locations during analysis. |
void |
setOutputLines(int value)
Indicates how lines are generated. |
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 |
setPopulateODLines(boolean value)
Indicates if the ODLines class is to be populated. |
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 |
setReturnDestinations(boolean returnDestinations)
Indicates if the output Destinations 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 |
setReturnODLines(boolean returnODLines)
Indicates if the output ODRoutes recordset should be returned with the analysis results. |
void |
setReturnODMatrix(boolean returnODMatrix)
Indicates if the caluclated OD-values and index arrays should be returned with the analysis results. |
void |
setReturnOrigins(boolean returnOrigins)
Indicates if the output Origins recordset should be 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 |
setTimeOfDay(Date timeOfDay)
The date-time value used in time-aware solvers. |
void |
setTimeOfDayUsage(int timeOfDayUsage)
The usage type for the TimeOfDay property. |
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 NAServerODCostMatrixParams()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public NAServerODCostMatrixParams(Object obj)
throws IOException
NAServerODCostMatrixParams theNAServerODCostMatrixParams = (NAServerODCostMatrixParams) obj;
obj to NAServerODCostMatrixParams.
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 setOriginsByRef(INAServerLocations origins)
throws IOException,
AutomationException
Origins specifies an instance of NAServerLocations class to take into account when computing Origin-Destination Cost Matrix.
setOriginsByRef in interface INAServerODCostMatrixParamsorigins - 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 getOrigins()
throws IOException,
AutomationException
getOrigins in interface INAServerODCostMatrixParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDestinationsByRef(INAServerLocations destinations)
throws IOException,
AutomationException
Destinations specifies an instance of NAServerLocations class to take into account when computing Origin-Destination Cost Matrix.
setDestinationsByRef in interface INAServerODCostMatrixParamsdestinations - 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 getDestinations()
throws IOException,
AutomationException
getDestinations in interface INAServerODCostMatrixParamsIOException - 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 INAServerODCostMatrixParamsbarriers - 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 INAServerODCostMatrixParamsIOException - 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.
setPolylineBarriersByRef in interface INAServerODCostMatrixParamspolylineBarriers - 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 INAServerODCostMatrixParamsIOException - 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.
setPolygonBarriersByRef in interface INAServerODCostMatrixParamspolygonBarriers - 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 INAServerODCostMatrixParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnODLines(boolean returnODLines)
throws IOException,
AutomationException
ReturnODLines indicates if the origin-destination line features should be returned as a RecordSet.
setReturnODLines in interface INAServerODCostMatrixParamsreturnODLines - The returnODLines (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnODLines()
throws IOException,
AutomationException
isReturnODLines in interface INAServerODCostMatrixParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnOrigins(boolean returnOrigins)
throws IOException,
AutomationException
ReturnOrigins indicates if the origins used during analysis should be returned as a RecordSet.
setReturnOrigins in interface INAServerODCostMatrixParamsreturnOrigins - The returnOrigins (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnOrigins()
throws IOException,
AutomationException
isReturnOrigins in interface INAServerODCostMatrixParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnDestinations(boolean returnDestinations)
throws IOException,
AutomationException
ReturnDestinations indicates if the destinations used during analysis should be returned as a RecordSet.
setReturnDestinations in interface INAServerODCostMatrixParamsreturnDestinations - The returnDestinations (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnDestinations()
throws IOException,
AutomationException
isReturnDestinations in interface INAServerODCostMatrixParamsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReturnODMatrix(boolean returnODMatrix)
throws IOException,
AutomationException
ReturnODMatrix indicates if the ODMatrix result object should be populated and returned.
setReturnODMatrix in interface INAServerODCostMatrixParamsreturnODMatrix - The returnODMatrix (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReturnODMatrix()
throws IOException,
AutomationException
isReturnODMatrix in interface INAServerODCostMatrixParamsIOException - 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 INAServerODCostMatrixParamsreturnBarriers - 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 INAServerODCostMatrixParamsIOException - 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 INAServerODCostMatrixParamsreturnBarriers - 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 INAServerODCostMatrixParamsIOException - 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 INAServerODCostMatrixParamsreturnBarriers - 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 INAServerODCostMatrixParamsIOException - 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 Object getDefaultTargetDestinationCount()
throws IOException,
AutomationException
DefaultTargetDestinationCount specifies the number of destinations to find for the NAODCostMatrixSolver. For example, solving for 10 destinations will return the cost-distance to the 10 closest destinations from each origin.
DefaultTargetDestinationCount is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the TargetDestinationCount field of an individual feature.
DefaultTargetDestinationCount, if not NULL, can be cast as an integer. It is returned as an object/variant in order to allow a NULL value to be used to specify an unlimited default destination count. A DefaultTargetDestinationCount of NULL indicates that a path will be found, if possible, between every origin and every destination.
If a specific origin feature has a non-null value in the TargetDestinationCount field of its NAClass, this value will override the DefaultTargetDestinationCount for that origin.
If an attempt is made to set the DefaultTargetDestinationCount to a non-integer value, it will be rounded to the nearest integer.
getDefaultTargetDestinationCount in interface INAODCostMatrixSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultTargetDestinationCount(Object value)
throws IOException,
AutomationException
DefaultTargetDestinationCount specifies the number of destinations to find for the NAODCostMatrixSolver. For example, solving for 10 destinations will return the cost-distance to the 10 closest destinations from each origin.
DefaultTargetDestinationCount is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the TargetDestinationCount field of an individual feature.
DefaultTargetDestinationCount, if not NULL, can be cast as an integer. It is returned as an object/variant in order to allow a NULL value to be used to specify an unlimited default destination count. A DefaultTargetDestinationCount of NULL indicates that a path will be found, if possible, between every origin and every destination.
If a specific origin feature has a non-null value in the TargetDestinationCount field of its NAClass, this value will override the DefaultTargetDestinationCount for that origin.
If an attempt is made to set the DefaultTargetDestinationCount to a non-integer value, it will be rounded to the nearest integer.
setDefaultTargetDestinationCount in interface INAODCostMatrixSolvervalue - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getDefaultCutoff()
throws IOException,
AutomationException
DefaultCutoff specifies how far to search for the destinations around each origin. For example, setting a default cutoff of 10 miles will only return those destinations within 10 miles from each origin.
DefaultCutoff is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the Cutoff_<attribute name> field of an individual feature.
DefaultCutoff, if not NULL, can be cast as a double. It is returned as an object/variant in order to allow a NULL to be used to specify no default cutoff value. A DefaultCutoff of zero indicates a search distance of zero. A DefaultCutoff of NULL indicates an unlimited search distance.
getDefaultCutoff in interface INAODCostMatrixSolverIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultCutoff(Object value)
throws IOException,
AutomationException
DefaultCutoff specifies how far to search for the destinations around each origin. For example, setting a default cutoff of 10 miles will only return those destinations within 10 miles from each origin.
DefaultCutoff is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the Cutoff_<attribute name> field of an individual feature.
DefaultCutoff, if not NULL, can be cast as a double. It is returned as an object/variant in order to allow a NULL to be used to specify no default cutoff value. A DefaultCutoff of zero indicates a search distance of zero. A DefaultCutoff of NULL indicates an unlimited search distance.
setDefaultCutoff in interface INAODCostMatrixSolvervalue - A Variant (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 that are generated by the NAODCostMatrixSolver object.
The only two valid line types for a NAODCostMatrixSolver are esriNAOutputLineNone or esriNAOutputLineStraight. The determined path from an origin to a destination is a true network path, but the only allowed representation of that path is a straight line or no lines at all.
getOutputLines in interface INAODCostMatrixSolverIOException - 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 that are generated by the NAODCostMatrixSolver object.
The type can be straight lines connecting the origins and destinations or no lines.
setOutputLines in interface INAODCostMatrixSolvervalue - A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getMatrixResultType()
throws IOException,
AutomationException
Specifies what type of a cost matrix is created during a solve.
If the solver is set to produce a matrix (either esriNAODCostMatrixFull or esriNAODCostMatrixUpdate), make sure that the PopulateODLines property is set to False as only one of these can be populated by the solver.
getMatrixResultType in interface INAODCostMatrixSolver2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMatrixResultType(int type)
throws IOException,
AutomationException
Specifies what type of a cost matrix is created during a solve.
If the solver is set to produce a matrix (either esriNAODCostMatrixFull or esriNAODCostMatrixUpdate), make sure that the PopulateODLines property is set to False as only one these can be populated by the solver.
setMatrixResultType in interface INAODCostMatrixSolver2type - A com.esri.arcgis.networkanalyst.esriNAODCostMatrixType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isPopulateODLines()
throws IOException,
AutomationException
Specifies if the solver should populate the ODLines output analysis class on solve.
If this is set to True, make sure that the MatrixResultType property is set to esriNAODCostMatrixNone as only one of these can be populated by the solver.
isPopulateODLines in interface INAODCostMatrixSolver2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPopulateODLines(boolean value)
throws IOException,
AutomationException
Returns true if the solver is set to populated the ODLines output analysis layer. If this is set true then the Matrix Result type cannot be populated. That is, the solver can either populate the ODLines or the Matrix result type.
Specifies if the solver should populate the ODLines output analyis class on solve.
If this is set to True, make sure that the MatrixResultType property is set to esriNAODCostMatrixNone as only one these can be populated by the solver.
setPopulateODLines in interface INAODCostMatrixSolver2value - 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 | ||||||||