Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.networkanalyst
Interface INALocator

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
INALocator2, INALocator3
All Known Implementing Classes:
INALocator2Proxy, INALocator3Proxy, INALocatorProxy, NALocator
public interface INALocator
extends java.io.Serializable

COM Interface 'INALocator'. 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 IIDeca487a0_fce8_462c_8df2_37042db4591c
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addLocatorAgent(INALocatorAgent locatorAgent)
          Add a locator agent.
 void bind(INetworkDataset pNetworkDataset, IGPMessages pGPMessages)
          Re-associate the locators with the given network dataset and its schema.
 void createDefault(IDENetworkDataset network)
          Make the default locators.
 INALocatorAgent getLocatorAgent(int index)
          The locator agent by index.
 int getLocatorAgentCount()
          The number of locator agents added.
 INetworkDataset getNetworkDataset()
          The associated network dataset.
 ISpatialReference getOutputSpatialReference()
          The spatial reference for points returned by the locator.
 double getSnapTolerance()
          The distance to search.
 int getSnapToleranceUnits()
          The units of the snap tolerance.
 boolean isFindClosestAmongAllAgents()
          Indicates if the closest location (only) should be returned.
 void queryLocationByPoint(IPoint point, INALocation[] location, IPoint[] outPoint, double[] distanceFromPoint)
          Use the locator agents to find a network location from a point.
 void queryLocationByRow(IRow row, INALocation[] location, double[] distanceFromRow)
          Use the locator agents to find a network location from a row.
 void queryPoint(INALocation location, IPoint[] point)
          The point for a network location.
 void removeLocatorAgent(int index)
          Remove a locator agent by index.
 void setFindClosestAmongAllAgents(boolean findClosest)
          Indicates if the closest location (only) should be returned.
 void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
          The spatial reference for points returned by the locator.
 void setSnapTolerance(double tolerance)
          The distance to search.
 void setSnapToleranceUnits(int units)
          The units of the snap tolerance.
 

Field Detail

IIDeca487a0_fce8_462c_8df2_37042db4591c

static final int IIDeca487a0_fce8_462c_8df2_37042db4591c
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

getNetworkDataset

INetworkDataset getNetworkDataset()
                                  throws java.io.IOException,
                                         AutomationException
The associated network dataset.

Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

void setSnapTolerance(double tolerance)
                      throws java.io.IOException,
                             AutomationException
The distance to search.

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

getSnapTolerance

double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException
The distance to search.

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

setSnapToleranceUnits

void setSnapToleranceUnits(int units)
                           throws java.io.IOException,
                                  AutomationException
The units of the snap tolerance.

Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSnapToleranceUnits

int getSnapToleranceUnits()
                          throws java.io.IOException,
                                 AutomationException
The units of the snap tolerance.

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFindClosestAmongAllAgents

void setFindClosestAmongAllAgents(boolean findClosest)
                                  throws java.io.IOException,
                                         AutomationException
Indicates if the closest location (only) should be returned.

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

isFindClosestAmongAllAgents

boolean isFindClosestAmongAllAgents()
                                    throws java.io.IOException,
                                           AutomationException
Indicates if the closest location (only) should be returned.

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

getLocatorAgentCount

int getLocatorAgentCount()
                         throws java.io.IOException,
                                AutomationException
The number of locator agents added.

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

getLocatorAgent

INALocatorAgent getLocatorAgent(int index)
                                throws java.io.IOException,
                                       AutomationException
The locator agent by index.

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

createDefault

void createDefault(IDENetworkDataset network)
                   throws java.io.IOException,
                          AutomationException
Make the default locators.

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

addLocatorAgent

void addLocatorAgent(INALocatorAgent locatorAgent)
                     throws java.io.IOException,
                            AutomationException
Add a locator agent.

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

removeLocatorAgent

void removeLocatorAgent(int index)
                        throws java.io.IOException,
                               AutomationException
Remove a locator agent by index.

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

queryLocationByPoint

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

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (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.

queryLocationByRow

void queryLocationByRow(IRow row,
                        INALocation[] location,
                        double[] distanceFromRow)
                        throws java.io.IOException,
                               AutomationException
Use the locator agents to find a network location from a row.

Parameters:
row - A reference to a com.esri.arcgis.geodatabase.IRow (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.

queryPoint

void queryPoint(INALocation location,
                IPoint[] point)
                throws java.io.IOException,
                       AutomationException
The point for a network location.

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

bind

void bind(INetworkDataset pNetworkDataset,
          IGPMessages pGPMessages)
          throws java.io.IOException,
                 AutomationException
Re-associate the locators with the given network dataset and its schema.

Parameters:
pNetworkDataset - A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)
pGPMessages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                                    throws java.io.IOException,
                                           AutomationException
The spatial reference for points returned by the locator.

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

getOutputSpatialReference

ISpatialReference getOutputSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException
The spatial reference for points returned by the locator.

Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD