com.esri.arcgis.datasourcesfile
Class SMFlag

java.lang.Object
  com.esri.arcgis.datasourcesfile.SMFlag

All Implemented Interfaces:

ISMFlag, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SMFlag
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISMFlag

The object that represents flag properties.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SMFlag(Object obj)
Construct a SMFlag using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SMFlag

public SMFlag(Object obj)
       throws IOException

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

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

Throws:

IOException - if there are interop problems SMFlag theSMFlag = (SMFlag) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getObjectID

public int getObjectID()
                throws IOException,
                       AutomationException

Flag ID.

Description

Read the street flag ID

Product Availability

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

Specified by:

getObjectID in interface ISMFlag

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectID

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

Specified by:

setObjectID in interface ISMFlag

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPercentAlong

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

Specified by:

getPercentAlong in interface ISMFlag

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPercentAlong

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

Specified by:

setPercentAlong in interface ISMFlag

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSide

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

Specified by:

getSide in interface ISMFlag

Returns:

A com.esri.arcgis.datasourcesfile.esriSMStreetSideType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSide

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

Specified by:

setSide in interface ISMFlag

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

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

Specified by:

getStreetPoint in interface ISMFlag

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

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

Specified by:

setStreetPoint in interface ISMFlag

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.