com.esri.arcgis.datasourcesfile
Interface ISMStop

All Superinterfaces:
Serializable
All Known Implementing Classes:
SMStop

public interface ISMStop
extends Serializable

Provides access to the route stop properties.

Description

Provides information about the route stop.

Product Availability

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


Method Summary
 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(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.
 

Method Detail

getStopID

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

Description

Represents the numeric user-defined stop identifier.

Product Availability

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

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

setStopID

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

Description

Sets the numeric user-defined stop identifier.

Product Availability

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

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

getDescription

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

Description

Returns the description text of the stop.

Product Availability

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

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

setDescription

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

Description

Sets the description text of the stop.

Product Availability

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

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

getFlag

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

Description

Returns the ISMFlag interface of the stop.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.datasourcesfile.ISMFlag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlag

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

Description

Sets the ISMFlag interface of the stop.

Product Availability

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

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

getDuration

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

Description

Returns stop duration in minutes.

Product Availability

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

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

setDuration

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

Description

Sets stop duration in minutes.

Product Availability

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

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

getMinDistanceToTurn

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

Description

Returns the minimum allowed distance to turn.

Remarks

This value is used to indicate how SMRouter should handle the first turn of each route leg. The Router generates the shortest path route in a way that the first turn does not appear within the MinDistanceToTurn specified in miles, unless a turn is required to proceed based on the current direction of travel (i.e. road ends, fork in the road, etc.) In the scenario where a turn is required, the route is generated from the street that has the least turn angle from the preceding street. In the case where turn angles are within 10 of each other, these are considered equal turn angles, and the route is generated from the intersection that is being traveled through.

Product Availability

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

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

setMinDistanceToTurn

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

Description

Sets the minimal allowed distance for a turn.

Remarks

This value is used to indicate how SMRouter should handle the first turn of each route leg. The Router generates the shortest path route in a way that the first turn does not appear within the MinDistanceToTurn specified in miles, unless a turn is required to proceed based on the current direction of travel (i.e. road ends, fork in the road, etc.) In the scenario where a turn is required, the route is generated from the street that has the least turn angle from the preceding street. In the case where turn angles are within 10 of each other, these are considered equal turn angles, and the route is generated from the intersection that is being traveled through.

Product Availability

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

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

isEnforceSideOfStreet

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

Description

Enforces street side at the stop. Returns the street side.

Remarks

If this value is set to true, the shortest path is restricted when traveling to and from the given stop. The restriction is that the shortest path can enter the street from only one end-point and exit from the other, depending on which side of the street the stop is located. If the flag is not set, the shortest path can enter the street in either direction. Unless otherwise specified by the caller, the default value for this flag is false.

Note: If the street is one-way, the shortest path always enters the street in the correct direction.

Product Availability

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

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

setEnforceSideOfStreet

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

Description

Enforces street side at the stop. Sets the street side.

Remarks

If this value is set to true, the shortest path is restricted when traveling to and from the given stop. The restriction is that the shortest path can enter the street from only one end-point and exit from the other, depending on which side of the street the stop is located. If the flag is not set, the shortest path can enter the street in either direction. Unless otherwise specified by the caller, the default value for this flag is false.

Note: If the street is one-way, the shortest path always enters the street in the correct direction.

Product Availability

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

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