com.esri.arcgis.arcweb
Class ArcWebRouteOptions

java.lang.Object
  extended by com.esri.arcgis.arcweb.ArcWebRouteOptions
All Implemented Interfaces:
IArcWebRouteOptions, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebRouteOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebRouteOptions

A set of parameters describing a route.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ArcWebRouteOptions()
          Constructs a ArcWebRouteOptions using ArcGIS Engine.
ArcWebRouteOptions(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebRouteOptions theArcWebRouteOptions = (ArcWebRouteOptions) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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).
 int hashCode()
          the hashcode for this object
 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).
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ArcWebRouteOptions

public ArcWebRouteOptions()
                   throws IOException,
                          UnknownHostException
Constructs a ArcWebRouteOptions using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ArcWebRouteOptions

public ArcWebRouteOptions(Object obj)
                   throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebRouteOptions theArcWebRouteOptions = (ArcWebRouteOptions) obj;

Construct a ArcWebRouteOptions using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebRouteOptions.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getFilterExtent

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

Product Availability

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

Specified by:
getFilterExtent in interface IArcWebRouteOptions
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

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

Product Availability

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

Specified by:
setFilterExtentByRef in interface IArcWebRouteOptions
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

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

Specified by:
getHighwayPreference in interface IArcWebRouteOptions
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHighwayPreference

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

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

isOptimizeStops

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

Specified by:
isOptimizeStops in interface IArcWebRouteOptions
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOptimizeStops

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

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

getPrecision

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

Specified by:
getPrecision in interface IArcWebRouteOptions
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrecision

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

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

isReturnExtents

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

Specified by:
isReturnExtents in interface IArcWebRouteOptions
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnExtents

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

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

getRouteType

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

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

setRouteType

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

Specified by:
setRouteType in interface IArcWebRouteOptions
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

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

Product Availability

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

Specified by:
getRouteBarriers in interface IArcWebRouteOptions
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

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

Product Availability

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

Specified by:
setRouteBarriersByRef in interface IArcWebRouteOptions
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.