com.esri.arcgis.networkanalysis
Interface IFlagDisplay

All Superinterfaces:

Serializable

All Known Implementing Classes:

EdgeFlagDisplay, JunctionFlagDisplay

public interface IFlagDisplay
extends Serializable

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

Remarks

Flags need to be created on features in a geometric network. Using the IFlagDisplay interface you can specify which features have a flag on them. Flags need to be created differently depending on whether they are on edge features or junction features.

When To Use

Use the IFlagDisplay interface to specify the feature on which a flag object is located. Using this interface, you can also specify the coordinates and symbology for the flag object.

Product Availability

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

See Also:

IJunctionFlagDisplay, IEdgeFlagDisplay, IFlagDisplay,

Once the EdgeFlagDisplay or JunctionFlagDisplay object is created, you need to get a reference to the IFlagDisplay interface to specify to which feature the flag belongs. This requires knowing three items about a feature:

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 a network element ID (EID) by calling INetElements::QueryIDs.

The utility network analysis extension now needs to know about this flag to use it in any tracing functions. You can add the flag to the extensions using the INetworkAnalysisExtFlags interface.

Method Summary

int	getClientClassID() User-specified client class ID of this flag.
int	getClientFID() User-specified feature ID of the flag.
int	getFeatureClassID() Feature class ID of the element on which the flag is placed.
int	getFID() Feature ID of the network element on which the flag is placed.
IGeometry	getGeometry() Point object containing the flag's coordinates.
int	getSubID() Sub ID of the network element on which the flag is placed.
ISymbol	getSymbol() Symbol used to display the flag.
void	setClientClassID(int clientClassID) User-specified client class ID of this flag.
void	setClientFID(int clientFID) User-specified feature ID of the flag.
void	setFeatureClassID(int fClassID) Feature class ID of the element on which the flag is placed.
void	setFID(int fID) Feature ID of the network element on which the flag is placed.
void	setGeometryByRef(IGeometry geometry) Point object containing the flag's coordinates.
void	setSubID(int subID) Sub ID of the network element on which the flag is placed.
void	setSymbolByRef(ISymbol symbol) Symbol used to display the flag.

Method Detail

getFID

int getFID()
           throws IOException,
                  AutomationException

Feature ID of the network element on which the flag is placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFID

void setFID(int fID)
            throws IOException,
                   AutomationException

Feature ID of the network element on which the flag is placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fID - The fID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubID

int getSubID()
             throws IOException,
                    AutomationException

Sub ID of the network element on which the flag is placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The subID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubID

void setSubID(int subID)
              throws IOException,
                     AutomationException

Sub ID of the network element on which the flag is placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

subID - The subID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureClassID

int getFeatureClassID()
                      throws IOException,
                             AutomationException

Feature class ID of the element on which the flag is placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fClassID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureClassID

void setFeatureClassID(int fClassID)
                       throws IOException,
                              AutomationException

Feature class ID of the element on which the flag is placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fClassID - The fClassID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

ISymbol getSymbol()
                  throws IOException,
                         AutomationException

Symbol used to display the flag.

Remarks

This property is used only for displaying of the flag in ArcMap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

void setSymbolByRef(ISymbol symbol)
                    throws IOException,
                           AutomationException

Symbol used to display the flag.

Remarks

This property is used only for displaying of the flag in ArcMap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws IOException,
                             AutomationException

Point object containing the flag's coordinates.

Remarks

This property is primarily used for displaying the flag in ArcMap.

It is also used by the Utility Network Analysis extension for relocating the flag on the geometric network after edits have been made to the geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

void setGeometryByRef(IGeometry geometry)
                      throws IOException,
                             AutomationException

Point object containing the flag's coordinates.

Remarks

This property is primarily used for displaying the flag in ArcMap.

It is also used by the Utility Network Analysis extension for relocating the flag on the geometric network after edits have been made to the geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (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.

Remarks

Use the ClientClassID property if you want to associate flags with features that do not participate in the network. For example, if you wanted to create flags from a point feature class that did not participate in the network, you could create a flag object for each feature in the feature class, and assign the feature class ID and feature ID from the original feature class to each flag you create.

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.

setClientClassID

void setClientClassID(int clientClassID)
                      throws IOException,
                             AutomationException

User-specified client class ID of this flag.

Remarks

Use the ClientClassID property if you want to associate flags with features that do not participate in the network. For example, if you wanted to create flags from a point feature class that did not participate in the network, you could create a flag object for each feature in the feature class, and assign the feature class ID and feature ID from the original feature class to each flag you create.

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.

getClientFID

int getClientFID()
                 throws IOException,
                        AutomationException

User-specified feature ID of the flag.

Remarks

Use the ClientFID property if you want to associate flags with features that do not participate in the network. For example, if you wanted to create flags from a point feature class that did not participate in the network, you could create a flag object for each feature in the feature class, and assign the feature class ID and feature ID from the original feature class to each flag you create.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The clientFID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClientFID

void setClientFID(int clientFID)
                  throws IOException,
                         AutomationException

User-specified feature ID of the flag.

Remarks

Use the ClientFID property if you want to associate flags with features that do not participate in the network. For example, if you wanted to create flags from a point feature class that did not participate in the network, you could create a flag object for each feature in the feature class, and assign the feature class ID and feature ID from the original feature class to each flag you create.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

clientFID - The clientFID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.