com.esri.arcgis.datasourcesfile
Interface ISMRouter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISMRouterProxy, SMRouter

public interface ISMRouter
extends java.io.Serializable

COM Interface 'ISMRouter'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriDataSourcesFile.olb'

Description: 'Deprecated as of 10.1. Provides access to the main functionality for route finding.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID_1_GET_NAME
static java.lang.String	DISPID_12_GET_NAME
static java.lang.String	DISPID_13_GET_NAME
static java.lang.String	DISPID_14_GET_NAME
static java.lang.String	DISPID_2_GET_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_6_PUT_NAME
static java.lang.String	DISPID_8_NAME
static java.lang.String	DISPID_9_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IIDf8b66020_5850_11d7_b321_008048db11de
static int	xxDummy Deprecated. Internal use only

Method Summary

ISMNetBarriersCollection	getBarriers() The network barriers collection of the router object.
ISMFlagCreator	getFlagCreator() The flag creator used by the router object.
java.lang.String	getNetAttributeName() The network attribute that the router object currently uses.
ISMNetAttributesCollection	getNetAttributes() The network attributes collection of the router object.
ISMNetAttributesAccess	getNetAttributesAccess() The network attributes access of the router object.
ISMRoadPreferences	getPreferences() The road preferences used by the router object.
java.lang.String	getProjectionString() The spatial reference of the source data used by the router object.
ISMSpeedGroups	getSpeedGroups() The speed groups used by the router object.
ISMTripPlanSettings	getTripPlanSettings() The trip planning settings used by the router object.
ISMStopsCollection	reorderStops(ISMStopsCollection pISrcStops) Reorders the stops collection to minimize total driving time or distance.
void	setNetAttributeName(java.lang.String pVal) The network attribute that the router object currently uses.
ISMDirections	solve(ISMStopsCollection pIStops, ISMBreakTracker pITracker) Calculates the route using the current settings of the router object.

Field Detail

IIDf8b66020_5850_11d7_b321_008048db11de

static final int IIDf8b66020_5850_11d7_b321_008048db11de

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME

See Also:

Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_6_PUT_NAME

static final java.lang.String DISPID_6_PUT_NAME

See Also:

Constant Field Values

DISPID_8_NAME

static final java.lang.String DISPID_8_NAME

See Also:

Constant Field Values

DISPID_9_NAME

static final java.lang.String DISPID_9_NAME

See Also:

Constant Field Values

DISPID_12_GET_NAME

static final java.lang.String DISPID_12_GET_NAME

See Also:

Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME

See Also:

Constant Field Values

DISPID_14_GET_NAME

static final java.lang.String DISPID_14_GET_NAME

See Also:

Constant Field Values

Method Detail

getBarriers

ISMNetBarriersCollection getBarriers()
                                     throws java.io.IOException,
                                            AutomationException

The network barriers collection of the router object.

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMNetBarriersCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetAttributes

ISMNetAttributesCollection getNetAttributes()
                                            throws java.io.IOException,
                                                   AutomationException

The network attributes collection of the router object.

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMNetAttributesCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreferences

ISMRoadPreferences getPreferences()
                                  throws java.io.IOException,
                                         AutomationException

The road preferences used by the router object.

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMRoadPreferences

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpeedGroups

ISMSpeedGroups getSpeedGroups()
                              throws java.io.IOException,
                                     AutomationException

The speed groups used by the router object.

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMSpeedGroups

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTripPlanSettings

ISMTripPlanSettings getTripPlanSettings()
                                        throws java.io.IOException,
                                               AutomationException

The trip planning settings used by the router object.

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMTripPlanSettings

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetAttributeName

java.lang.String getNetAttributeName()
                                     throws java.io.IOException,
                                            AutomationException

The network attribute that the router object currently uses.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNetAttributeName

void setNetAttributeName(java.lang.String pVal)
                         throws java.io.IOException,
                                AutomationException

The network attribute that the router object currently uses.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reorderStops

ISMStopsCollection reorderStops(ISMStopsCollection pISrcStops)
                                throws java.io.IOException,
                                       AutomationException

Reorders the stops collection to minimize total driving time or distance.

Parameters:

pISrcStops - A reference to a com.esri.arcgis.datasourcesfile.ISMStopsCollection (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMStopsCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

solve

ISMDirections solve(ISMStopsCollection pIStops,
                    ISMBreakTracker pITracker)
                    throws java.io.IOException,
                           AutomationException

Calculates the route using the current settings of the router object.

Parameters:

pIStops - A reference to a com.esri.arcgis.datasourcesfile.ISMStopsCollection (in)

pITracker - A reference to a com.esri.arcgis.datasourcesfile.ISMBreakTracker (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMDirections

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetAttributesAccess

ISMNetAttributesAccess getNetAttributesAccess()
                                              throws java.io.IOException,
                                                     AutomationException

The network attributes access of the router object.

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMNetAttributesAccess

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProjectionString

java.lang.String getProjectionString()
                                     throws java.io.IOException,
                                            AutomationException

The spatial reference of the source data used by the router object.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlagCreator

ISMFlagCreator getFlagCreator()
                              throws java.io.IOException,
                                     AutomationException

The flag creator used by the router object.

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMFlagCreator

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.