com.esri.arcgis.datasourcesfile
Interface ISMStop

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ISMStopProxy, SMStop

public interface ISMStop
extends java.io.Serializable

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

Description: 'Deprecated as of 10.1. Provides access to the route stop properties.' 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_1_PUT_NAME
           
static java.lang.String DISPID_2_GET_NAME
           
static java.lang.String DISPID_2_PUT_NAME
           
static java.lang.String DISPID_3_GET_NAME
           
static java.lang.String DISPID_3_PUT_NAME
           
static java.lang.String DISPID_4_GET_NAME
           
static java.lang.String DISPID_4_PUT_NAME
           
static java.lang.String DISPID_5_GET_NAME
           
static java.lang.String DISPID_5_PUT_NAME
           
static java.lang.String DISPID_6_GET_NAME
           
static java.lang.String DISPID_6_PUT_NAME
           
static java.lang.String IID
          Deprecated. Internal use only
static int IIDf8b66014_5850_11d7_b321_008048db11de
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 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.
 double getMinDistanceToTurn()
          Minimal allowed distance to turn.
 int getStopID()
          Numeric identifier of the user defined route stop.
 boolean isEnforceSideOfStreet()
          Indicates whether shortest path is restricted when traveling to and from the given stop.
 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.
 

Field Detail

IIDf8b66014_5850_11d7_b321_008048db11de

static final int IIDf8b66014_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_1_PUT_NAME

static final java.lang.String DISPID_1_PUT_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_2_PUT_NAME

static final java.lang.String DISPID_2_PUT_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_3_PUT_NAME

static final java.lang.String DISPID_3_PUT_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_4_PUT_NAME

static final java.lang.String DISPID_4_PUT_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_5_PUT_NAME

static final java.lang.String DISPID_5_PUT_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
Method Detail

getStopID

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStopID

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

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

getDescription

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

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

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

getFlag

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

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

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

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

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

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDuration

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

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

getMinDistanceToTurn

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

Returns:
The pdDist
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinDistanceToTurn

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

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

isEnforceSideOfStreet

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

Returns:
The pbESS
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnforceSideOfStreet

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

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