com.esri.arcgis.networkanalyst
Interface INALocationRanges

All Superinterfaces:

Serializable

All Known Implementing Classes:

NALocationRanges

public interface INALocationRanges
extends Serializable

Provides access to properties of an NALocationRanges object.

Remarks

INALocationRanges is the main interface of the NALocationRanges object. It provides properties to add and query for junctions and ranges along edges.

Product Availability

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

Method Summary

void	addEdgeRange(int edgeEID, int direction, double fromPosition, double toPosition) Adds an edge EID, as well as the direction and the specified range of positions along that edge, to the NALocationRanges object.
void	addJunction(int junctionEID) Adds a junction EID to the NALocationRanges object.
int	getEdgeRangeCount() Returns the number of edge ranges currently stored in the NALocationRanges object.
int	getJunctionCount() Returns the number of junction EIDs currently stored in the NALocationRanges object.
void	queryEdgeRange(int index, int[] edgeEID, int[] direction, double[] fromPosition, double[] toPosition) Retrieves the edge EID, along with the direction and the range of positions along that edge, stored at the specified index in the NALocationRanges object.
void	queryJunction(int index, int[] junctionEID) Retrieves the junction EID stored at the specified index in the NALocationRanges object.
void	removeAll() Removes all junction and edge information currently stored in the NALocationRanges object.

Method Detail

getJunctionCount

int getJunctionCount()
                     throws IOException,
                            AutomationException

Returns the number of junction EIDs currently stored in the NALocationRanges object.

Remarks

Provides a count of the junction EIDs held by the NALocationRanges object.

Product Availability

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

Returns:

The junctionCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addJunction

void addJunction(int junctionEID)
                 throws IOException,
                        AutomationException

Adds a junction EID to the NALocationRanges object.

Remarks

Adds a junction EID to the set held by the NALocationRanges object.

Product Availability

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

Parameters:

junctionEID - The junctionEID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryJunction

void queryJunction(int index,
                   int[] junctionEID)
                   throws IOException,
                          AutomationException

Retrieves the junction EID stored at the specified index in the NALocationRanges object.

Remarks

Retrieves by index one of the junction EIDs held by the NALocationRanges object.

Product Availability

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

Parameters:

index - The index (in)

junctionEID - The junctionEID (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEdgeRangeCount

int getEdgeRangeCount()
                      throws IOException,
                             AutomationException

Returns the number of edge ranges currently stored in the NALocationRanges object.

Remarks

Provides a count of the edge EIDs held by the NALocationRanges object.

Product Availability

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

Returns:

The edgeRangeCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addEdgeRange

void addEdgeRange(int edgeEID,
                  int direction,
                  double fromPosition,
                  double toPosition)
                  throws IOException,
                         AutomationException

Adds an edge EID, as well as the direction and the specified range of positions along that edge, to the NALocationRanges object.

Remarks

Adds an edge EID, as well as the direction and the specified range along that edge, to the set held by the NALocationRanges object.

Product Availability

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

Parameters:

edgeEID - The edgeEID (in)

direction - A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant (in)

fromPosition - The fromPosition (in)

toPosition - The toPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryEdgeRange

void queryEdgeRange(int index,
                    int[] edgeEID,
                    int[] direction,
                    double[] fromPosition,
                    double[] toPosition)
                    throws IOException,
                           AutomationException

Retrieves the edge EID, along with the direction and the range of positions along that edge, stored at the specified index in the NALocationRanges object.

Remarks

Retrieves by index one of the edge EIDs, along with the direction and the range along that edge, held by the NALocationRanges object.

Product Availability

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

Parameters:

index - The index (in)

edgeEID - The edgeEID (in/out: use single element array)

direction - A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant (in/out: use single element array)

fromPosition - The fromPosition (in/out: use single element array)

toPosition - The toPosition (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all junction and edge information currently stored in the NALocationRanges object.

Remarks

Removes all elements from the set of edge and junction EIDs held by the NALocationRanges object.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.