com.esri.arcgis.datasourcesfile
Class SMStop

java.lang.Object
  extended by com.esri.arcgis.datasourcesfile.SMStop
All Implemented Interfaces:
ISMStop, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class SMStop
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISMStop

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

Description 'Deprecated as of 10.1. The information about route stop.' 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.ISMStop
DISPID_1_GET_NAME, DISPID_1_PUT_NAME, DISPID_2_GET_NAME, DISPID_2_PUT_NAME, DISPID_3_GET_NAME, DISPID_3_PUT_NAME, DISPID_4_GET_NAME, DISPID_4_PUT_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, IID, IIDf8b66014_5850_11d7_b321_008048db11de, xxDummy
 
Constructor Summary
SMStop()
          Constructs a SMStop using ArcGIS Engine.
SMStop(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SMStop theSMStop = (SMStop) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 java.lang.String getDescription()
          Descriptive text of the route stop used in driving directions.
 short getDuration()
          Stop duration in minutes.
 ISMFlag getFlag()
          The SMFlag object of the stop that describes its geographic location.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 double getMinDistanceToTurn()
          Minimal allowed distance to turn.
 int getStopID()
          Numeric identifier of the user defined route stop.
 int hashCode()
          the hashcode for this object
 boolean isEnforceSideOfStreet()
          Indicates whether shortest path is restricted when traveling to and from the given stop.
 void release()
          Release a SMStop.
 void setDescription(java.lang.String pVal)
          Descriptive text of the route stop used in driving directions.
 void setDuration(short pVal)
          Stop duration in minutes.
 void setEnforceSideOfStreet(boolean pbESS)
          Indicates whether shortest path is restricted when traveling to and from the given stop.
 void setFlag(ISMFlag pVal)
          The SMFlag object of the stop that describes its geographic location.
 void setMinDistanceToTurn(double pdDist)
          Minimal allowed distance to turn.
 void setStopID(int pVal)
          Numeric identifier of the user defined route stop.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SMStop

public SMStop()
       throws java.io.IOException,
              java.net.UnknownHostException
Constructs a SMStop using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

SMStop

public SMStop(java.lang.Object obj)
       throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SMStop theSMStop = (SMStop) obj;

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

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

getClsid

public static java.lang.String getClsid()
getClsid.


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

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

getStopID

public int getStopID()
              throws java.io.IOException,
                     AutomationException
Numeric identifier of the user defined route stop.

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

setStopID

public void setStopID(int pVal)
               throws java.io.IOException,
                      AutomationException
Numeric identifier of the user defined route stop.

Specified by:
setStopID in interface ISMStop
Parameters:
pVal - The pVal (in)
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 route stop used in driving directions.

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

setDescription

public void setDescription(java.lang.String pVal)
                    throws java.io.IOException,
                           AutomationException
Descriptive text of the route stop used in driving directions.

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

getFlag

public ISMFlag getFlag()
                throws java.io.IOException,
                       AutomationException
The SMFlag object of the stop that describes its geographic location.

Specified by:
getFlag in interface ISMStop
Returns:
A reference to a com.esri.arcgis.datasourcesfile.ISMFlag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlag

public void setFlag(ISMFlag pVal)
             throws java.io.IOException,
                    AutomationException
The SMFlag object of the stop that describes its geographic location.

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

getDuration

public short getDuration()
                  throws java.io.IOException,
                         AutomationException
Stop duration in minutes.

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

setDuration

public void setDuration(short pVal)
                 throws java.io.IOException,
                        AutomationException
Stop duration in minutes.

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

getMinDistanceToTurn

public double getMinDistanceToTurn()
                            throws java.io.IOException,
                                   AutomationException
Minimal allowed distance to turn.

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

setMinDistanceToTurn

public void setMinDistanceToTurn(double pdDist)
                          throws java.io.IOException,
                                 AutomationException
Minimal allowed distance to turn.

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

isEnforceSideOfStreet

public boolean isEnforceSideOfStreet()
                              throws java.io.IOException,
                                     AutomationException
Indicates whether shortest path is restricted when traveling to and from the given stop.

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

setEnforceSideOfStreet

public void setEnforceSideOfStreet(boolean pbESS)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether shortest path is restricted when traveling to and from the given stop.

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