com.esri.arcgis.arcweb
Interface IArcWebRouteOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebRouteOptions

public interface IArcWebRouteOptions
extends Serializable

Provides access to members that control ArcWeb route finding.

Product Availability

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


Method Summary
 IEnvelope getFilterExtent()
          The extent of the returned map.
 int getHighwayPreference()
          A preference number 1-100 for using highways (default is 80).
 double getPrecision()
          The minimum distance between points on a route (default is 0.0).
 IPointCollection getRouteBarriers()
          The locations of the route barriers.
 int getRouteType()
          The route searching criteria for using either the quickest or shortest route (default is esriArcWebRouteTypeQuickest).
 boolean isOptimizeStops()
          Indicates if intermediate waypoints are reordered to optimize for distance (default is VARIANT_FALSE).
 boolean isReturnExtents()
          Indicates if an extent is returned for each segment in the route (default is VARIANT_FALSE).
 void setFilterExtentByRef(IEnvelope filterExtent)
          The extent of the returned map.
 void setHighwayPreference(int pVal)
          A preference number 1-100 for using highways (default is 80).
 void setOptimizeStops(boolean pVal)
          Indicates if intermediate waypoints are reordered to optimize for distance (default is VARIANT_FALSE).
 void setPrecision(double pVal)
          The minimum distance between points on a route (default is 0.0).
 void setReturnExtents(boolean pVal)
          Indicates if an extent is returned for each segment in the route (default is VARIANT_FALSE).
 void setRouteBarriersByRef(IPointCollection pointCollection)
          The locations of the route barriers.
 void setRouteType(int pVal)
          The route searching criteria for using either the quickest or shortest route (default is esriArcWebRouteTypeQuickest).
 

Method Detail

getFilterExtent

IEnvelope getFilterExtent()
                          throws IOException,
                                 AutomationException
The extent of the returned map.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilterExtentByRef

void setFilterExtentByRef(IEnvelope filterExtent)
                          throws IOException,
                                 AutomationException
The extent of the returned map.

Product Availability

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

Parameters:
filterExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHighwayPreference

int getHighwayPreference()
                         throws IOException,
                                AutomationException
A preference number 1-100 for using highways (default is 80).

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHighwayPreference

void setHighwayPreference(int pVal)
                          throws IOException,
                                 AutomationException
A preference number 1-100 for using highways (default is 80).

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOptimizeStops

boolean isOptimizeStops()
                        throws IOException,
                               AutomationException
Indicates if intermediate waypoints are reordered to optimize for distance (default is VARIANT_FALSE). Not considered if request contains less than four route stop objects.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOptimizeStops

void setOptimizeStops(boolean pVal)
                      throws IOException,
                             AutomationException
Indicates if intermediate waypoints are reordered to optimize for distance (default is VARIANT_FALSE). Not considered if request contains less than four route stop objects.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrecision

double getPrecision()
                    throws IOException,
                           AutomationException
The minimum distance between points on a route (default is 0.0).

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrecision

void setPrecision(double pVal)
                  throws IOException,
                         AutomationException
The minimum distance between points on a route (default is 0.0).

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnExtents

boolean isReturnExtents()
                        throws IOException,
                               AutomationException
Indicates if an extent is returned for each segment in the route (default is VARIANT_FALSE).

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnExtents

void setReturnExtents(boolean pVal)
                      throws IOException,
                             AutomationException
Indicates if an extent is returned for each segment in the route (default is VARIANT_FALSE).

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteType

int getRouteType()
                 throws IOException,
                        AutomationException
The route searching criteria for using either the quickest or shortest route (default is esriArcWebRouteTypeQuickest).

Product Availability

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

Returns:
A com.esri.arcgis.arcweb.esriArcWebRouteType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRouteType

void setRouteType(int pVal)
                  throws IOException,
                         AutomationException
The route searching criteria for using either the quickest or shortest route (default is esriArcWebRouteTypeQuickest).

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.arcweb.esriArcWebRouteType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteBarriers

IPointCollection getRouteBarriers()
                                  throws IOException,
                                         AutomationException
The locations of the route barriers.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IPointCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRouteBarriersByRef

void setRouteBarriersByRef(IPointCollection pointCollection)
                           throws IOException,
                                  AutomationException
The locations of the route barriers.

Product Availability

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

Parameters:
pointCollection - A reference to a com.esri.arcgis.geometry.IPointCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.