NAServerVRPParams (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.networkanalyst
Class NAServerVRPParams

java.lang.Object
  com.esri.arcgis.networkanalyst.NAServerVRPParams

All Implemented Interfaces:: com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerSolverParams2, INAServerVRPParams, INASolverSettings, INASolverSettings2, INAVRPSolver, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NAServerVRPParams
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerSolverParams2, INAServerVRPParams, INASolverSettings, INASolverSettings2, INAVRPSolver, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerSolverParams2, INAServerVRPParams, INASolverSettings, INASolverSettings2, INAVRPSolver, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable

Deprecated as of 10.0. A container for the Vehicle Routing Problem solver settings and return parameters used by NAServer.

Remarks

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.

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

Product Availability

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

See Also:: Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.networkanalyst.INASolverSettings2
`IID, IIDd3696546_2831_4aa5_a879_acd66e50a938, xxDummy`

Fields inherited from interface com.esri.arcgis.networkanalyst.INASolverSettings
`IID5a8dc105_0e57_45c8_a01d_0188ce7f7b52`

Constructor Summary
`NAServerVRPParams()` Constructs a NAServerVRPParams using ArcGIS Engine.
`NAServerVRPParams(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `NAServerVRPParams theNAServerVRPParams = (NAServerVRPParams) 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.
`INAServerLocations`	`getBreaks()` RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.
`int`	`getCapacityCount()` The number of dimensions for object sizes.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`Date`	`getDefaultDate()` The date to use for time windows without dates.
`INAServerLocations`	`getDepots()` RecordSet or array of PropertySets representing Depots loaded as network locations during analysis.
`String`	`getDirectionsLanguage()` Language to use when computing directions.
`int`	`getDirectionsLengthUnits()` Length units to use when computing directions.
`int`	`getDirectionsOutputType()` Type of directions to generate.
`String`	`getDirectionsStyleName()` Name of the directions style to use when generating directions.
`String`	`getDirectionsTimeAttributeName()` Name of network attribute to use for the drive time when computing directions.
`int`	`getDistanceFieldUnits()` The units for distance fields in the NA classes.
`double`	`getExcessTransitTimePenaltyFactor()` The penalty factor for excess transit time in the objective function.
`INAODCostMatrix`	`getExternalODCostMatrix()` The external OD cost matrix object.
`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`	`getInternalODCostMatrixType()` Indicates the type of internal matrix to be created.
`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`	`getNumTransitionToHierarchy(int toLevel)` The number of lower level junctions to explore before searching the next hierarchy level.
`INAServerLocations`	`getOrderPairs()` RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.
`INAServerLocations`	`getOrders()` RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.
`int`	`getOutputLines()` Indicates how route 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.
`INAServerLocations`	`getRouteRenewals()` RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.
`INAServerLocations`	`getRoutes()` RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.
`INAServerLocations`	`getRouteSeedPoints()` RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.
`INAServerLocations`	`getRouteZones()` RecordSet or array of PropertySets representing Route Zones loaded as network locations during 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.
`INAServerLocations`	`getSpecialties()` RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.
`int`	`getTimeFieldUnits()` The units for time fields in the NA classes.
`double`	`getTimeWindowViolationPenaltyFactor()` The penalty factor for time window violation in the objective function.
`int`	`hashCode()` the hashcode for this object
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`void`	`isDirty()` isDirty
`boolean`	`isGenerateInternalRouteContext()` Indicates if the internal route context should be generated.
`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`	`isReturnBreaks()` Indicates if the output Breaks recordset should be returned with the analysis results.
`boolean`	`isReturnCompactDirections()` Indicates if compact directions should be generated and returned with the analysis results.
`boolean`	`isReturnDepots()` Indicates if the output Depots recordset should be returned with the analysis results.
`boolean`	`isReturnDepotVisits()` Indicates if the output Depot Visits recordset should be returned with the analysis results.
`boolean`	`isReturnMap()` Indicates if a MapImage should be generated and returned with the analysis results.
`boolean`	`isReturnOrderPairs()` Indicates if the output OrderPairs recordset should be returned with the analysis results.
`boolean`	`isReturnOrders()` Indicates if the output Orders 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`	`isReturnRouteRenewals()` Indicates if the output Route Renewals recordset should be returned with the analysis results.
`boolean`	`isReturnRoutes()` Indicates if the output Routes recordset should be returned with the analysis results.
`boolean`	`isReturnRouteSeedPoints()` Indicates if the Route Seed Points recordset should be returned with the analysis results.
`boolean`	`isReturnRouteZones()` Indicates if the Route Zones recordset should be returned with the analysis results.
`boolean`	`isReturnSpecialties()` Indicates if the Specialties 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`	`setBreaksByRef(INAServerLocations breaks)` RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.
`void`	`setCapacityCount(int value)` The number of dimensions for object sizes.
`void`	`setDefaultDate(Date date)` The date to use for time windows without dates.
`void`	`setDepotsByRef(INAServerLocations depots)` RecordSet or array of PropertySets representing Depots loaded as network locations during analysis.
`void`	`setDirectionsLanguage(String directionsLanguage)` Language to use when computing directions.
`void`	`setDirectionsLengthUnits(int directionsLengthUnits)` Length units to use when computing directions.
`void`	`setDirectionsOutputType(int directionsOutputType)` Type of directions to generate.
`void`	`setDirectionsStyleName(String directionsStyleName)` Name of the directions style to use when generating directions.
`void`	`setDirectionsTimeAttributeName(String directionsTimeAttributeName)` Name of network attribute to use for the drive time when computing directions.
`void`	`setDistanceFieldUnits(int units)` The units for distance fields in the NA classes.
`void`	`setExcessTransitTimePenaltyFactor(double value)` The penalty factor for excess transit time in the objective function.
`void`	`setExternalODCostMatrixByRef(INAODCostMatrix matrix)` The external OD cost matrix object.
`void`	`setGenerateInternalRouteContext(boolean value)` Indicates if the internal route context should be generated.
`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`	`setInternalODCostMatrixType(int type)` Indicates the type of internal matrix to be created.
`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`	`setNumTransitionToHierarchy(int toLevel, int value)` The number of lower level junctions to explore before searching the next hierarchy level.
`void`	`setOrderPairsByRef(INAServerLocations orderPairs)` RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.
`void`	`setOrdersByRef(INAServerLocations orders)` RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.
`void`	`setOutputLines(int value)` Indicates how route 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`	`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`	`setReturnBreaks(boolean returnBreaks)` Indicates if the output Breaks recordset should be returned with the analysis results.
`void`	`setReturnCompactDirections(boolean returnCompactDirections)` Indicates if compact directions should be generated and returned with the analysis results.
`void`	`setReturnDepots(boolean returnDepots)` Indicates if the output Depots recordset should be returned with the analysis results.
`void`	`setReturnDepotVisits(boolean returnDepotVisits)` Indicates if the output Depot Visits 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`	`setReturnOrderPairs(boolean returnOrderPairs)` Indicates if the output OrderPairs recordset should be returned with the analysis results.
`void`	`setReturnOrders(boolean returnOrders)` Indicates if the output Orders 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`	`setReturnRouteRenewals(boolean returnRouteRenewals)` Indicates if the output Route Renewals recordset should be returned with the analysis results.
`void`	`setReturnRoutes(boolean returnRoutes)` Indicates if the output Routes recordset should be returned with the analysis results.
`void`	`setReturnRouteSeedPoints(boolean returnRouteSeedPoints)` Indicates if the Route Seed Points recordset should be returned with the analysis results.
`void`	`setReturnRouteZones(boolean returnRouteZones)` Indicates if the Route Zones recordset should be returned with the analysis results.
`void`	`setReturnSpecialties(boolean returnSpecialties)` Indicates if the Specialties recordset should be returned with the analysis results.
`void`	`setRouteRenewalsByRef(INAServerLocations routeRenewals)` RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.
`void`	`setRoutesByRef(INAServerLocations routes)` RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.
`void`	`setRouteSeedPointsByRef(INAServerLocations routeSeedPoints)` RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.
`void`	`setRouteZonesByRef(INAServerLocations routeZones)` RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.
`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`	`setSpecialtiesByRef(INAServerLocations specialties)` RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.
`void`	`setTimeFieldUnits(int units)` The units for time fields in the NA classes.
`void`	`setTimeWindowViolationPenaltyFactor(double value)` The penalty factor for time window violation in the objective function.
`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

NAServerVRPParams

public NAServerVRPParams()
                  throws IOException,
                         UnknownHostException

Constructs a NAServerVRPParams using ArcGIS Engine.

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

NAServerVRPParams

public NAServerVRPParams(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerVRPParams theNAServerVRPParams = (NAServerVRPParams) obj;

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

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

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

setNALayerName

public void setNALayerName(String nALayerName)
                    throws IOException,
                           AutomationException

Network analysis layer name.

Remarks

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

Product Availability

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

Specified by:: setNALayerName in interface INAServerSolverParams

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

getNALayerName

public String getNALayerName()
                      throws IOException,
                             AutomationException

Network analysis layer name.

Remarks

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

Product Availability

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

Specified by:: getNALayerName in interface INAServerSolverParams

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

setSnapTolerance

public void setSnapTolerance(double snapTolerance)
                      throws IOException,
                             AutomationException

Minimum search tolerance used when attempting to load network locations.

Remarks

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

Product Availability

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

Specified by:: setSnapTolerance in interface INAServerSolverParams

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

getSnapTolerance

public double getSnapTolerance()
                        throws IOException,
                               AutomationException

Minimum search tolerance used when attempting to load network locations.

Remarks

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

Product Availability

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

Specified by:: getSnapTolerance in interface INAServerSolverParams

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

setMaxSnapTolerance

public void setMaxSnapTolerance(double maxSnapTolerance)
                         throws IOException,
                                AutomationException

Maximum search tolerance used when attempting to load network locations.

Remarks

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

Product Availability

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

Specified by:: setMaxSnapTolerance in interface INAServerSolverParams

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

getMaxSnapTolerance

public double getMaxSnapTolerance()
                           throws IOException,
                                  AutomationException

Maximum search tolerance used when attempting to load network locations.

Remarks

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

Product Availability

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

Specified by:: getMaxSnapTolerance in interface INAServerSolverParams

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

setSnapToleranceUnits

public void setSnapToleranceUnits(int snapToleranceUnits)
                           throws IOException,
                                  AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Remarks

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

Product Availability

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

Specified by:: setSnapToleranceUnits in interface INAServerSolverParams

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

getSnapToleranceUnits

public int getSnapToleranceUnits()
                          throws IOException,
                                 AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Product Availability

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

Specified by:: getSnapToleranceUnits in interface INAServerSolverParams

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

setNAClassCandidateFieldMaps

public void setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
                                  throws IOException,
                                         AutomationException

Array of NAClassCandidateFieldMaps .

Remarks

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

Product Availability

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

Specified by:: setNAClassCandidateFieldMaps in interface INAServerSolverParams

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

getNAClassCandidateFieldMaps

public INAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
                                                         throws IOException,
                                                                AutomationException

Array of NAClassCandidateFieldMaps .

Remarks

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

Product Availability

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

Specified by:: getNAClassCandidateFieldMaps in interface INAServerSolverParams

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

setReturnMap

public void setReturnMap(boolean returnMap)
                  throws IOException,
                         AutomationException

Indicates if a MapImage should be generated and returned with the analysis results.

Remarks

ReturnMap specifies if the map is returned by the solve.

Product Availability

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

Specified by:: setReturnMap in interface INAServerSolverParams

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

isReturnMap

public boolean isReturnMap()
                    throws IOException,
                           AutomationException

Indicates if a MapImage should be generated and returned with the analysis results.

Remarks

ReturnMap specifies if the map is returned by the solve.

Product Availability

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

Specified by:: isReturnMap in interface INAServerSolverParams

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

setMapDescriptionByRef

public void setMapDescriptionByRef(IMapDescription mapDescription)
                            throws IOException,
                                   AutomationException

MapDescription used when generating the MapImage returned with the analysis results.

Remarks

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

Product Availability

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

Specified by:: setMapDescriptionByRef in interface INAServerSolverParams

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

getMapDescription

public IMapDescription getMapDescription()
                                  throws IOException,
                                         AutomationException

MapDescription used when generating the MapImage returned with the analysis results.

Remarks

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

Product Availability

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

Specified by:: getMapDescription in interface INAServerSolverParams

Returns:: A reference to a com.esri.arcgis.carto.IMapDescription
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setImageDescriptionByRef

public void setImageDescriptionByRef(IImageDescription imageDescription)
                              throws IOException,
                                     AutomationException

ImageDescription used when generating the MapImage returned with the analysis results.

Remarks

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

routeParams.ImageDescription.Display.Width = 200

routeParams.ImageDescription.Display.Height = 200

Product Availability

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

Specified by:: setImageDescriptionByRef in interface INAServerSolverParams

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

getImageDescription

public IImageDescription getImageDescription()
                                      throws IOException,
                                             AutomationException

ImageDescription used when generating the MapImage returned with the analysis results.

Remarks

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

routeParams.ImageDescription.Display.Width = 200

routeParams.ImageDescription.Display.Height = 200

Product Availability

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

Specified by:: getImageDescription in interface INAServerSolverParams

Returns:: A reference to a com.esri.arcgis.carto.IImageDescription
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                                    throws IOException,
                                           AutomationException

Spatial reference of the geometries returned with the analysis results.

Remarks

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

Product Availability

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

Specified by:: setOutputSpatialReferenceByRef in interface INAServerSolverParams

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

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference()
                                            throws IOException,
                                                   AutomationException

Spatial reference of the geometries returned with the analysis results.

Remarks

Product Availability

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

Specified by:: getOutputSpatialReference in interface INAServerSolverParams

Returns:: A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setReturnPartialResultsOnError

public void setReturnPartialResultsOnError(boolean returnPartialResultsOnError)
                                    throws IOException,
                                           AutomationException

Indicates if the result object should be returned even if an error was generated during the solve operation.

Remarks

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

Product Availability

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

Specified by:: setReturnPartialResultsOnError in interface INAServerSolverParams2

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

isReturnPartialResultsOnError

public boolean isReturnPartialResultsOnError()
                                      throws IOException,
                                             AutomationException

Indicates if the result object should be returned even if an error was generated during the solve operation.

Product Availability

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

Specified by:: isReturnPartialResultsOnError in interface INAServerSolverParams2

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

setSaveLayerOnServer

public void setSaveLayerOnServer(boolean saveLayerOnServer)
                          throws IOException,
                                 AutomationException

Indicates if the resulting analysis layer should be saved on the server.

Remarks

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

Product Availability

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

Specified by:: setSaveLayerOnServer in interface INAServerSolverParams2

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

isSaveLayerOnServer

public boolean isSaveLayerOnServer()
                            throws IOException,
                                   AutomationException

Indicates if the resulting analysis layer should be saved on the server.

Product Availability

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

Specified by:: isSaveLayerOnServer in interface INAServerSolverParams2

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

setLayerToken

public void setLayerToken(String layerToken)
                   throws IOException,
                          AutomationException

Token identifying the network analysis layer on the server to use.

Remarks

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

Product Availability

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

Specified by:: setLayerToken in interface INAServerSolverParams2

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

getLayerToken

public String getLayerToken()
                     throws IOException,
                            AutomationException

Token identifying the network analysis layer on the server to use.

Product Availability

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

Specified by:: getLayerToken in interface INAServerSolverParams2

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

setOrdersByRef

public void setOrdersByRef(INAServerLocations orders)
                    throws IOException,
                           AutomationException

RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.

Remarks

Orders specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setOrdersByRef in interface INAServerVRPParams

Parameters:: orders - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOrders

public INAServerLocations getOrders()
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.

Product Availability

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

Specified by:: getOrders in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDepotsByRef

public void setDepotsByRef(INAServerLocations depots)
                    throws IOException,
                           AutomationException

RecordSet or array of PropertySets representing Depots loaded as network locations during analysis.

Remarks

Depots specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setDepotsByRef in interface INAServerVRPParams

Parameters:: depots - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDepots

public INAServerLocations getDepots()
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Depots loaded as network locations during analysis.

Product Availability

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

Specified by:: getDepots in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRoutesByRef

public void setRoutesByRef(INAServerLocations routes)
                    throws IOException,
                           AutomationException

RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.

Remarks

Routes specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setRoutesByRef in interface INAServerVRPParams

Parameters:: routes - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRoutes

public INAServerLocations getRoutes()
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.

Product Availability

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

Specified by:: getRoutes in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBreaksByRef

public void setBreaksByRef(INAServerLocations breaks)
                    throws IOException,
                           AutomationException

RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.

Remarks

Breaks specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setBreaksByRef in interface INAServerVRPParams

Parameters:: breaks - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBreaks

public INAServerLocations getBreaks()
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.

Product Availability

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

Specified by:: getBreaks in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRouteZonesByRef

public void setRouteZonesByRef(INAServerLocations routeZones)
                        throws IOException,
                               AutomationException

RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.

Remarks

RouteZones specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setRouteZonesByRef in interface INAServerVRPParams

Parameters:: routeZones - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRouteZones

public INAServerLocations getRouteZones()
                                 throws IOException,
                                        AutomationException

RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.

Product Availability

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

Specified by:: getRouteZones in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRouteSeedPointsByRef

public void setRouteSeedPointsByRef(INAServerLocations routeSeedPoints)
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.

Remarks

RouteSeedPoints specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setRouteSeedPointsByRef in interface INAServerVRPParams

Parameters:: routeSeedPoints - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRouteSeedPoints

public INAServerLocations getRouteSeedPoints()
                                      throws IOException,
                                             AutomationException

RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.

Product Availability

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

Specified by:: getRouteSeedPoints in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRouteRenewalsByRef

public void setRouteRenewalsByRef(INAServerLocations routeRenewals)
                           throws IOException,
                                  AutomationException

RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.

Remarks

RouteRenewals specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setRouteRenewalsByRef in interface INAServerVRPParams

Parameters:: routeRenewals - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRouteRenewals

public INAServerLocations getRouteRenewals()
                                    throws IOException,
                                           AutomationException

RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.

Product Availability

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

Specified by:: getRouteRenewals in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSpecialtiesByRef

public void setSpecialtiesByRef(INAServerLocations specialties)
                         throws IOException,
                                AutomationException

RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.

Remarks

Specialties specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setSpecialtiesByRef in interface INAServerVRPParams

Parameters:: specialties - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSpecialties

public INAServerLocations getSpecialties()
                                  throws IOException,
                                         AutomationException

RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.

Product Availability

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

Specified by:: getSpecialties in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setOrderPairsByRef

public void setOrderPairsByRef(INAServerLocations orderPairs)
                        throws IOException,
                               AutomationException

RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.

Remarks

OrderPairs specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

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

Specified by:: setOrderPairsByRef in interface INAServerVRPParams

Parameters:: orderPairs - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOrderPairs

public INAServerLocations getOrderPairs()
                                 throws IOException,
                                        AutomationException

RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.

Product Availability

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

Specified by:: getOrderPairs in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBarriersByRef

public void setBarriersByRef(INAServerLocations barriers)
                      throws IOException,
                             AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Remarks

Barriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

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

Specified by:: setBarriersByRef in interface INAServerVRPParams

Parameters:: barriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBarriers

public INAServerLocations getBarriers()
                               throws IOException,
                                      AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Product Availability

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

Specified by:: getBarriers in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPolylineBarriersByRef

public void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
                              throws IOException,
                                     AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Remarks

PolylineBarriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

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

Specified by:: setPolylineBarriersByRef in interface INAServerVRPParams

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

getPolylineBarriers

public INAServerLocations getPolylineBarriers()
                                       throws IOException,
                                              AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Product Availability

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

Specified by:: getPolylineBarriers in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPolygonBarriersByRef

public void setPolygonBarriersByRef(INAServerLocations polygonBarriers)
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Remarks

PolygonBarriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

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

Specified by:: setPolygonBarriersByRef in interface INAServerVRPParams

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

getPolygonBarriers

public INAServerLocations getPolygonBarriers()
                                      throws IOException,
                                             AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Product Availability

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

Specified by:: getPolygonBarriers in interface INAServerVRPParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAServerLocations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setReturnOrderPairs

public void setReturnOrderPairs(boolean returnOrderPairs)
                         throws IOException,
                                AutomationException

Indicates if the output OrderPairs recordset should be returned with the analysis results.

Remarks

ReturnOrderPairs indicates if the order pairs used during analysis should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnOrderPairs in interface INAServerVRPParams

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

isReturnOrderPairs

public boolean isReturnOrderPairs()
                           throws IOException,
                                  AutomationException

Indicates if the output OrderPairs recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnOrderPairs in interface INAServerVRPParams

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

setReturnOrders

public void setReturnOrders(boolean returnOrders)
                     throws IOException,
                            AutomationException

Indicates if the output Orders recordset should be returned with the analysis results.

Remarks

ReturnOrders indicates if the orders used during analysis should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnOrders in interface INAServerVRPParams

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

isReturnOrders

public boolean isReturnOrders()
                       throws IOException,
                              AutomationException

Indicates if the output Orders recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnOrders in interface INAServerVRPParams

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

setReturnDepots

public void setReturnDepots(boolean returnDepots)
                     throws IOException,
                            AutomationException

Indicates if the output Depots recordset should be returned with the analysis results.

Remarks

ReturnDepots indicates if the depots used during analysis should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnDepots in interface INAServerVRPParams

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

isReturnDepots

public boolean isReturnDepots()
                       throws IOException,
                              AutomationException

Indicates if the output Depots recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnDepots in interface INAServerVRPParams

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

setReturnRoutes

public void setReturnRoutes(boolean returnRoutes)
                     throws IOException,
                            AutomationException

Indicates if the output Routes recordset should be returned with the analysis results.

Remarks

ReturnRoutes indicates if the route features should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnRoutes in interface INAServerVRPParams

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

isReturnRoutes

public boolean isReturnRoutes()
                       throws IOException,
                              AutomationException

Indicates if the output Routes recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnRoutes in interface INAServerVRPParams

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

setReturnDepotVisits

public void setReturnDepotVisits(boolean returnDepotVisits)
                          throws IOException,
                                 AutomationException

Indicates if the output Depot Visits recordset should be returned with the analysis results.

Remarks

ReturnDepotVisits indicates if the depot visits features should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnDepotVisits in interface INAServerVRPParams

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

isReturnDepotVisits

public boolean isReturnDepotVisits()
                            throws IOException,
                                   AutomationException

Indicates if the output Depot Visits recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnDepotVisits in interface INAServerVRPParams

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

setReturnBreaks

public void setReturnBreaks(boolean returnBreaks)
                     throws IOException,
                            AutomationException

Indicates if the output Breaks recordset should be returned with the analysis results.

Remarks

ReturnBreaks indicates if the breaks used during analysis should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnBreaks in interface INAServerVRPParams

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

isReturnBreaks

public boolean isReturnBreaks()
                       throws IOException,
                              AutomationException

Indicates if the output Breaks recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnBreaks in interface INAServerVRPParams

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

setReturnRouteRenewals

public void setReturnRouteRenewals(boolean returnRouteRenewals)
                            throws IOException,
                                   AutomationException

Indicates if the output Route Renewals recordset should be returned with the analysis results.

Remarks

ReturnRouteRenewals indicates if the route renewals used during analysis should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnRouteRenewals in interface INAServerVRPParams

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

isReturnRouteRenewals

public boolean isReturnRouteRenewals()
                              throws IOException,
                                     AutomationException

Indicates if the output Route Renewals recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnRouteRenewals in interface INAServerVRPParams

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

setReturnRouteSeedPoints

public void setReturnRouteSeedPoints(boolean returnRouteSeedPoints)
                              throws IOException,
                                     AutomationException

Indicates if the Route Seed Points recordset should be returned with the analysis results.

Remarks

ReturnRouteSeedPoints indicates if the route seed points used during analysis should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnRouteSeedPoints in interface INAServerVRPParams

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

isReturnRouteSeedPoints

public boolean isReturnRouteSeedPoints()
                                throws IOException,
                                       AutomationException

Indicates if the Route Seed Points recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnRouteSeedPoints in interface INAServerVRPParams

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

setReturnRouteZones

public void setReturnRouteZones(boolean returnRouteZones)
                         throws IOException,
                                AutomationException

Indicates if the Route Zones recordset should be returned with the analysis results.

Remarks

ReturnRouteZones indicates if the route zones used during analysis should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnRouteZones in interface INAServerVRPParams

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

isReturnRouteZones

public boolean isReturnRouteZones()
                           throws IOException,
                                  AutomationException

Indicates if the Route Zones recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnRouteZones in interface INAServerVRPParams

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

setReturnSpecialties

public void setReturnSpecialties(boolean returnSpecialties)
                          throws IOException,
                                 AutomationException

Indicates if the Specialties recordset should be returned with the analysis results.

Remarks

ReturnSpecialties indicates if the route specialties used during analysis should be returned as a RecordSet.

Product Availability

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

Specified by:: setReturnSpecialties in interface INAServerVRPParams

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

isReturnSpecialties

public boolean isReturnSpecialties()
                            throws IOException,
                                   AutomationException

Indicates if the Specialties recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnSpecialties in interface INAServerVRPParams

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

setReturnBarriers

public void setReturnBarriers(boolean returnBarriers)
                       throws IOException,
                              AutomationException

Indicates if the output barriers recordset should be returned with the analysis results.

Remarks

ReturnBarriers specifies if the Barriers are returned.

Product Availability

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

Specified by:: setReturnBarriers in interface INAServerVRPParams

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

isReturnBarriers

public boolean isReturnBarriers()
                         throws IOException,
                                AutomationException

Indicates if the output barriers recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnBarriers in interface INAServerVRPParams

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

setReturnPolylineBarriers

public void setReturnPolylineBarriers(boolean returnBarriers)
                               throws IOException,
                                      AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Remarks

ReturnPolylineBarriers specifies if the PolylineBarriers are returned.

Product Availability

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

Specified by:: setReturnPolylineBarriers in interface INAServerVRPParams

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

isReturnPolylineBarriers

public boolean isReturnPolylineBarriers()
                                 throws IOException,
                                        AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnPolylineBarriers in interface INAServerVRPParams

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

setReturnPolygonBarriers

public void setReturnPolygonBarriers(boolean returnBarriers)
                              throws IOException,
                                     AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Remarks

ReturnPolygonBarriers specifies if the PolygonBarriers are returned.

Product Availability

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

Specified by:: setReturnPolygonBarriers in interface INAServerVRPParams

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

isReturnPolygonBarriers

public boolean isReturnPolygonBarriers()
                                throws IOException,
                                       AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Product Availability

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

Specified by:: isReturnPolygonBarriers in interface INAServerVRPParams

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

setReturnCompactDirections

public void setReturnCompactDirections(boolean returnCompactDirections)
                                throws IOException,
                                       AutomationException

Indicates if compact directions should be generated and returned with the analysis results.

Remarks

ReturnCompactDirections indicates if compact driving directions should be returned.

Product Availability

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

Specified by:: setReturnCompactDirections in interface INAServerVRPParams

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

isReturnCompactDirections

public boolean isReturnCompactDirections()
                                  throws IOException,
                                         AutomationException

Indicates if compact directions should be generated and returned with the analysis results.

Product Availability

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

Specified by:: isReturnCompactDirections in interface INAServerVRPParams

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

setDirectionsLanguage

public void setDirectionsLanguage(String directionsLanguage)
                           throws IOException,
                                  AutomationException

Language to use when computing directions.

Remarks

DirectionsLanguage specifies the language used when generating directions.

Product Availability

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

Specified by:: setDirectionsLanguage in interface INAServerVRPParams

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

getDirectionsLanguage

public String getDirectionsLanguage()
                             throws IOException,
                                    AutomationException

Language to use when computing directions.

Product Availability

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

Specified by:: getDirectionsLanguage in interface INAServerVRPParams

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

setDirectionsLengthUnits

public void setDirectionsLengthUnits(int directionsLengthUnits)
                              throws IOException,
                                     AutomationException

Length units to use when computing directions.

Remarks

DirectionsLengthUnits specifies the length units of the directions in esriNetworkAttributeUnits.

Product Availability

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

Specified by:: setDirectionsLengthUnits in interface INAServerVRPParams

Parameters:: directionsLengthUnits - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDirectionsLengthUnits

public int getDirectionsLengthUnits()
                             throws IOException,
                                    AutomationException

Length units to use when computing directions.

Product Availability

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

Specified by:: getDirectionsLengthUnits in interface INAServerVRPParams

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

setDirectionsOutputType

public void setDirectionsOutputType(int directionsOutputType)
                             throws IOException,
                                    AutomationException

Type of directions to generate.

Remarks

DirectionsOutputType defines the type of content of directions.

Product Availability

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

Specified by:: setDirectionsOutputType in interface INAServerVRPParams

Parameters:: directionsOutputType - A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDirectionsOutputType

public int getDirectionsOutputType()
                            throws IOException,
                                   AutomationException

Type of directions to generate.

Product Availability

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

Specified by:: getDirectionsOutputType in interface INAServerVRPParams

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

setDirectionsStyleName

public void setDirectionsStyleName(String directionsStyleName)
                            throws IOException,
                                   AutomationException

Name of the directions style to use when generating directions.

Remarks

DirectionsStyleName defines name of the formatting style of directions. For the list of supported styles see NAServer.GetNetworkDescription() and NAServerNetworkDirections class.

Product Availability

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

Specified by:: setDirectionsStyleName in interface INAServerVRPParams

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

getDirectionsStyleName

public String getDirectionsStyleName()
                              throws IOException,
                                     AutomationException

Name of the directions style to use when generating directions.

Product Availability

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

Specified by:: getDirectionsStyleName in interface INAServerVRPParams

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

setDirectionsTimeAttributeName

public void setDirectionsTimeAttributeName(String directionsTimeAttributeName)
                                    throws IOException,
                                           AutomationException

Name of network attribute to use for the drive time when computing directions.

Remarks

DirectionsTimeAttributeName specifies the time cost attribute used when generating directions.

Product Availability

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

Specified by:: setDirectionsTimeAttributeName in interface INAServerVRPParams

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

getDirectionsTimeAttributeName

public String getDirectionsTimeAttributeName()
                                      throws IOException,
                                             AutomationException

Name of network attribute to use for the drive time when computing directions.

Product Availability

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

Specified by:: getDirectionsTimeAttributeName in interface INAServerVRPParams

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

getAccumulateAttributeNames

public IStringArray getAccumulateAttributeNames()
                                         throws IOException,
                                                AutomationException

The collection of network attribute names to be accumulated with the analysis.

Specified by:: getAccumulateAttributeNames in interface INASolverSettings

Returns:: A reference to a com.esri.arcgis.system.IStringArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAccumulateAttributeNamesByRef

public void setAccumulateAttributeNamesByRef(IStringArray attributeNames)
                                      throws IOException,
                                             AutomationException

The collection of network attribute names to be accumulated with the analysis.

Specified by:: setAccumulateAttributeNamesByRef in interface INASolverSettings

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

setImpedanceAttributeName

public void setImpedanceAttributeName(String attributeName)
                               throws IOException,
                                      AutomationException

The network attribute name to be used as the impedance attribute in analysis.

Specified by:: setImpedanceAttributeName in interface INASolverSettings

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

getImpedanceAttributeName

public String getImpedanceAttributeName()
                                 throws IOException,
                                        AutomationException

The network attribute name to be used as the impedance attribute in analysis.

Specified by:: getImpedanceAttributeName in interface INASolverSettings

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

setIgnoreInvalidLocations

public void setIgnoreInvalidLocations(boolean ignoreInvalidLocations)
                               throws IOException,
                                      AutomationException

Indicates if invalid locations should be ignored or raise an error.

Specified by:: setIgnoreInvalidLocations in interface INASolverSettings

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

isIgnoreInvalidLocations

public boolean isIgnoreInvalidLocations()
                                 throws IOException,
                                        AutomationException

Indicates if invalid locations should be ignored or raise an error.

Specified by:: isIgnoreInvalidLocations in interface INASolverSettings

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

getRestrictionAttributeNames

public IStringArray getRestrictionAttributeNames()
                                          throws IOException,
                                                 AutomationException

The collection of network attribute names to be used as restrictions with the analysis.

Specified by:: getRestrictionAttributeNames in interface INASolverSettings

Returns:: A reference to a com.esri.arcgis.system.IStringArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRestrictionAttributeNamesByRef

public void setRestrictionAttributeNamesByRef(IStringArray attributeName)
                                       throws IOException,
                                              AutomationException

The collection of network attribute names to be used as restrictions with the analysis.

Specified by:: setRestrictionAttributeNamesByRef in interface INASolverSettings

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

setRestrictUTurns

public void setRestrictUTurns(int backtrack)
                       throws IOException,
                              AutomationException

Indicates how U-Turns should be restricted in the analysis.

Specified by:: setRestrictUTurns in interface INASolverSettings

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

getRestrictUTurns

public int getRestrictUTurns()
                      throws IOException,
                             AutomationException

Indicates how U-Turns should be restricted in the analysis.

Specified by:: getRestrictUTurns in interface INASolverSettings

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

setUseHierarchy

public void setUseHierarchy(boolean useHierarchy)
                     throws IOException,
                            AutomationException

Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:: setUseHierarchy in interface INASolverSettings

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

isUseHierarchy

public boolean isUseHierarchy()
                       throws IOException,
                              AutomationException

Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:: isUseHierarchy in interface INASolverSettings

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

setHierarchyAttributeName

public void setHierarchyAttributeName(String attributeName)
                               throws IOException,
                                      AutomationException

The name of the hierarchy attribute to be used in analysis.

Specified by:: setHierarchyAttributeName in interface INASolverSettings

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

getHierarchyAttributeName

public String getHierarchyAttributeName()
                                 throws IOException,
                                        AutomationException

The name of the hierarchy attribute to be used in analysis.

Specified by:: getHierarchyAttributeName in interface INASolverSettings

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

setHierarchyLevelCount

public void setHierarchyLevelCount(int count)
                            throws IOException,
                                   AutomationException

The number of levels in the hierarchy attribute.

Specified by:: setHierarchyLevelCount in interface INASolverSettings

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

getHierarchyLevelCount

public int getHierarchyLevelCount()
                           throws IOException,
                                  AutomationException

The number of levels in the hierarchy attribute.

Specified by:: getHierarchyLevelCount in interface INASolverSettings

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

setMaxValueForHierarchy

public void setMaxValueForHierarchy(int level,
                                    int value)
                             throws IOException,
                                    AutomationException

The maximum value of the hierarchy attribute.

Specified by:: setMaxValueForHierarchy in interface INASolverSettings

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

getMaxValueForHierarchy

public int getMaxValueForHierarchy(int level)
                            throws IOException,
                                   AutomationException

The maximum value of the hierarchy attribute.

Specified by:: getMaxValueForHierarchy in interface INASolverSettings

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

setNumTransitionToHierarchy

public void setNumTransitionToHierarchy(int toLevel,
                                        int value)
                                 throws IOException,
                                        AutomationException

The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:: setNumTransitionToHierarchy in interface INASolverSettings

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

getNumTransitionToHierarchy

public int getNumTransitionToHierarchy(int toLevel)
                                throws IOException,
                                       AutomationException

The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:: getNumTransitionToHierarchy in interface INASolverSettings

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

isResetHierarchyRangesOnBind

public boolean isResetHierarchyRangesOnBind()
                                     throws IOException,
                                            AutomationException

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:: isResetHierarchyRangesOnBind in interface INASolverSettings2

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

setResetHierarchyRangesOnBind

public void setResetHierarchyRangesOnBind(boolean value)
                                   throws IOException,
                                          AutomationException

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:: setResetHierarchyRangesOnBind in interface INASolverSettings2

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

getAttributeParameterValue

public Object getAttributeParameterValue(String attributeName,
                                         String paramName)
                                  throws IOException,
                                         AutomationException

The value to use for an attribute parameter within the network dataset.

Specified by:: getAttributeParameterValue in interface INASolverSettings2

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

setAttributeParameterValue

public void setAttributeParameterValue(String attributeName,
                                       String paramName,
                                       Object value)
                                throws IOException,
                                       AutomationException

The value to use for an attribute parameter within the network dataset.

Specified by:: setAttributeParameterValue in interface INASolverSettings2

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

getInternalODCostMatrixType

public int getInternalODCostMatrixType()
                                throws IOException,
                                       AutomationException

Indicates the type of internal matrix to be created.

Remarks

The InternalODCostMatrixType property specifies a value of type esriNAODCostMatrixType. This enumeration constrains how the VRP solver uses and manages an internal NAODCostMatrixResult object during a Solve.

A client using the internal OD cost matrix pattern should set this property to esriNAODCostMatrixFull whenever the set of barrier locations, restrictions, usage of hierarchy or attribute parameter values have changed since the last Solve operation. This ensures that the internal OD cost matrix is fully recalculated based on any new barrier locations or solver settings. Otherwise, setting this property to esriNAODCostMatrixUpdate will ensure that the internal cost matrix is updated with new OD cost entries for locations added since the last Solve operation.

Product Availability

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

Specified by:: getInternalODCostMatrixType in interface INAVRPSolver

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

setInternalODCostMatrixType

public void setInternalODCostMatrixType(int type)
                                 throws IOException,
                                        AutomationException

Indicates the type of internal matrix to be created.

Product Availability

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

Specified by:: setInternalODCostMatrixType in interface INAVRPSolver

Parameters:: type - A com.esri.arcgis.networkanalyst.esriNAODCostMatrixType constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isGenerateInternalRouteContext

public boolean isGenerateInternalRouteContext()
                                       throws IOException,
                                              AutomationException

Indicates if the internal route context should be generated.

Remarks

The GenerateInternalRouteContext property is deprecated and should no longer be used.

Product Availability

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

Specified by:: isGenerateInternalRouteContext in interface INAVRPSolver

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

setGenerateInternalRouteContext

public void setGenerateInternalRouteContext(boolean value)
                                     throws IOException,
                                            AutomationException

Indicates if the internal route context should be generated.

Product Availability

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

Specified by:: setGenerateInternalRouteContext in interface INAVRPSolver

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

getExternalODCostMatrix

public INAODCostMatrix getExternalODCostMatrix()
                                        throws IOException,
                                               AutomationException

The external OD cost matrix object.

Remarks

The ExternalODCostMatrix property can be used to specify an externally-created NAODCostMatrixResult object or custom object that implements the INAODCostMatrix interface for use within the VRP solver Solve operation. The impedance and accumulate attributes for this matrix object must agree with those of the VRP solver settings.

The ExternalODCostMatrix property value is NULL by default. This property should only be set when the INAVRPSolver.InternalODCostMatrixType is equal to esriNAODCostMatrixNone. This property is also not persisted. When a VRP solver instance is re-hydrated, the value for this property is NULL.

Product Availability

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

Specified by:: getExternalODCostMatrix in interface INAVRPSolver

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAODCostMatrix
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExternalODCostMatrixByRef

public void setExternalODCostMatrixByRef(INAODCostMatrix matrix)
                                  throws IOException,
                                         AutomationException

The external OD cost matrix object.

Product Availability

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

Specified by:: setExternalODCostMatrixByRef in interface INAVRPSolver

Parameters:: matrix - A reference to a com.esri.arcgis.networkanalyst.INAODCostMatrix (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeFieldUnits

public int getTimeFieldUnits()
                      throws IOException,
                             AutomationException

The units for time fields in the NA classes.

Remarks

The TimeFieldUnits property specifies the unit of time to associate with the time-based input and output field values of NAClasses within a VRP NAContext. Examples of such time-based fields include the ServiceTime field on the Orders NAClass and the CostPerUnitTime field on the Routes NAClass. This time unit need not agree with the time unit of the impedance cost attribute. For example, the client may use an impedance cost attribute based on minutes but use seconds for the time-based field values.

Product Availability

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

Specified by:: getTimeFieldUnits in interface INAVRPSolver

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

setTimeFieldUnits

public void setTimeFieldUnits(int units)
                       throws IOException,
                              AutomationException

The units for time fields in the NA classes.

Product Availability

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

Specified by:: setTimeFieldUnits in interface INAVRPSolver

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

getDistanceFieldUnits

public int getDistanceFieldUnits()
                          throws IOException,
                                 AutomationException

The units for distance fields in the NA classes.

Remarks

The DistanceFieldUnits property specifies the unit of distance to associate with the distance-based input and output field values of NAClasses within a VRP NAContext. Examples of such distance-based fields include the TotalDistance field and the CostPerUnitDistance field on the Routes NAClass. This distance unit need not agree with the distance unit of the accumulate cost attribute. For example, the client may use an accumulate cost attribute based on kilometers but use miles for the distance-based field values.

Product Availability

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

Specified by:: getDistanceFieldUnits in interface INAVRPSolver

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

setDistanceFieldUnits

public void setDistanceFieldUnits(int units)
                           throws IOException,
                                  AutomationException

The units for distance fields in the NA classes.

Product Availability

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

Specified by:: setDistanceFieldUnits in interface INAVRPSolver

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

getDefaultDate

public Date getDefaultDate()
                    throws IOException,
                           AutomationException

The date to use for time windows without dates.

Remarks

The DefaultDate property is used to specify the default date portion of date-based fields (where FieldType = esriFieldTypeDate) within the NAClasses of a VRP NAContext. Fields of type esriFieldTypeDate can actually be used to specify both date-time values (e.g., June 1, 2008, 8AM) and time-only values (e.g., 8AM). Time-only values will be interpreted by the VRP solver as having a date portion equal to the DefaultDate property value.

For example, if a date-based field value within a particular NAClass of a VRP NAContext is set as the time-only value 8AM and the DefaultDate property value is set as June 1, 2008, then the VRP solver will interpret this date-based field value as June 1, 2008, 8AM.

The DefaultDate property cannot be before January 1, 1900 or after December 31, 9999. By default, the DefaultDate property is set equal to the current date when the solver is created.

Product Availability

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

Specified by:: getDefaultDate in interface INAVRPSolver

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

setDefaultDate

public void setDefaultDate(Date date)
                    throws IOException,
                           AutomationException

The date to use for time windows without dates.

Product Availability

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

Specified by:: setDefaultDate in interface INAVRPSolver

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

getCapacityCount

public int getCapacityCount()
                     throws IOException,
                            AutomationException

The number of dimensions for object sizes.

Remarks

Capacities are used to model cumulative quantity constraints on the routes. These constraints typically arise from physical measurements and limit the total pickup and/or delivery quantities of orders associated with a route. The CapacityCount property specifies the number of different capacities that are being constrained. For example, if you are constraining weight and volume, the CapacityCount would be 2. Following this example, a route feature with its Capacities field value set to �2000 500� would indicate that it can transport a maximum weight of 2000 units (pounds) with a maximum volume of 500 units (cubic feet). An order feature might have its DeliveryQuantities field value set to �10 5� indicating that the weight of the order is 10 and its volume is 5.

The units for capacities are not specified in the VRP solver; furthermore, the ordering of the capacities in the string is arbitrary. This means that within a VRP analysis, capacities always need to be listed in the same sequence (in this example, weight and then volume) among all routes and orders. The number of tokens in these strings cannot exceed the CapacityCount property value.

Product Availability

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

Specified by:: getCapacityCount in interface INAVRPSolver

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

setCapacityCount

public void setCapacityCount(int value)
                      throws IOException,
                             AutomationException

The number of dimensions for object sizes.

Product Availability

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

Specified by:: setCapacityCount in interface INAVRPSolver

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

getTimeWindowViolationPenaltyFactor

public double getTimeWindowViolationPenaltyFactor()
                                           throws IOException,
                                                  AutomationException

The penalty factor for time window violation in the objective function.

Remarks

A time window violation occurs when a route arrives at an order, depot, or break after a time window has closed. The violation is the interval between the end of the time window and the arrival time. This property is used for calibrating time window violations within the solver objective function. For example, a penalty factor value of 5.0 means that a minute of time window violation increases the solver objective function value by the cost of five minutes of work time. The higher the penalty factor, the more the solver will favor solutions with smaller time window violations versus reducing overall route duration for the fleet. This penalty factor must be zero or positive, and cannot exceed one billion. The penalty influences the solver objective function during the optimization process, but is not included in the output route operating costs. The default value for this property is 1.0.

Product Availability

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

Specified by:: getTimeWindowViolationPenaltyFactor in interface INAVRPSolver

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

setTimeWindowViolationPenaltyFactor

public void setTimeWindowViolationPenaltyFactor(double value)
                                         throws IOException,
                                                AutomationException

The penalty factor for time window violation in the objective function.

Product Availability

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

Specified by:: setTimeWindowViolationPenaltyFactor in interface INAVRPSolver

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

getExcessTransitTimePenaltyFactor

public double getExcessTransitTimePenaltyFactor()
                                         throws IOException,
                                                AutomationException

The penalty factor for excess transit time in the objective function.

Remarks

Excess transit time is the amount of time exceeding the time required to travel directly between the paired orders. The excess time results from breaks or travel to other intermediate orders or depots between visits to the paired orders. This property is used for calibrating excess transit time between order pairs within the solver objective function. For example, a penalty factor value of 5.0 means that one minute of excess transit time increases the solver objective function value by the cost of five minutes of work time. The higher the penalty factor, the more the solver will favor solutions with less excess transit time between paired orders versus reducing overall route duration for the fleet. The penalty influences the solver objective function during the optimization process, but is not included in the output route operating costs. The default value for this property is 1.0.

Product Availability

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

Specified by:: getExcessTransitTimePenaltyFactor in interface INAVRPSolver

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

setExcessTransitTimePenaltyFactor

public void setExcessTransitTimePenaltyFactor(double value)
                                       throws IOException,
                                              AutomationException

The penalty factor for excess transit time in the objective function.

Product Availability

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

Specified by:: setExcessTransitTimePenaltyFactor in interface INAVRPSolver

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

getOutputLines

public int getOutputLines()
                   throws IOException,
                          AutomationException

Indicates how route lines are generated.

Remarks

OutputLines specifies the type of line geometries that are generated by the NAVRPSolver object in the Routes NAClass.

Product Availability

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

Specified by:: getOutputLines in interface INAVRPSolver

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

setOutputLines

public void setOutputLines(int value)
                    throws IOException,
                           AutomationException

Indicates how route lines are generated.

Product Availability

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

Specified by:: setOutputLines in interface INAVRPSolver

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

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: serialize in interface IXMLSerialize

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

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deserialize in interface IXMLSerialize

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

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

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

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

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

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

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

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

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

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:: getMinNamespaceSupported in interface IXMLVersionSupport

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.networkanalyst Class NAServerVRPParams

Remarks

Product Availability

NAServerVRPParams

NAServerVRPParams

getClsid

equals

hashCode

setNALayerName

Remarks

Product Availability

getNALayerName

Remarks

Product Availability

setSnapTolerance

Remarks

Product Availability

getSnapTolerance

Remarks

Product Availability

setMaxSnapTolerance

Remarks

Product Availability

getMaxSnapTolerance

Remarks

Product Availability

setSnapToleranceUnits

Remarks

Product Availability

getSnapToleranceUnits

Product Availability

setNAClassCandidateFieldMaps

Remarks

Product Availability

getNAClassCandidateFieldMaps

Remarks

Product Availability

setReturnMap

Remarks

Product Availability

isReturnMap

Remarks

Product Availability

setMapDescriptionByRef

Remarks

Product Availability

getMapDescription

Remarks

Product Availability

setImageDescriptionByRef

Remarks

Product Availability

getImageDescription

Remarks

Product Availability

setOutputSpatialReferenceByRef

Remarks

Product Availability

getOutputSpatialReference

Remarks

Product Availability

setReturnPartialResultsOnError

Remarks

Product Availability

isReturnPartialResultsOnError

Product Availability

setSaveLayerOnServer

Remarks

Product Availability

isSaveLayerOnServer

Product Availability

setLayerToken

Remarks

Product Availability

getLayerToken

Product Availability

setOrdersByRef

Remarks

Product Availability

getOrders

com.esri.arcgis.networkanalyst
Class NAServerVRPParams