com.esri.arcgis.datasourcesfile
Class ISMRouterSetupProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesfile.ISMRouterSetupProxy

All Implemented Interfaces:

ISMRouterSetup, Externalizable, Serializable

Direct Known Subclasses:

ISMRouterSetup2Proxy

public class ISMRouterSetupProxy
extends com.esri.arcgis.interop.Dispatch
implements ISMRouterSetup, Serializable

Provides access to router settings, such as restrictions, backtrack policy, length units.

Superseded By

ISMRouterSetup2

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ISMRouterSetupProxy()
	ISMRouterSetupProxy(Object obj)
protected	ISMRouterSetupProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	clearAllRestrictions() Removes all restrictions set on the route solver.
int	getBacktrackPolicy() Controls the backtrack policy of the route solver.
int	getDirectionsLengthUnits() The output length units used in driving directions.
void	removeListener(String iidStr, Object theListener)
void	setBacktrackPolicy(int pVal) Controls the backtrack policy of the route solver.
void	setDirectionsLengthUnits(int pVal) The output length units used in driving directions.
void	setRestriction(ISMRestriction pRestriction) Sets a restriction to be used by the route solver.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISMRouterSetupProxy

public ISMRouterSetupProxy()

ISMRouterSetupProxy

public ISMRouterSetupProxy(Object obj)
                    throws IOException

Throws:

IOException

ISMRouterSetupProxy

protected ISMRouterSetupProxy(Object obj,
                              String iid)
                       throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setRestriction

public void setRestriction(ISMRestriction pRestriction)
                    throws IOException,
                           AutomationException

Sets a restriction to be used by the route solver.

Remarks

The SetRestriction method can be called multiple times to set multiple restrictions on the route solver.

Product Availability

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

Specified by:

setRestriction in interface ISMRouterSetup

Parameters:

pRestriction - A reference to a com.esri.arcgis.datasourcesfile.ISMRestriction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearAllRestrictions

public void clearAllRestrictions()
                          throws IOException,
                                 AutomationException

Removes all restrictions set on the route solver.

Product Availability

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

Specified by:

clearAllRestrictions in interface ISMRouterSetup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBacktrackPolicy

public int getBacktrackPolicy()
                       throws IOException,
                              AutomationException

Controls the backtrack policy of the route solver.

Remarks

The BacktrackPolicy affects how the solver handles U-turns. Please see the esriSMBacktrackPolicy enumeration for possible options.

Product Availability

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

Specified by:

getBacktrackPolicy in interface ISMRouterSetup

Returns:

A com.esri.arcgis.datasourcesfile.esriSMBacktrackPolicy constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBacktrackPolicy

public void setBacktrackPolicy(int pVal)
                        throws IOException,
                               AutomationException

Controls the backtrack policy of the route solver.

Product Availability

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

Specified by:

setBacktrackPolicy in interface ISMRouterSetup

Parameters:

pVal - A com.esri.arcgis.datasourcesfile.esriSMBacktrackPolicy constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsLengthUnits

public int getDirectionsLengthUnits()
                             throws IOException,
                                    AutomationException

The output length units used in driving directions.

Product Availability

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

Specified by:

getDirectionsLengthUnits in interface ISMRouterSetup

Returns:

A com.esri.arcgis.datasourcesfile.esriSMDirectionsLengthUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

public void setDirectionsLengthUnits(int pVal)
                              throws IOException,
                                     AutomationException

The output length units used in driving directions.

Product Availability

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

Specified by:

setDirectionsLengthUnits in interface ISMRouterSetup

Parameters:

pVal - A com.esri.arcgis.datasourcesfile.esriSMDirectionsLengthUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.