com.esri.arcgis.networkanalyst
Interface INAServerRouteParams3

All Superinterfaces:

INAServerRouteParams, INAServerRouteParams2, INAServerSolverParams, Serializable

All Known Implementing Classes:

NAServerRouteParams

public interface INAServerRouteParams3
extends INAServerRouteParams2, Serializable

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

Remarks

INAServerRouteParams3 provides methods to set input parameters on an NAServerRouteParams object that is then used by the Solve method on INAServer to perform route network analysis.

Product Availability

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

Method Summary

int	getDirectionsOutputType() Type of directions to generate.
String	getDirectionsStyleName() Name of the directions style to use when generating directions.
INAServerLocations	getPolygonBarriers() RecordSet or array of PropertySets representing polygon Barriers loaded as network locations during analysis.
INAServerLocations	getPolylineBarriers() RecordSet or array of PropertySets representing polyline Barriers loaded as network locations during analysis.
boolean	isReturnPolygonBarriers() Indicates if the output polygon barriers recordset should be returned with the analysis results.
boolean	isReturnPolylineBarriers() Indicates if the output polyline barriers recordset should be returned with the analysis results.
void	setDirectionsOutputType(int directionsOutputType) Type of directions to generate.
void	setDirectionsStyleName(String directionsStyleName) Name of the directions style to use when generating directions.
void	setPolygonBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing polygon Barriers loaded as network locations during analysis.
void	setPolylineBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing polyline Barriers loaded as network locations during analysis.
void	setReturnPolygonBarriers(boolean returnBarriers) Indicates if the output polygon barriers recordset should be returned with the analysis results.
void	setReturnPolylineBarriers(boolean returnBarriers) Indicates if the output polyline barriers recordset should be returned with the analysis results.

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

isReturnCompactDirections, setReturnCompactDirections

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

getBarriers, getDirectionsLanguage, getDirectionsLengthUnits, getDirectionsTimeAttributeName, getStops, isReturnBarriers, isReturnDirections, isReturnRouteGeometries, isReturnRoutes, isReturnStops, setBarriersByRef, setDirectionsLanguage, setDirectionsLengthUnits, setDirectionsTimeAttributeName, setReturnBarriers, setReturnDirections, setReturnRouteGeometries, setReturnRoutes, setReturnStops, setStopsByRef

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

setDirectionsOutputType

void setDirectionsOutputType(int directionsOutputType)
                             throws IOException,
                                    AutomationException

Type of directions to generate.

Remarks

DirectionsOutputType defines the type of content of directions.

Product Availability

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

Parameters:

directionsOutputType - A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsOutputType

int getDirectionsOutputType()
                            throws IOException,
                                   AutomationException

Type of directions to generate.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsStyleName

void setDirectionsStyleName(String directionsStyleName)
                            throws IOException,
                                   AutomationException

Name of the directions style to use when generating directions.

Remarks

DirectionsStyleName defines name of the formatting style of directions. For the list of supported styles see NAServer.GetNetworkDescription() and NAServerNetworkDirections class.

Product Availability

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

Parameters:

directionsStyleName - The directionsStyleName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsStyleName

String getDirectionsStyleName()
                              throws IOException,
                                     AutomationException

Name of the directions style to use when generating directions.

Product Availability

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

Returns:

The directionsStyleName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolylineBarriersByRef

void setPolylineBarriersByRef(INAServerLocations barriers)
                              throws IOException,
                                     AutomationException

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

Remarks

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

getPolylineBarriers

INAServerLocations getPolylineBarriers()
                                       throws IOException,
                                              AutomationException

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

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.

setPolygonBarriersByRef

void setPolygonBarriersByRef(INAServerLocations barriers)
                             throws IOException,
                                    AutomationException

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

Remarks

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

getPolygonBarriers

INAServerLocations getPolygonBarriers()
                                      throws IOException,
                                             AutomationException

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

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.

setReturnPolylineBarriers

void setReturnPolylineBarriers(boolean returnBarriers)
                               throws IOException,
                                      AutomationException

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

Remarks

ReturnPolylineBarriers specifies if the PolylineBarriers 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.

isReturnPolylineBarriers

boolean isReturnPolylineBarriers()
                                 throws IOException,
                                        AutomationException

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

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.

setReturnPolygonBarriers

void setReturnPolygonBarriers(boolean returnBarriers)
                              throws IOException,
                                     AutomationException

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

Remarks

ReturnPolygonBarriers specifies if the PolygonBarriers 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.

isReturnPolygonBarriers

boolean isReturnPolygonBarriers()
                                throws IOException,
                                       AutomationException

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

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.