com.esri.arcgis.controls
Class EngineNetworkAnalystEnvironment

java.lang.Object
  com.esri.arcgis.controls.EngineNetworkAnalystEnvironment

All Implemented Interfaces:

IEngineNetworkAnalystEnvironment, IEngineNetworkAnalystHelper, IEngineNetworkAnalystHelper2, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IExtension, ISupportErrorInfo, IToolSelectedLayer, java.io.Serializable

public class EngineNetworkAnalystEnvironment
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEngineNetworkAnalystEnvironment, IEngineNetworkAnalystHelper, IEngineNetworkAnalystHelper2, ISupportErrorInfo, IConnectionPointContainer, IToolSelectedLayer, IExtension

COM Class 'EngineNetworkAnalystEnvironment'. Generated 3/19/2015 1:20:48 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'A singleton object representing Engine Network Analyst environment.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.controls.IEngineNetworkAnalystEnvironment

IID, IID639780cc_c92a_4fc1_b2d1_0ccdb44117b8, xxDummy

Fields inherited from interface com.esri.arcgis.controls.IEngineNetworkAnalystHelper2

IID, IID716d2d32_dd52_4881_9990_893a4e86bfd8, xxDummy

Fields inherited from interface com.esri.arcgis.controls.IEngineNetworkAnalystHelper

IID9a8b09a3_b728_472b_b623_7d936ee166c3

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.systemUI.IToolSelectedLayer

IID, IIDfc6732db_6295_4b39_b257_8c799ae20567, xxDummy

Fields inherited from interface com.esri.arcgis.system.IExtension

IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy

Constructor Summary

EngineNetworkAnalystEnvironment()
Constructs a EngineNetworkAnalystEnvironment using ArcGIS Engine.

EngineNetworkAnalystEnvironment(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EngineNetworkAnalystEnvironment theEngineNetworkAnalystEnvironment = (EngineNetworkAnalystEnvironment) obj;

Method Summary

void	addIEngineNetworkAnalystEnvironmentEventsListener(IEngineNetworkAnalystEnvironmentEvents theListener) addIEngineNetworkAnalystEnvironmentEventsListener.
void	addNetworkLocation(IPoint pPoint, java.lang.String name) Adds a network location to the NAWindow at the specified point.
void	addNetworkLocationEx(IGeometry pGeometry, java.lang.String name) Adds a network location to the NAWindow at the specified geometry.
void	deleteAllNetworkLocations() Delete all network locations of active category for active analysis.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
static java.lang.String	getClsid() getClsid.
INetworkLayer	getCurrentNetworkLayer() The current network layer.
INAStreetDirectionsContainer	getDirections() Get directions after solving.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLayerIndex() The index of selected layer.
java.lang.String	getName() The name of the extension.
IEngineNAWindow	getNAWindow() The network analysis window.
INetworkLayer	getNetworkLayer(int index) The network layer by index.
int	getNetworkLayerCount() The number of network layers.
int	getShowAnalysisMessagesAfterSolve() The types of messages that are displayed after solving.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isCanAddNetworkLocation() Indicates if a network location can be added to the NAWindow at the specified geometry.
boolean	isCanMoveNetworkLocation() Indicates if the network location of the selected item in the NAWindow can be moevd to the specified geometry.
boolean	isZoomToResultAfterSolve() Indicates if the window should zoom the map to show results after solving.
void	moveNetworkLocation(IPoint pPoint, java.lang.String name) Moves the network location of the selected item in the NAWindow to the specified point.
void	moveNetworkLocationEx(IGeometry pGeometry, java.lang.String name) Moves the network location of the selected item in the NAWindow to the specified geometry.
void	release() Release a EngineNetworkAnalystEnvironment.
void	removeIEngineNetworkAnalystEnvironmentEventsListener(IEngineNetworkAnalystEnvironmentEvents theListener) removeIEngineNetworkAnalystEnvironmentEventsListener.
void	setCurrentNetworkLayer(INetworkLayer layer) The current network layer.
void	setLayerIndex(int layerIndex) The index of selected layer.
void	setShowAnalysisMessagesAfterSolve(int messageTypes) The types of messages that are displayed after solving.
void	setZoomToResultAfterSolve(boolean flag) Indicates if the window should zoom the map to show results after solving.
void	shutdown() Shuts down the extension.
void	solve() Solve for current network locations.
void	startup(java.lang.Object initializationData) Starts up the extension with the given initialization data.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EngineNetworkAnalystEnvironment

public EngineNetworkAnalystEnvironment()
                                throws java.io.IOException,
                                       java.net.UnknownHostException

Constructs a EngineNetworkAnalystEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EngineNetworkAnalystEnvironment

public EngineNetworkAnalystEnvironment(java.lang.Object obj)
                                throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EngineNetworkAnalystEnvironment theEngineNetworkAnalystEnvironment = (EngineNetworkAnalystEnvironment) obj;

Construct a EngineNetworkAnalystEnvironment using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to EngineNetworkAnalystEnvironment.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIEngineNetworkAnalystEnvironmentEventsListener

public void addIEngineNetworkAnalystEnvironmentEventsListener(IEngineNetworkAnalystEnvironmentEvents theListener)
                                                       throws java.io.IOException

addIEngineNetworkAnalystEnvironmentEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.IEngineNetworkAnalystEnvironmentEvents interface.

Throws:

java.io.IOException - If there are communications problems.

removeIEngineNetworkAnalystEnvironmentEventsListener

public void removeIEngineNetworkAnalystEnvironmentEventsListener(IEngineNetworkAnalystEnvironmentEvents theListener)
                                                          throws java.io.IOException

removeIEngineNetworkAnalystEnvironmentEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.IEngineNetworkAnalystEnvironmentEvents interface.

Throws:

java.io.IOException - If there are communications problems.

release

public void release()

Release a EngineNetworkAnalystEnvironment.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getNAWindow

public IEngineNAWindow getNAWindow()
                            throws java.io.IOException,
                                   AutomationException

The network analysis window.

Specified by:

getNAWindow in interface IEngineNetworkAnalystEnvironment

Returns:

A reference to a com.esri.arcgis.controls.IEngineNAWindow

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkLayerCount

public int getNetworkLayerCount()
                         throws java.io.IOException,
                                AutomationException

The number of network layers.

Specified by:

getNetworkLayerCount in interface IEngineNetworkAnalystEnvironment

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkLayer

public INetworkLayer getNetworkLayer(int index)
                              throws java.io.IOException,
                                     AutomationException

The network layer by index.

Specified by:

getNetworkLayer in interface IEngineNetworkAnalystEnvironment

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.INetworkLayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentNetworkLayer

public INetworkLayer getCurrentNetworkLayer()
                                     throws java.io.IOException,
                                            AutomationException

The current network layer.

Specified by:

getCurrentNetworkLayer in interface IEngineNetworkAnalystEnvironment

Returns:

A reference to a com.esri.arcgis.carto.INetworkLayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentNetworkLayer

public void setCurrentNetworkLayer(INetworkLayer layer)
                            throws java.io.IOException,
                                   AutomationException

The current network layer.

Specified by:

setCurrentNetworkLayer in interface IEngineNetworkAnalystEnvironment

Parameters:

layer - A reference to a com.esri.arcgis.carto.INetworkLayer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZoomToResultAfterSolve

public boolean isZoomToResultAfterSolve()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if the window should zoom the map to show results after solving.

Specified by:

isZoomToResultAfterSolve in interface IEngineNetworkAnalystEnvironment

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZoomToResultAfterSolve

public void setZoomToResultAfterSolve(boolean flag)
                               throws java.io.IOException,
                                      AutomationException

Indicates if the window should zoom the map to show results after solving.

Specified by:

setZoomToResultAfterSolve in interface IEngineNetworkAnalystEnvironment

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShowAnalysisMessagesAfterSolve

public int getShowAnalysisMessagesAfterSolve()
                                      throws java.io.IOException,
                                             AutomationException

The types of messages that are displayed after solving.

Specified by:

getShowAnalysisMessagesAfterSolve in interface IEngineNetworkAnalystEnvironment

Returns:

The messageTypes

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowAnalysisMessagesAfterSolve

public void setShowAnalysisMessagesAfterSolve(int messageTypes)
                                       throws java.io.IOException,
                                              AutomationException

The types of messages that are displayed after solving.

Specified by:

setShowAnalysisMessagesAfterSolve in interface IEngineNetworkAnalystEnvironment

Parameters:

messageTypes - The messageTypes (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addNetworkLocation

public void addNetworkLocation(IPoint pPoint,
                               java.lang.String name)
                        throws java.io.IOException,
                               AutomationException

Adds a network location to the NAWindow at the specified point.

Specified by:

addNetworkLocation in interface IEngineNetworkAnalystHelper

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteAllNetworkLocations

public void deleteAllNetworkLocations()
                               throws java.io.IOException,
                                      AutomationException

Delete all network locations of active category for active analysis.

Specified by:

deleteAllNetworkLocations in interface IEngineNetworkAnalystHelper

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirections

public INAStreetDirectionsContainer getDirections()
                                           throws java.io.IOException,
                                                  AutomationException

Get directions after solving.

Specified by:

getDirections in interface IEngineNetworkAnalystHelper

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

solve

public void solve()
           throws java.io.IOException,
                  AutomationException

Solve for current network locations.

Specified by:

solve in interface IEngineNetworkAnalystHelper

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addNetworkLocationEx

public void addNetworkLocationEx(IGeometry pGeometry,
                                 java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Adds a network location to the NAWindow at the specified geometry.

Specified by:

addNetworkLocationEx in interface IEngineNetworkAnalystHelper2

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanAddNetworkLocation

public boolean isCanAddNetworkLocation()
                                throws java.io.IOException,
                                       AutomationException

Indicates if a network location can be added to the NAWindow at the specified geometry.

Specified by:

isCanAddNetworkLocation in interface IEngineNetworkAnalystHelper2

Returns:

The pEnabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveNetworkLocation

public void moveNetworkLocation(IPoint pPoint,
                                java.lang.String name)
                         throws java.io.IOException,
                                AutomationException

Moves the network location of the selected item in the NAWindow to the specified point.

Specified by:

moveNetworkLocation in interface IEngineNetworkAnalystHelper2

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveNetworkLocationEx

public void moveNetworkLocationEx(IGeometry pGeometry,
                                  java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException

Moves the network location of the selected item in the NAWindow to the specified geometry.

Specified by:

moveNetworkLocationEx in interface IEngineNetworkAnalystHelper2

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMoveNetworkLocation

public boolean isCanMoveNetworkLocation()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if the network location of the selected item in the NAWindow can be moevd to the specified geometry.

Specified by:

isCanMoveNetworkLocation in interface IEngineNetworkAnalystHelper2

Returns:

The pEnabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerIndex

public void setLayerIndex(int layerIndex)
                   throws java.io.IOException,
                          AutomationException

The index of selected layer.

Specified by:

setLayerIndex in interface IToolSelectedLayer

Parameters:

layerIndex - The layerIndex (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerIndex

public int getLayerIndex()
                  throws java.io.IOException,
                         AutomationException

The index of selected layer.

Specified by:

getLayerIndex in interface IToolSelectedLayer

Returns:

The layerIndex

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the extension.

Specified by:

getName in interface IExtension

Returns:

The extensionName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startup

public void startup(java.lang.Object initializationData)
             throws java.io.IOException,
                    AutomationException

Starts up the extension with the given initialization data.

Specified by:

startup in interface IExtension

Parameters:

initializationData - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws java.io.IOException,
                     AutomationException

Shuts down the extension.

Specified by:

shutdown in interface IExtension

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.