com.esri.arcgis.datasourcesfile
Interface ISMRouterSetup

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISMRouterSetup2

All Known Implementing Classes:

ISMRouterSetup2Proxy, ISMRouterSetupProxy, SMRouter

public interface ISMRouterSetup
extends 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.

Method Summary

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

Method Detail

setRestriction

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.

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

void clearAllRestrictions()
                          throws IOException,
                                 AutomationException

Removes all restrictions set on the route solver.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBacktrackPolicy

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.

Returns:

A com.esri.arcgis.datasourcesfile.esriSMBacktrackPolicy constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBacktrackPolicy

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.

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

int getDirectionsLengthUnits()
                             throws IOException,
                                    AutomationException

The output length units used in driving directions.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesfile.esriSMDirectionsLengthUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

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.

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.