com.esri.arcgis.trackinganalyst
Class TrackingEngineUtil

java.lang.Object
  com.esri.arcgis.trackinganalyst.TrackingEngineUtil

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IExtension, ITrackingEngineUtil, ITrackingEngineUtil2, java.io.Serializable

public class TrackingEngineUtil
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackingEngineUtil, ITrackingEngineUtil2, IExtension

COM Class 'TrackingEngineUtil'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'A general purpose Utility object for Tracking Analyst that provides a common way to access and determine the processing 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.trackinganalyst.ITrackingEngineUtil2

IID, IIDa1e04dfd_0dda_453a_84e1_a2c88e3e3b6e, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITrackingEngineUtil

IIDc88a0e92_855f_11d7_b877_00010265adc5

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

IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy

Constructor Summary

TrackingEngineUtil()
Constructs a TrackingEngineUtil using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IActiveView	getActiveView() Active view of control or application.
IArray	getBasicMaps() The collection of maps in the control or application.
int	getClientEnvironment() The Clients operating envirionment, e.g., ArcMap, ArcGlobe, Map Control, ...
static java.lang.String	getClsid() getClsid.
IBasicMap	getFocusBasicMap() The current focus map.
IMap	getFocusMap() The current focus map.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IMaps	getMaps() The collection of maps in the control or application.
java.lang.String	getName() The name of the extension.
int	hashCode() the hashcode for this object
boolean	isApplication() Identifies if this object is part of an application.
boolean	isMapControl() Identifies if this object is part of a MapControl.
boolean	isRunningInArcMap() Identifies if this application is ArcMap.
boolean	isRunningInCatalog() Identifies if this application is ArcCatalog.
boolean	isValid() Indicates if this object is in a valid state.
void	release() Release a TrackingEngineUtil.
void	shutdown() Shuts down the extension.
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

TrackingEngineUtil

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

Constructs a TrackingEngineUtil using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TrackingEngineUtil

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

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

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

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

release

public void release()

Release a TrackingEngineUtil.

Specified by:

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

isMapControl

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

Identifies if this object is part of a MapControl.

Specified by:

isMapControl in interface ITrackingEngineUtil

Returns:

The pbvarTrue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isApplication

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

Identifies if this object is part of an application.

Specified by:

isApplication in interface ITrackingEngineUtil

Returns:

The pbvarTrue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRunningInCatalog

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

Identifies if this application is ArcCatalog.

Specified by:

isRunningInCatalog in interface ITrackingEngineUtil

Returns:

The pbvarTrue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRunningInArcMap

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

Identifies if this application is ArcMap.

Specified by:

isRunningInArcMap in interface ITrackingEngineUtil

Returns:

The pbvarTrue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

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

Indicates if this object is in a valid state.

Specified by:

isValid in interface ITrackingEngineUtil

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

Active view of control or application.

Specified by:

getActiveView in interface ITrackingEngineUtil

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFocusMap

public IMap getFocusMap()
                 throws java.io.IOException,
                        AutomationException

The current focus map.

Specified by:

getFocusMap in interface ITrackingEngineUtil

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaps

public IMaps getMaps()
              throws java.io.IOException,
                     AutomationException

The collection of maps in the control or application.

Specified by:

getMaps in interface ITrackingEngineUtil

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClientEnvironment

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

The Clients operating envirionment, e.g., ArcMap, ArcGlobe, Map Control, ... with or without dynamic display.

Specified by:

getClientEnvironment in interface ITrackingEngineUtil2

Returns:

A com.esri.arcgis.trackinganalyst.enumTrackingEnv constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBasicMaps

public IArray getBasicMaps()
                    throws java.io.IOException,
                           AutomationException

The collection of maps in the control or application.

Specified by:

getBasicMaps in interface ITrackingEngineUtil2

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFocusBasicMap

public IBasicMap getFocusBasicMap()
                           throws java.io.IOException,
                                  AutomationException

The current focus map.

Specified by:

getFocusBasicMap in interface ITrackingEngineUtil2

Returns:

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

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.