com.esri.arcgis.networkanalysis
Interface INetFlag

All Superinterfaces:
Serializable
All Known Implementing Classes:
EdgeFlag, JunctionFlag

public interface INetFlag
extends Serializable

Provides access to members that specify the network element on which a flag is located.

Remarks

Flags are the starting points of tracing operations on networks. Flags can either be placed on edges or junctions.

When To Use

When you create either an edge flag or junction flag you have a reference to the INetFlaginterface of that flag. Through this object you can set the flag to your network for a tracing operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IJunctionFlag, IEdgeFlag,

Once the EdgeFlag or JunctionFlag object is created, you need to get a reference to the INetFlag interface to specify to which network element the flag belongs. This requires knowing three items about a network element:

1. UserClassID - This is the ID of the feature class which the feature belongs to.

2. UserID - This is the ID of the feature within the feature class.

3. UserSubID - This is the ID of an individual element within a feature.

These three properties can be queried from an element ID (EID) by calling INetElements::QueryIDs.

The TraceFlowSolver object needs to know about this flag before it can use it in any tracing functions. Once you have created all your flags for your trace, you can add them to the TraceFlowSolver object by calling PutEdgeOrigins or PutJunctionOrigins on the ITraceFlowSolver interface.


Method Summary
 int getClientClassID()
          User-specified client class ID of this flag.
 int getClientID()
          User-specified client ID of this flag.
 String getLabel()
          Label of this flag.
 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.
 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 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.
 

Method Detail

getLabel

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

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

setLabel

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

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

getUserClassID

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

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

setUserClassID

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

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

getUserID

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

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

setUserID

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

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

getUserSubID

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

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

setUserSubID

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

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

setClientClassID

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

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

getClientClassID

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

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

setClientID

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

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

getClientID

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

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