Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.datasourcesfile
Class SMRouter

java.lang.Object
  extended by com.esri.arcgis.datasourcesfile.SMRouter
All Implemented Interfaces:
ISMRouter, ISMRouterSetup, ISMRouterSetup2, ISMRoutingMetaData, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable
public class SMRouter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISMRouter, ISMRoutingMetaData, ISMRouterSetup, ISMRouterSetup2

COM Class 'SMRouter'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesFile.olb'

Description 'Deprecated as of 10.1. The object for calculating routes and defining route settings.' 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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.datasourcesfile.ISMRouter
DISPID_1_GET_NAME, DISPID_12_GET_NAME, DISPID_13_GET_NAME, DISPID_14_GET_NAME, DISPID_2_GET_NAME, DISPID_3_GET_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IIDf8b66020_5850_11d7_b321_008048db11de, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesfile.ISMRoutingMetaData
IID, IIDc8128b1a_23c3_4e21_93eb_50739b68f17a, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesfile.ISMRouterSetup2
IID, IID06efa9d2_490c_4325_bf15_3f73f4492f34, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesfile.ISMRouterSetup
IIDa386707f_fb42_4d0e_af12_3c1feb26f771
 
Constructor Summary
SMRouter(java.lang.Object obj)
          Construct a SMRouter using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void clearAllRestrictions()
          Removes all restrictions set on the route solver.
 void clearRestriction(int index)
          The method removes restriction at specified position from the list.
 boolean equals(java.lang.Object o)
          Compare this object with another
 int getBacktrackPolicy()
          Controls the backtrack policy of the route solver.
 ISMNetBarriersCollection getBarriers()
          The network barriers collection of the router object.
 java.lang.String getDescription()
          Descriptive text of the data product used in the routing service.
 int getDirectionsLengthUnits()
          The output length units used in driving directions.
 ISMFlagCreator getFlagCreator()
          The flag creator used by the router object.
 java.lang.String getGeography()
          The name of the geographic region covered by the routing service.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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 getProductName()
          Name of data product.
 java.lang.String getProductVersion()
          Version of data product.
 java.lang.String getProjectionString()
          The spatial reference of the source data used by the router object.
 ISMRestriction getRestriction(int index)
          Restriction at the position, specified by index.
 int getRestrictionCount()
          Number of restrictions in the list, which will be applied when finding route.
 ISMSpeedGroups getSpeedGroups()
          The speed groups used by the router object.
 java.lang.String getTime()
          Date and time of data creation in ISO 8601 format.
 ISMTripPlanSettings getTripPlanSettings()
          The trip planning settings used by the router object.
 java.lang.String getVendor()
          Name of data vendor.
 int hashCode()
          the hashcode for this object
 void release()
          Release a SMRouter.
 ISMStopsCollection reorderStops(ISMStopsCollection pISrcStops)
          Reorders the stops collection to minimize total driving time or distance.
 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 setNetAttributeName(java.lang.String pVal)
          The network attribute that the router object currently uses.
 void setRestriction(ISMRestriction pRestriction)
          Sets a restriction to be used by the route solver.
 ISMDirections solve(ISMStopsCollection pIStops, ISMBreakTracker pITracker)
          Calculates the route using the current settings of the router object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SMRouter

public SMRouter(java.lang.Object obj)
         throws java.io.IOException
Construct a SMRouter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SMRouter.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
SMRouter o = (SMRouter)obj; // will not work

SMRouter o = new SMRouter(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems SMRouter theSMRouter = (SMRouter) obj;
Method Detail

equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a SMRouter.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getBarriers

public ISMNetBarriersCollection getBarriers()
                                     throws java.io.IOException,
                                            AutomationException
The network barriers collection of the router object.

Specified by:
getBarriers in interface ISMRouter
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

public ISMNetAttributesCollection getNetAttributes()
                                            throws java.io.IOException,
                                                   AutomationException
The network attributes collection of the router object.

Specified by:
getNetAttributes in interface ISMRouter
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

public ISMRoadPreferences getPreferences()
                                  throws java.io.IOException,
                                         AutomationException
The road preferences used by the router object.

Specified by:
getPreferences in interface ISMRouter
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

public ISMSpeedGroups getSpeedGroups()
                              throws java.io.IOException,
                                     AutomationException
The speed groups used by the router object.

Specified by:
getSpeedGroups in interface ISMRouter
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

public ISMTripPlanSettings getTripPlanSettings()
                                        throws java.io.IOException,
                                               AutomationException
The trip planning settings used by the router object.

Specified by:
getTripPlanSettings in interface ISMRouter
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

public java.lang.String getNetAttributeName()
                                     throws java.io.IOException,
                                            AutomationException
The network attribute that the router object currently uses.

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

setNetAttributeName

public void setNetAttributeName(java.lang.String pVal)
                         throws java.io.IOException,
                                AutomationException
The network attribute that the router object currently uses.

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

reorderStops

public ISMStopsCollection reorderStops(ISMStopsCollection pISrcStops)
                                throws java.io.IOException,
                                       AutomationException
Reorders the stops collection to minimize total driving time or distance.

Specified by:
reorderStops in interface ISMRouter
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

public ISMDirections solve(ISMStopsCollection pIStops,
                           ISMBreakTracker pITracker)
                    throws java.io.IOException,
                           AutomationException
Calculates the route using the current settings of the router object.

Specified by:
solve in interface ISMRouter
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

public ISMNetAttributesAccess getNetAttributesAccess()
                                              throws java.io.IOException,
                                                     AutomationException
The network attributes access of the router object.

Specified by:
getNetAttributesAccess in interface ISMRouter
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

public java.lang.String getProjectionString()
                                     throws java.io.IOException,
                                            AutomationException
The spatial reference of the source data used by the router object.

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

getFlagCreator

public ISMFlagCreator getFlagCreator()
                              throws java.io.IOException,
                                     AutomationException
The flag creator used by the router object.

Specified by:
getFlagCreator in interface ISMRouter
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.

getVendor

public java.lang.String getVendor()
                           throws java.io.IOException,
                                  AutomationException
Name of data vendor.

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

getProductName

public java.lang.String getProductName()
                                throws java.io.IOException,
                                       AutomationException
Name of data product.

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

getProductVersion

public java.lang.String getProductVersion()
                                   throws java.io.IOException,
                                          AutomationException
Version of data product.

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

getGeography

public java.lang.String getGeography()
                              throws java.io.IOException,
                                     AutomationException
The name of the geographic region covered by the routing service.

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

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
Descriptive text of the data product used in the routing service.

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

getTime

public java.lang.String getTime()
                         throws java.io.IOException,
                                AutomationException
Date and time of data creation in ISO 8601 format.

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

setRestriction

public void setRestriction(ISMRestriction pRestriction)
                    throws java.io.IOException,
                           AutomationException
Sets a restriction to be used by the route solver.

Specified by:
setRestriction in interface ISMRouterSetup
Parameters:
pRestriction - A reference to a com.esri.arcgis.datasourcesfile.ISMRestriction (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearAllRestrictions

public void clearAllRestrictions()
                          throws java.io.IOException,
                                 AutomationException
Removes all restrictions set on the route solver.

Specified by:
clearAllRestrictions in interface ISMRouterSetup
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBacktrackPolicy

public int getBacktrackPolicy()
                       throws java.io.IOException,
                              AutomationException
Controls the backtrack policy of the route solver.

Specified by:
getBacktrackPolicy in interface ISMRouterSetup
Returns:
A com.esri.arcgis.datasourcesfile.esriSMBacktrackPolicy constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBacktrackPolicy

public void setBacktrackPolicy(int pVal)
                        throws java.io.IOException,
                               AutomationException
Controls the backtrack policy of the route solver.

Specified by:
setBacktrackPolicy in interface ISMRouterSetup
Parameters:
pVal - A com.esri.arcgis.datasourcesfile.esriSMBacktrackPolicy constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirectionsLengthUnits

public int getDirectionsLengthUnits()
                             throws java.io.IOException,
                                    AutomationException
The output length units used in driving directions.

Specified by:
getDirectionsLengthUnits in interface ISMRouterSetup
Returns:
A com.esri.arcgis.datasourcesfile.esriSMDirectionsLengthUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

public void setDirectionsLengthUnits(int pVal)
                              throws java.io.IOException,
                                     AutomationException
The output length units used in driving directions.

Specified by:
setDirectionsLengthUnits in interface ISMRouterSetup
Parameters:
pVal - A com.esri.arcgis.datasourcesfile.esriSMDirectionsLengthUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRestrictionCount

public int getRestrictionCount()
                        throws java.io.IOException,
                               AutomationException
Number of restrictions in the list, which will be applied when finding route.

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

getRestriction

public ISMRestriction getRestriction(int index)
                              throws java.io.IOException,
                                     AutomationException
Restriction at the position, specified by index.

Specified by:
getRestriction in interface ISMRouterSetup2
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.datasourcesfile.ISMRestriction
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearRestriction

public void clearRestriction(int index)
                      throws java.io.IOException,
                             AutomationException
The method removes restriction at specified position from the list.

Specified by:
clearRestriction in interface ISMRouterSetup2
Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD