com.esri.arcgis.networkanalyst
Interface INALocatorFeatureAgent

All Superinterfaces:

Serializable

All Known Subinterfaces:

INALocatorFeatureAgent2

All Known Implementing Classes:

NALocatorFeatureAgent

public interface INALocatorFeatureAgent
extends Serializable

Provides access to properties of the feature locator agent.

Superseded By

INALocatorFeatureAgent2

Remarks

INALocatorFeatureAgent has been superseded by INALocatorFeatureAgent2.

Product Availability

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

Method Summary

int	getSnapType() The method of snapping used.
String	getSourceName() The network source name.
int	getSubtypeCode() The subtype to be used to locate features.
boolean	isUseSubtype() Indicates if subtypes should be used to locate features.
void	setSnapType(int pHitPartType) The method of snapping used.
void	setSourceName(String sourceName) The network source name.
void	setSubtypeCode(int subtypeCode) The subtype to be used to locate features.
void	setUseSubtype(boolean useSubtype) Indicates if subtypes should be used to locate features.

Method Detail

setSourceName

void setSourceName(String sourceName)
                   throws IOException,
                          AutomationException

The network source name.

Remarks

The SourceName is the feature class name to be searched.

Product Availability

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

Parameters:

sourceName - The sourceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceName

String getSourceName()
                     throws IOException,
                            AutomationException

The network source name.

Remarks

The SourceName is the feature class name to be searched.

Product Availability

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

Returns:

The sourceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapType

void setSnapType(int pHitPartType)
                 throws IOException,
                        AutomationException

The method of snapping used.

Remarks

The SnapType property determines where along the feature the location will be found. You can snap to endpoints or vertices (junctions) or anywhere along the line (edges).

Product Availability

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

Parameters:

pHitPartType - A com.esri.arcgis.geometry.esriGeometryHitPartType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapType

int getSnapType()
                throws IOException,
                       AutomationException

The method of snapping used.

Remarks

The SnapType property determines where along the feature the location will be found. You can snap to endpoints or vertices (junctions) or anywhere along the line (edges).

Product Availability

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

Returns:

A com.esri.arcgis.geometry.esriGeometryHitPartType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSubtype

void setUseSubtype(boolean useSubtype)
                   throws IOException,
                          AutomationException

Indicates if subtypes should be used to locate features.

Remarks

Setting the UseSubtype property to true allows you to snap only to features of a specific subtype. It is used in conjunction with the SubtypeCode property which specifies which subtype to snap to.

Product Availability

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

Parameters:

useSubtype - The useSubtype (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSubtype

boolean isUseSubtype()
                     throws IOException,
                            AutomationException

Indicates if subtypes should be used to locate features.

Remarks

Setting the UseSubtype property to true allows you to snap only to features of a specific subtype. It is used in conjunction with the SubtypeCode property which specifies which subtype to snap to.

Product Availability

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

Returns:

The useSubtype

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubtypeCode

void setSubtypeCode(int subtypeCode)
                    throws IOException,
                           AutomationException

The subtype to be used to locate features.

Remarks

The SubtypeCode property determines which subtype to snap to when the associated property UseSubtype is true.

Product Availability

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

Parameters:

subtypeCode - The subtypeCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubtypeCode

int getSubtypeCode()
                   throws IOException,
                          AutomationException

The subtype to be used to locate features.

Remarks

The SubtypeCode property determines which subtype to snap to when the associated property UseSubtype is true.

Product Availability

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

Returns:

The subtypeCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.