com.esri.arcgis.networkanalyst
Interface INAServerRouteParams

All Superinterfaces:

INAServerSolverParams, Serializable

All Known Subinterfaces:

INAServerRouteParams2, INAServerRouteParams3

All Known Implementing Classes:

NAServerRouteParams

public interface INAServerRouteParams
extends INAServerSolverParams, Serializable

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

Superseded By

INAServerRouteParams

Remarks

INAServerRouteParams has been superseded by INAServerRouteParams3.

Product Availability

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

Method Summary

INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
String	getDirectionsLanguage() Language to use when computing directions.
int	getDirectionsLengthUnits() Length units to use when computing directions.
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(String directionsLanguage) Language to use when computing directions.
void	setDirectionsLengthUnits(int directionsLengthUnits) Length units to use when computing directions.
void	setDirectionsTimeAttributeName(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

Method Detail

setStopsByRef

void setStopsByRef(INAServerLocations stops)
                   throws IOException,
                          AutomationException

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

Remarks

Stops specifies an instance of NAServerLocations class to use as input when solving a route problem.

Product Availability

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

Parameters:

stops - 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.

getStops

INAServerLocations getStops()
                            throws IOException,
                                   AutomationException

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

Remarks

Stops specifies an instance of NAServerLocations class to use as input when solving a route problem.

Product Availability

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

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

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.

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

INAServerLocations getBarriers()
                               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.

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.

setReturnRouteGeometries

void setReturnRouteGeometries(boolean returnRouteGeometries)
                              throws IOException,
                                     AutomationException

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

Remarks

ReturnRouteGeometries specifies if the Polylines for the resulting Route features are returned.

Product Availability

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

Parameters:

returnRouteGeometries - The returnRouteGeometries (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnRouteGeometries

boolean isReturnRouteGeometries()
                                throws IOException,
                                       AutomationException

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

Remarks

ReturnRouteGeometries specifies if the Polylines for the resulting Route features are returned.

Product Availability

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

Returns:

The returnRouteGeometries

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnRoutes

void setReturnRoutes(boolean returnRoutes)
                     throws IOException,
                            AutomationException

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

Remarks

ReturnRoutes specifies if the resulting Route features are returned.

Product Availability

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

Parameters:

returnRoutes - The returnRoutes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnRoutes

boolean isReturnRoutes()
                       throws IOException,
                              AutomationException

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

Remarks

ReturnRoutes specifies if the resulting Route features are returned.

Product Availability

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

Returns:

The returnRoutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnStops

void setReturnStops(boolean returnStops)
                    throws IOException,
                           AutomationException

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

Remarks

ReturnStops specifies if the resulting Stop features are returned.

Product Availability

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

Parameters:

returnStops - The returnStops (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnStops

boolean isReturnStops()
                      throws IOException,
                             AutomationException

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

Remarks

ReturnStops specifies if the resulting Stop features are returned.

Product Availability

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

Returns:

The returnStops

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

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.

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

boolean isReturnBarriers()
                         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.

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDirections

void setReturnDirections(boolean returnDirections)
                         throws IOException,
                                AutomationException

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

Remarks

ReturnDirections specifies if directions are calculated during solve and returned in INAServerRouteResults::Directions.

Product Availability

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

Parameters:

returnDirections - The returnDirections (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDirections

boolean isReturnDirections()
                           throws IOException,
                                  AutomationException

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

Remarks

ReturnDirections specifies if directions are calculated during solve and returned in INAServerRouteResults::Directions.

Product Availability

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

Returns:

The returnDirections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLanguage

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.

Parameters:

directionsLanguage - The directionsLanguage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsLanguage

String getDirectionsLanguage()
                             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.

Returns:

The directionsLanguage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

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.

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

int getDirectionsLengthUnits()
                             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.

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsTimeAttributeName

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.

Parameters:

directionsTimeAttributeName - The directionsTimeAttributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsTimeAttributeName

String getDirectionsTimeAttributeName()
                                      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.

Returns:

The directionsTimeAttributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.