This document is archived and information here might be outdated.  Recommended version.


INALocator3 Interface (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (NetworkAnalyst)  

INALocator3 Interface

Provides access to properties that apply to all network locators.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Network Analyst Extension.

Members

Description
Method AddLocatorAgent Add a locator agent.
Method Bind Re-associate the locators with the given network dataset and its schema.
Method CacheRestrictedElements The locator will examine the NAContext and its associated NASolver to build a cache of network elements that cannot be located on due to restrictions, barriers, etc. This method should be called before querying the locator whenever ExcludeRestrictedElements i
Method CreateDefault Make the default locators.
Read/write property ExcludeRestrictedElements Indicates whether to exclude restricted portions of the network when locating points.
Read/write property FindClosestAmongAllAgents Indicates if the closest location (only) should be returned.
Method GeocodeLocation The network location at the specified address. Honors side of street if the address locator does.
Read-only property LocatorAgent The locator agent by index.
Read-only property LocatorAgentCount The number of locator agents added.
Read/write property MaxSnapTolerance The maximum distance that can be searched when expanding the snap tolerance. Has the same units as the snap tolerance.
Read-only property NetworkDataset The associated network dataset.
Read/write property OutputSpatialReference The spatial reference for points returned by the locator.
Method QueryLocationByPoint Use the locator agents to find a network location from a point.
Method QueryLocationByPointEx Use the locator agents to find a network location from a point and curb approach.
Method QueryLocationByRow Use the locator agents to find a network location from a row.
Method QueryLocationByRowEx Use the locator agents to find a network location from a row and curb approach.
Method QueryLocationRangesByGeometry Use the locator agents to find network location ranges from a geometry.
Method QueryLocationRangesByRow Use the locator agents to find a network location ranges from a row.
Method QueryOffsetPoint The point offset from a network location.
Method QueryPoint The point for a network location.
Method RemoveLocatorAgent Remove a locator agent by index.
Method ReverseGeocodeLocation The address of the network location. Honors side of street if the address locator does.
Read/write property SnapTolerance The distance to search.
Read/write property SnapToleranceUnits The units of the snap tolerance.

Inherited Interfaces

Interfaces Description
INALocator2 Provides access to properties that apply to all network locators.
INALocator Provides access to properties that apply to all network locators.

CoClasses that implement INALocator3

CoClasses and Classes Description
NALocator Finds network locations for analysis.

Remarks

The INALocator3 interface provides methods to specify settings and make calls to associated NALocatorAgents.

The interface also provides methods that allow the NALocator to automatically expand the snap tolerance when loading network locations.  The tolerance begins at the SnapTolerance and doubles each time until either a network location is found or the MaxSnapTolerance value is reached.

Generally, the NALocator should be retrieved from an NAContext.  However, if you do create an NALocator, or have added a new locator agent, then, before querying the NALocator, Bind should be called on the NALocator to set up the locator agents and associate it with the NetworkDataset.

.NET Samples

Closest facility solver (Code Files: frmClosestFacilitySolver) | ArcGIS Network Analyst extension Engine application (Code Files: frmLoadLocations) | Service area solver (Code Files: frmServiceAreaSolver) | Location-allocation solver (Code Files: frmLocationAllocationSolver) | Vehicle routing problem solver (Code Files: frmVRPSolver) | Origin-destination cost matrix solver (Code Files: frmODCostMatrixSolver) | Route layer (Code Files: Program)

.NET Related Topics

How to load data into a network analysis problem | How to setup, solve, and save a network analysis problem