com.esri.arcgis.networkanalyst
Interface INAServerClosestFacilityParams2

All Superinterfaces:

INAServerClosestFacilityParams, INAServerSolverParams, Serializable

All Known Subinterfaces:

INAServerClosestFacilityParams3

All Known Implementing Classes:

NAServerClosestFacilityParams

public interface INAServerClosestFacilityParams2
extends INAServerClosestFacilityParams, Serializable

Deprecated as of 10.0. Provides access to properties that specify the route solver settings and return parameters used during network analysis with 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.

INAServerClosestFacilityParams2 has been superseded by INAServerClosestFacilityParams3.

Product Availability

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

Method Summary

boolean	isReturnCompactDirections() Indicates if compact directions should be generated and returned with the analysis results.
void	setReturnCompactDirections(boolean returnCompactDirections) Indicates if compact directions should be generated and returned with the analysis results.

Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerClosestFacilityParams

getBarriers, getDirectionsLanguage, getDirectionsLengthUnits, getDirectionsTimeAttributeName, getFacilities, getIncidents, isReturnBarriers, isReturnCFRouteGeometries, isReturnCFRoutes, isReturnDirections, isReturnFacilities, isReturnIncidents, setBarriersByRef, setDirectionsLanguage, setDirectionsLengthUnits, setDirectionsTimeAttributeName, setFacilitiesByRef, setIncidentsByRef, setReturnBarriers, setReturnCFRouteGeometries, setReturnCFRoutes, setReturnDirections, setReturnFacilities, setReturnIncidents

Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverParams

getImageDescription, getMapDescription, getMaxSnapTolerance, getNAClassCandidateFieldMaps, getNALayerName, getOutputSpatialReference, getSnapTolerance, getSnapToleranceUnits, isReturnMap, setImageDescriptionByRef, setMapDescriptionByRef, setMaxSnapTolerance, setNAClassCandidateFieldMaps, setNALayerName, setOutputSpatialReferenceByRef, setReturnMap, setSnapTolerance, setSnapToleranceUnits

Method Detail

setReturnCompactDirections

void setReturnCompactDirections(boolean returnCompactDirections)
                                throws IOException,
                                       AutomationException

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

Remarks

ReturnCompactDirections specifies if compact directions are calculated during solve and returned in INAServerClosestFacilityResults2::CompactDirections. These directions contain less information and compressed geometries representing the traversed streets. Due to their smaller size, these directions are better suited for passing across low bandwidth connections than the directions returned by ReturnDirections.

Product Availability

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

Parameters:

returnCompactDirections - The returnCompactDirections (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnCompactDirections

boolean isReturnCompactDirections()
                                  throws IOException,
                                         AutomationException

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

Remarks

ReturnCompactDirections specifies if compact directions are calculated during solve and returned in INAServerClosestFacilityResults2::CompactDirections. These directions contain less information and compressed geometries representing the traversed streets. Due to their smaller size, these directions are better suited for passing across low bandwidth connections than the directions returned by ReturnDirections.

Product Availability

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

Returns:

The returnCompactDirections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.