com.esri.arcgis.networkanalyst
Interface INALocationObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

NALocationFeature, NALocationObject

public interface INALocationObject
extends Serializable

Provides access to network analysis locations.

Remarks

The INALocationObject interface is used to manage the four network location fields on NALocationObject and NALocationFeature objects.

Product Availability

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

Method Summary

INALocation	getNALocation() The network analysis location.
void	queryNALocation(INALocation location) Returns the network location.
void	setNALocation(INALocation location) The network analysis location.

Method Detail

setNALocation

void setNALocation(INALocation location)
                   throws IOException,
                          AutomationException

The network analysis location.

Remarks

The NALocation property specifies the "SourceID", "SourceOID", "PosAlong", and "SideOfEdge" fields of the NALocationObject/NALocationFeature.

After setting INALocation properties on the retrieved NALocation, you must add the NALocation back to the INALocationObject in order for the changes to be reflected in the NALocationObject. You must also call Store on the IRow or IFeature interface in order for these changes to be saved in the database.

Product Availability

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

Parameters:

location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNALocation

INALocation getNALocation()
                          throws IOException,
                                 AutomationException

The network analysis location.

Remarks

The NALocation property specifies the "SourceID", "SourceOID", "PosAlong", and "SideOfEdge" fields of the NALocationObject/NALocationFeature.

If your feature is newly created, be sure to call IRowSubtypes.InitDefaultValues before retrieving the NALocation.

After setting INALocation properties on the retrieved NALocation, you must add the NALocation back to the INALocationObject in order for the changes to be reflected in the NALocationObject. You must also call Store on the IRow or IFeature interface in order for these changes to be saved in the database.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.networkanalyst.INALocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryNALocation

void queryNALocation(INALocation location)
                     throws IOException,
                            AutomationException

Returns the network location.

Remarks

Calling QueryNALocation populates the NALocation object that is passed in as a parameter with values found in the "SourceID", "SourceOID", "PosAlong", and "SideOfEdge" fields of the NALocationObject/NALocationFeature.

Use this method rather than using the NALocation property when you aren't referencing multiple network locations and can use recycling semantics. This will improve overall performance since fewer objects will need to be created.

If your feature is newly created, be sure to call IRowSubtypes.InitDefaultValues before retrieving the NALocation.

After setting INALocation properties on the retrieved NALocation, you must add the NALocation back to the INALocationObject in order for the changes to be reflected in the NALocationObject. You must also call Store on the IRow or IFeature interface in order for these changes to be saved in the database.

Product Availability

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

Parameters:

location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.