com.esri.arcgis.datasourcesfile
Interface ISMFlag

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISMFlagProxy, SMFlag

public interface ISMFlag
extends Serializable

Provides access to the information about a stop's geographic location.

Description

Provides information such as stop location on the street, street side, and position on the street segment.

Product Availability

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

Method Summary

int	getObjectID() Flag ID.
float	getPercentAlong() Flag position along the street segment as a percent of the segment length.
int	getSide() The side of the street that the flag is on.
ISMRouterPoint	getStreetPoint() The geographic location of the flag.
void	setObjectID(int pVal) Flag ID.
void	setPercentAlong(float pVal) Flag position along the street segment as a percent of the segment length.
void	setSide(int pVal) The side of the street that the flag is on.
void	setStreetPoint(ISMRouterPoint pVal) The geographic location of the flag.

Method Detail

getObjectID

int getObjectID()
                throws IOException,
                       AutomationException

Flag ID.

Description

Read the street flag ID

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.

setObjectID

void setObjectID(int pVal)
                 throws IOException,
                        AutomationException

Flag ID.

Description

Write the street flag ID.

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.

getPercentAlong

float getPercentAlong()
                      throws IOException,
                             AutomationException

Flag position along the street segment as a percent of the segment length.

Description

Indicates the flag position along the street in percent.

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.

setPercentAlong

void setPercentAlong(float pVal)
                     throws IOException,
                            AutomationException

Flag position along the street segment as a percent of the segment length.

Description

Write the flag position along the street in percent.

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.

getSide

int getSide()
            throws IOException,
                   AutomationException

The side of the street that the flag is on. Returns an esriSMStreetSideType constant.

Description

Indicates what street direction can be used in the stop.

Remarks

Side property indicates what street direction can be used in stop. It equals esriSMStreetSideLeft value if right side of street (forward direction) is allowed, it equals esriSMStreetSideRight value for left side (backward direction). It equals esriSMStreetSideUndefined if both directions are allowed.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesfile.esriSMStreetSideType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSide

void setSide(int pVal)
             throws IOException,
                    AutomationException

The side of the street that the flag is on. Returns an esriSMStreetSideType constant.

Description

Write the street direction that can be used in the stop.

Remarks

Side property indicates what street direction can be used in stop. It equals esriSMStreetSideLeft value if right side of street (forward direction) is allowed, it equals esriSMStreetSideRight value for left side (backward direction). It equals esriSMStreetSideUndefined if both directions are allowed.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.datasourcesfile.esriSMStreetSideType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStreetPoint

ISMRouterPoint getStreetPoint()
                              throws IOException,
                                     AutomationException

The geographic location of the flag.

Description

Provides the geographic location of the flag.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStreetPoint

void setStreetPoint(ISMRouterPoint pVal)
                    throws IOException,
                           AutomationException

The geographic location of the flag.

Description

Writes the geographic location of the flag.

Product Availability

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

Parameters:

pVal - A reference to a com.esri.arcgis.datasourcesfile.ISMRouterPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.