com.esri.arcgis.networkanalyst
Interface INALocator3

All Superinterfaces:
INALocator, INALocator2, java.io.Serializable
All Known Implementing Classes:
INALocator3Proxy, NALocator

public interface INALocator3
extends INALocator2, java.io.Serializable

COM Interface 'INALocator3'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description: 'Provides access to properties that apply to all network locators.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDb8fa76f8_a6b2_489f_9b2d_c055ac351255
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALocator2
IID6a658ec8_139d_4b60_8765_c2504cd38d1a
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALocator
IIDeca487a0_fce8_462c_8df2_37042db4591c
 
Method Summary
 void cacheRestrictedElements(INAContext context)
          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.
 boolean isExcludeRestrictedElements()
          Indicates whether to exclude restricted portions of the network when locating points.
 void queryLocationByPointEx(IPoint point, int curbApproach, INALocation[] location, IPoint[] outPoint, double[] distanceFromPoint)
          Use the locator agents to find a network location from a point and curb approach.
 void queryLocationByRowEx(IRow row, int curbApproach, INALocation[] location, double[] distanceFromRow)
          Use the locator agents to find a network location from a row and curb approach.
 void queryLocationRangesByGeometry(IGeometry geometry, INALocationRanges[] locationRanges)
          Use the locator agents to find network location ranges from a geometry.
 void queryLocationRangesByRow(IRow row, INALocationRanges[] locationRanges)
          Use the locator agents to find a network location ranges from a row.
 void setExcludeRestrictedElements(boolean excludeRestricted)
          Indicates whether to exclude restricted portions of the network when locating points.
 
Methods inherited from interface com.esri.arcgis.networkanalyst.INALocator2
geocodeLocation, getMaxSnapTolerance, queryOffsetPoint, reverseGeocodeLocation, setMaxSnapTolerance
 
Methods inherited from interface com.esri.arcgis.networkanalyst.INALocator
addLocatorAgent, bind, createDefault, getLocatorAgent, getLocatorAgentCount, getNetworkDataset, getOutputSpatialReference, getSnapTolerance, getSnapToleranceUnits, isFindClosestAmongAllAgents, queryLocationByPoint, queryLocationByRow, queryPoint, removeLocatorAgent, setFindClosestAmongAllAgents, setOutputSpatialReferenceByRef, setSnapTolerance, setSnapToleranceUnits
 

Field Detail

IIDb8fa76f8_a6b2_489f_9b2d_c055ac351255

static final int IIDb8fa76f8_a6b2_489f_9b2d_c055ac351255
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

queryLocationRangesByGeometry

void queryLocationRangesByGeometry(IGeometry geometry,
                                   INALocationRanges[] locationRanges)
                                   throws java.io.IOException,
                                          AutomationException
Use the locator agents to find network location ranges from a geometry.

Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
locationRanges - A reference to a com.esri.arcgis.networkanalyst.INALocationRanges (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationRangesByRow

void queryLocationRangesByRow(IRow row,
                              INALocationRanges[] locationRanges)
                              throws java.io.IOException,
                                     AutomationException
Use the locator agents to find a network location ranges from a row.

Parameters:
row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
locationRanges - A reference to a com.esri.arcgis.networkanalyst.INALocationRanges (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludeRestrictedElements

void setExcludeRestrictedElements(boolean excludeRestricted)
                                  throws java.io.IOException,
                                         AutomationException
Indicates whether to exclude restricted portions of the network when locating points.

Parameters:
excludeRestricted - The excludeRestricted (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExcludeRestrictedElements

boolean isExcludeRestrictedElements()
                                    throws java.io.IOException,
                                           AutomationException
Indicates whether to exclude restricted portions of the network when locating points.

Returns:
The excludeRestricted
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cacheRestrictedElements

void cacheRestrictedElements(INAContext context)
                             throws java.io.IOException,
                                    AutomationException
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?????O

Parameters:
context - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationByPointEx

void queryLocationByPointEx(IPoint point,
                            int curbApproach,
                            INALocation[] location,
                            IPoint[] outPoint,
                            double[] distanceFromPoint)
                            throws java.io.IOException,
                                   AutomationException
Use the locator agents to find a network location from a point and curb approach.

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
curbApproach - A com.esri.arcgis.networkanalyst.esriNACurbApproachType constant (in)
location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)
outPoint - A reference to a com.esri.arcgis.geometry.IPoint (in/out: use single element array)
distanceFromPoint - The distanceFromPoint (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationByRowEx

void queryLocationByRowEx(IRow row,
                          int curbApproach,
                          INALocation[] location,
                          double[] distanceFromRow)
                          throws java.io.IOException,
                                 AutomationException
Use the locator agents to find a network location from a row and curb approach.

Parameters:
row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
curbApproach - A com.esri.arcgis.networkanalyst.esriNACurbApproachType constant (in)
location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)
distanceFromRow - The distanceFromRow (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.