com.esri.arcgis.networkanalyst
Interface INAServerSolverParams

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

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

All Known Implementing Classes:

INAServerClosestFacilityParams2Proxy, INAServerClosestFacilityParams3Proxy, INAServerClosestFacilityParamsProxy, INAServerLocationAllocationParamsProxy, INAServerODCostMatrixParamsProxy, INAServerRouteParams2Proxy, INAServerRouteParams3Proxy, INAServerRouteParamsProxy, INAServerServiceAreaParams2Proxy, INAServerServiceAreaParamsProxy, INAServerSolverParams2Proxy, INAServerSolverParams3Proxy, INAServerSolverParamsProxy, INAServerVRPParamsProxy, NAServerClosestFacilityParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerRouteParams, NAServerServiceAreaParams, NAServerVRPParams

public interface INAServerSolverParams
extends java.io.Serializable

COM Interface 'INAServerSolverParams'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description: 'Deprecated as of 10.0. Provides access to properties that specify the solver settings and return parameters used during network analysis with NAServer.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID40635a1f_4c95_4f57_a220_c683941715e5
static int	xxDummy Deprecated. Internal use only

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 .
java.lang.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(java.lang.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.

Field Detail

IID40635a1f_4c95_4f57_a220_c683941715e5

static final int IID40635a1f_4c95_4f57_a220_c683941715e5

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setNALayerName

void setNALayerName(java.lang.String nALayerName)
                    throws java.io.IOException,
                           AutomationException

Network analysis layer name.

Parameters:

nALayerName - The nALayerName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNALayerName

java.lang.String getNALayerName()
                                throws java.io.IOException,
                                       AutomationException

Network analysis layer name.

Returns:

The nALayerName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

void setSnapTolerance(double snapTolerance)
                      throws java.io.IOException,
                             AutomationException

Minimum search tolerance used when attempting to load network locations.

Parameters:

snapTolerance - The snapTolerance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException

Minimum search tolerance used when attempting to load network locations.

Returns:

The snapTolerance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxSnapTolerance

void setMaxSnapTolerance(double maxSnapTolerance)
                         throws java.io.IOException,
                                AutomationException

Maximum search tolerance used when attempting to load network locations.

Parameters:

maxSnapTolerance - The maxSnapTolerance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSnapTolerance

double getMaxSnapTolerance()
                           throws java.io.IOException,
                                  AutomationException

Maximum search tolerance used when attempting to load network locations.

Returns:

The maxSnapTolerance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapToleranceUnits

void setSnapToleranceUnits(int snapToleranceUnits)
                           throws java.io.IOException,
                                  AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Parameters:

snapToleranceUnits - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapToleranceUnits

int getSnapToleranceUnits()
                          throws java.io.IOException,
                                 AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNAClassCandidateFieldMaps

void setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
                                  throws java.io.IOException,
                                         AutomationException

Array of NAClassCandidateFieldMaps .

Parameters:

ppNAClassCandidateFieldMaps - A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNAClassCandidateFieldMaps

INAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
                                                         throws java.io.IOException,
                                                                AutomationException

Array of NAClassCandidateFieldMaps .

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnMap

void setReturnMap(boolean returnMap)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

returnMap - The returnMap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnMap

boolean isReturnMap()
                    throws java.io.IOException,
                           AutomationException

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

Returns:

The returnMap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapDescriptionByRef

void setMapDescriptionByRef(IMapDescription mapDescription)
                            throws java.io.IOException,
                                   AutomationException

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

Parameters:

mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapDescription

IMapDescription getMapDescription()
                                  throws java.io.IOException,
                                         AutomationException

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

Returns:

A reference to a com.esri.arcgis.carto.IMapDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageDescriptionByRef

void setImageDescriptionByRef(IImageDescription imageDescription)
                              throws java.io.IOException,
                                     AutomationException

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

Parameters:

imageDescription - A reference to a com.esri.arcgis.carto.IImageDescription (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageDescription

IImageDescription getImageDescription()
                                      throws java.io.IOException,
                                             AutomationException

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

Returns:

A reference to a com.esri.arcgis.carto.IImageDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                                    throws java.io.IOException,
                                           AutomationException

Spatial reference of the geometries returned with the analysis results.

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

ISpatialReference getOutputSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

Spatial reference of the geometries returned with the analysis results.

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.