com.esri.arcgis.networkanalyst
Interface INALocation

All Superinterfaces:

Serializable

All Known Implementing Classes:

NALocation

public interface INALocation
extends Serializable

Provides access to properties of an NALocation.

Remarks

INALocation is the main interface of the NALocation object. It provides properties to get and set the SourceID, the SourceOID, the SourcePosition, and the Side. It also provides the IsLocated property, which determines if the NALocation is actually located by interrogating the other four properties listed above.

Product Availability

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

Method Summary

int	getSide() The side of the feature.
int	getSourceID() The ID of the network source.
int	getSourceOID() The OID of the feature.
double	getSourcePosition() The position along the feature.
boolean	isLocated() Indicates if the location has been found on the network.
void	setSide(int side) The side of the feature.
void	setSourceID(int sourceID) The ID of the network source.
void	setSourceOID(int sourceOID) The OID of the feature.
void	setSourcePosition(double position) The position along the feature.

Method Detail

setSourceID

void setSourceID(int sourceID)
                 throws IOException,
                        AutomationException

The ID of the network source.

Remarks

The SourceID property specifies the SourceID of the feature class in the NetworkDataset that the NALocation is referencing. The SourceID of the feature class can be retrieved from the ID property on the INetworkSource interface.

Product Availability

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

Parameters:

sourceID - The sourceID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceID

int getSourceID()
                throws IOException,
                       AutomationException

The ID of the network source.

Remarks

The SourceID property specifies the SourceID of the feature class in the NetworkDataset that the NALocation is referencing. The SourceID of the feature class can be retrieved from the ID property on the INetworkSource interface.

Product Availability

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

Returns:

The sourceID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceOID

void setSourceOID(int sourceOID)
                  throws IOException,
                         AutomationException

The OID of the feature.

Remarks

The SourceOID property specifies the ObjectID of the feature in the NetworkDataset that the NALocation is referencing. The SourceOID is used in conjunction with the SourceID to uniquely specify a Feature in the NetworkDataset.

Product Availability

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

Parameters:

sourceOID - The sourceOID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceOID

int getSourceOID()
                 throws IOException,
                        AutomationException

The OID of the feature.

Remarks

The SourceOID property specifies the ObjectID of the feature in the NetworkDataset that the NALocation is referencing. The SourceOID is used in conjunction with the SourceID to uniquely specify a Feature in the NetworkDataset.

Product Availability

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

Returns:

The sourceOID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourcePosition

void setSourcePosition(double position)
                       throws IOException,
                              AutomationException

The position along the feature.

Remarks

The SourcePosition property specifies the position along the feature specified by the SourceID and SourceOID. Valid values are in the range of 0 to 1. A value of 0.25 would translate to 1/4 of the way along the source feature in the digitized direction.

Product Availability

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

Parameters:

position - The position (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourcePosition

double getSourcePosition()
                         throws IOException,
                                AutomationException

The position along the feature.

Remarks

The SourcePosition property specifies the position along the feature specified by the SourceID and SourceOID. Valid values are in the range of 0 to 1. A value of 0.25 would translate to 1/4 of the way along the source feature in the digitized direction.

Product Availability

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

Returns:

The position

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSide

void setSide(int side)
             throws IOException,
                    AutomationException

The side of the feature.

Remarks

The Side property specifies the position of the NALocation in relation to the feature specified by the SourceID and SourceOID. Valid values are dictated by the enumeration esriNAEdgeSideType which has values esriNAEdgeSideRight (1) and esriNAEdgeSideLeft (2). The side is always in relation to the digitized direction of the feature.

Product Availability

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

Parameters:

side - A com.esri.arcgis.networkanalyst.esriNAEdgeSideType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSide

int getSide()
            throws IOException,
                   AutomationException

The side of the feature.

Remarks

The Side property specifies the position of the NALocation in relation to the feature specified by the SourceID and SourceOID. Valid values are dictated by the enumeration esriNAEdgeSideType, which has values esriNAEdgeSideRight (1) and esriNAEdgeSideLeft (2). The side is always in relation to the digitized direction of the feature.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriNAEdgeSideType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLocated

boolean isLocated()
                  throws IOException,
                         AutomationException

Indicates if the location has been found on the network.

Remarks

This property returns True if the SourceID, SourceOID, SourcePosition, and Side properties all have valid values that should correspond to a position along a feature in a NetworkDataset.

Product Availability

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

Returns:

The located

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.