com.esri.arcgis.networkanalyst
Interface INAServerSolverParams

All Superinterfaces:

Serializable

All Known Subinterfaces:

INAServerClosestFacilityParams, INAServerClosestFacilityParams2, INAServerClosestFacilityParams3, INAServerLocationAllocationParams, INAServerODCostMatrixParams, INAServerRouteParams, INAServerRouteParams2, INAServerRouteParams3, INAServerServiceAreaParams, INAServerServiceAreaParams2, INAServerSolverParams2, INAServerVRPParams

All Known Implementing Classes:

NAServerClosestFacilityParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerRouteParams, NAServerServiceAreaParams, NAServerVRPParams

public interface INAServerSolverParams
extends Serializable

Provides access to properties that specify the solver settings and return parameters used during network analysis with NAServer.

Remarks

INAServerSolverParams has been superseded by INAServerSolverParams2.

Product Availability

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

Method Summary

IImageDescription	getImageDescription() ImageDescription used when generating the MapImage returned with the analysis results.
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.
INAClassCandidateFieldMap[]	getNAClassCandidateFieldMaps() Array of NAClassCandidateFieldMaps .
String	getNALayerName() Network analysis layer name.
ISpatialReference	getOutputSpatialReference() Spatial reference of the geometries returned with the analysis results.
double	getSnapTolerance() Minimum search tolerance used when attempting to load network locations.
int	getSnapToleranceUnits() Length units of the SnapTolerance and MaxSnapTolerance.
boolean	isReturnMap() Indicates if a MapImage should be generated and returned with the analysis results.
void	setImageDescriptionByRef(IImageDescription imageDescription) ImageDescription used when generating the MapImage returned with the analysis results.
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	setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps) Array of NAClassCandidateFieldMaps .
void	setNALayerName(String nALayerName) Network analysis layer name.
void	setOutputSpatialReferenceByRef(ISpatialReference spatialReference) Spatial reference of the geometries returned with the analysis results.
void	setReturnMap(boolean returnMap) Indicates if a MapImage should be generated and returned with the analysis results.
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.

Method Detail

setNALayerName

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.

Parameters:

nALayerName - The nALayerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNALayerName

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.

Returns:

The nALayerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

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.

Parameters:

snapTolerance - The snapTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

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.

Returns:

The snapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxSnapTolerance

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.

Parameters:

maxSnapTolerance - The maxSnapTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSnapTolerance

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.

Returns:

The maxSnapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapToleranceUnits

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.

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

int getSnapToleranceUnits()
                          throws IOException,
                                 AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNAClassCandidateFieldMaps

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.

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

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.

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

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.

Parameters:

returnMap - The returnMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnMap

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.

Returns:

The returnMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapDescriptionByRef

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.

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

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.

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

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.

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

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.

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

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.

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

ISpatialReference getOutputSpatialReference()
                                            throws IOException,
                                                   AutomationException

Spatial reference of the geometries returned with the analysis results.

Remarks

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

Product Availability

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

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.