com.esri.arcgis.networkanalysis
Class EdgeFlag

java.lang.Object
  com.esri.arcgis.networkanalysis.EdgeFlag

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IEdgeFlag, INetFlag, Serializable

public class EdgeFlag
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEdgeFlag, INetFlag

A container for defining a network flag on an edge element for a trace flow solver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

EdgeFlag()
Constructs a EdgeFlag using ArcGIS Engine.

EdgeFlag(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EdgeFlag theEdgeFlag = (EdgeFlag) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
int	getClientClassID() User-specified client class ID of this flag.
int	getClientID() User-specified client ID of this flag.
static String	getClsid() getClsid.
String	getLabel() Label of this flag.
float	getPosition() Position of the flag along the edge.
int	getUserClassID() User class ID of the network element on which this flag is placed.
int	getUserID() User ID of the network element on which this flag is placed.
int	getUserSubID() User sub ID of the network element on which this flag is placed.
int	hashCode() the hashcode for this object
boolean	isTwoWay() Indicates if the trace can proceed in either direction from this edge flag.
void	setClientClassID(int clientClassID) User-specified client class ID of this flag.
void	setClientID(int clientID) User-specified client ID of this flag.
void	setLabel(String label) Label of this flag.
void	setPosition(float position) Position of the flag along the edge.
void	setTwoWay(boolean twoWay) Indicates if the trace can proceed in either direction from this edge flag.
void	setUserClassID(int userClassID) User class ID of the network element on which this flag is placed.
void	setUserID(int userID) User ID of the network element on which this flag is placed.
void	setUserSubID(int userID) User sub ID of the network element on which this flag is placed.

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

EdgeFlag

public EdgeFlag()
         throws IOException,
                UnknownHostException

Constructs a EdgeFlag using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

EdgeFlag

public EdgeFlag(Object obj)
         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EdgeFlag theEdgeFlag = (EdgeFlag) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

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

getPosition

public float getPosition()
                  throws IOException,
                         AutomationException

Position of the flag along the edge.

Remarks

When you set the position you specify the percent along the edge you want the flag to be placed from the FROM junction of the edge.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPosition in interface IEdgeFlag

Returns:

The position

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(float position)
                 throws IOException,
                        AutomationException

Position of the flag along the edge.

Remarks

When you set the position you specify the percent along the edge you want the flag to be placed from the FROM junction of the edge.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPosition in interface IEdgeFlag

Parameters:

position - The position (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTwoWay

public boolean isTwoWay()
                 throws IOException,
                        AutomationException

Indicates if the trace can proceed in either direction from this edge flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isTwoWay in interface IEdgeFlag

Returns:

The twoWay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTwoWay

public void setTwoWay(boolean twoWay)
               throws IOException,
                      AutomationException

Indicates if the trace can proceed in either direction from this edge flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTwoWay in interface IEdgeFlag

Parameters:

twoWay - The twoWay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException

Label of this flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabel in interface INetFlag

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException

Label of this flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabel in interface INetFlag

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserClassID

public int getUserClassID()
                   throws IOException,
                          AutomationException

User class ID of the network element on which this flag is placed.

Remarks

The UserClassID must be a positive integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserClassID in interface INetFlag

Returns:

The userClassID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserClassID

public void setUserClassID(int userClassID)
                    throws IOException,
                           AutomationException

User class ID of the network element on which this flag is placed.

Remarks

The UserClassID must be a positive integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserClassID in interface INetFlag

Parameters:

userClassID - The userClassID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserID

public int getUserID()
              throws IOException,
                     AutomationException

User ID of the network element on which this flag is placed.

Remarks

The UserID must be a positive integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserID in interface INetFlag

Returns:

The userID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserID

public void setUserID(int userID)
               throws IOException,
                      AutomationException

User ID of the network element on which this flag is placed.

Remarks

The UserID must be a positive integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserID in interface INetFlag

Parameters:

userID - The userID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserSubID

public int getUserSubID()
                 throws IOException,
                        AutomationException

User sub ID of the network element on which this flag is placed.

Remarks

The UserSubID must be a non-negative integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserSubID in interface INetFlag

Returns:

The userID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserSubID

public void setUserSubID(int userID)
                  throws IOException,
                         AutomationException

User sub ID of the network element on which this flag is placed.

Remarks

The UserSubID must be a non-negative integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserSubID in interface INetFlag

Parameters:

userID - The userID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClientClassID

public void setClientClassID(int clientClassID)
                      throws IOException,
                             AutomationException

User-specified client class ID of this flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClientClassID in interface INetFlag

Parameters:

clientClassID - The clientClassID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClientClassID

public int getClientClassID()
                     throws IOException,
                            AutomationException

User-specified client class ID of this flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClientClassID in interface INetFlag

Returns:

The clientClassID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClientID

public void setClientID(int clientID)
                 throws IOException,
                        AutomationException

User-specified client ID of this flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClientID in interface INetFlag

Parameters:

clientID - The clientID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClientID

public int getClientID()
                throws IOException,
                       AutomationException

User-specified client ID of this flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClientID in interface INetFlag

Returns:

The clientID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.