com.esri.arcgis.networkanalysis
Interface IEdgeFlag

All Superinterfaces:
Serializable
All Known Implementing Classes:
EdgeFlag

public interface IEdgeFlag
extends Serializable

Provides access to members that return and set properties that are specific to edge flags on the network.

Remarks

Edge flags can only be created on edges. If you want to create a flag on a junction use IJunctionFlag.

When To Use

Use the IEdgeFlag interface to create a flag on an edge element in your network. You can specify how far along the edge you want the flag to be placed using the IEdgeFlag::Position method. This value can be a number between 0 and 1. A value of 0 means the flag will be located close to the FROM junction of an edge. A value of 1 means it will be located close to the TO junction of an edge.

You can also set the IEdgeFlag::TwoWay to be True or False. This is used by the ITraceFlowSolver::FindPath method. Setting TwoWay to true means the find path method will find the shortest path by going either direction along the edge from where you placed the flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IJunctionFlag, IEdgeFlag, INetFlag

Method Summary
 float getPosition()
          Position of the flag along the edge.
 boolean isTwoWay()
          Indicates if the trace can proceed in either direction from this edge 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.
 

Method Detail

getPosition

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

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

setPosition

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

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

isTwoWay

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

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

setTwoWay

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

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