com.esri.arcgis.networkanalyst
Interface INAServerRouteParams

All Superinterfaces:

INAServerSolverParams, java.io.Serializable

All Known Subinterfaces:

INAServerRouteParams2, INAServerRouteParams3

All Known Implementing Classes:

INAServerRouteParams2Proxy, INAServerRouteParams3Proxy, INAServerRouteParamsProxy, NAServerRouteParams

public interface INAServerRouteParams
extends INAServerSolverParams, java.io.Serializable

COM Interface 'INAServerRouteParams'. 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 route 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	IIDd460c034_10cc_4020_af11_cdce257d04d4
static int	xxDummy Deprecated. Internal use only

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

IID40635a1f_4c95_4f57_a220_c683941715e5

Method Summary

INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
java.lang.String	getDirectionsLanguage() Language to use when computing directions.
int	getDirectionsLengthUnits() Length units to use when computing directions.
java.lang.String	getDirectionsTimeAttributeName() Name of network attribute to use for the drive time when computing directions.
INAServerLocations	getStops() RecordSet or array of PropertySets representing Stops loaded as network locations during analysis.
boolean	isReturnBarriers() Indicates if the output barriers recordset should be returned with the analysis results.
boolean	isReturnDirections() Indicates if directions should be generated and returned with the analysis results.
boolean	isReturnRouteGeometries() Indicates if the route geometries should be generated and returned with the analysis results.
boolean	isReturnRoutes() Indicates if the output routes recordset should be returned with the analysis results.
boolean	isReturnStops() Indicates if the output stops recordset should be returned with the analysis results.
void	setBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	setDirectionsLanguage(java.lang.String directionsLanguage) Language to use when computing directions.
void	setDirectionsLengthUnits(int directionsLengthUnits) Length units to use when computing directions.
void	setDirectionsTimeAttributeName(java.lang.String directionsTimeAttributeName) Name of network attribute to use for the drive time when computing directions.
void	setReturnBarriers(boolean returnBarriers) Indicates if the output barriers recordset should be returned with the analysis results.
void	setReturnDirections(boolean returnDirections) Indicates if directions should be generated and returned with the analysis results.
void	setReturnRouteGeometries(boolean returnRouteGeometries) Indicates if the route geometries should be generated and returned with the analysis results.
void	setReturnRoutes(boolean returnRoutes) Indicates if the output routes recordset should be returned with the analysis results.
void	setReturnStops(boolean returnStops) Indicates if the output stops recordset should be returned with the analysis results.
void	setStopsByRef(INAServerLocations stops) RecordSet or array of PropertySets representing Stops loaded as network locations during analysis.

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

Field Detail

IIDd460c034_10cc_4020_af11_cdce257d04d4

static final int IIDd460c034_10cc_4020_af11_cdce257d04d4

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

setStopsByRef

void setStopsByRef(INAServerLocations stops)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

stops - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStops

INAServerLocations getStops()
                            throws java.io.IOException,
                                   AutomationException

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

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBarriersByRef

void setBarriersByRef(INAServerLocations barriers)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

barriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBarriers

INAServerLocations getBarriers()
                               throws java.io.IOException,
                                      AutomationException

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

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnRouteGeometries

void setReturnRouteGeometries(boolean returnRouteGeometries)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the route geometries should be generated and returned with the analysis results.

Parameters:

returnRouteGeometries - The returnRouteGeometries (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnRouteGeometries

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

Indicates if the route geometries should be generated and returned with the analysis results.

Returns:

The returnRouteGeometries

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnRoutes

void setReturnRoutes(boolean returnRoutes)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

returnRoutes - The returnRoutes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnRoutes

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

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

Returns:

The returnRoutes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnStops

void setReturnStops(boolean returnStops)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

returnStops - The returnStops (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnStops

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

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

Returns:

The returnStops

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

void setReturnBarriers(boolean returnBarriers)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

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

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

Returns:

The returnBarriers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnDirections

void setReturnDirections(boolean returnDirections)
                         throws java.io.IOException,
                                AutomationException

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

Parameters:

returnDirections - The returnDirections (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnDirections

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

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

Returns:

The returnDirections

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirectionsLanguage

void setDirectionsLanguage(java.lang.String directionsLanguage)
                           throws java.io.IOException,
                                  AutomationException

Language to use when computing directions.

Parameters:

directionsLanguage - The directionsLanguage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirectionsLanguage

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

Language to use when computing directions.

Returns:

The directionsLanguage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

void setDirectionsLengthUnits(int directionsLengthUnits)
                              throws java.io.IOException,
                                     AutomationException

Length units to use when computing directions.

Parameters:

directionsLengthUnits - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirectionsLengthUnits

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

Length units to use when computing directions.

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirectionsTimeAttributeName

void setDirectionsTimeAttributeName(java.lang.String directionsTimeAttributeName)
                                    throws java.io.IOException,
                                           AutomationException

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

Parameters:

directionsTimeAttributeName - The directionsTimeAttributeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirectionsTimeAttributeName

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

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

Returns:

The directionsTimeAttributeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.