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, Serializable

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

A general purpose Utility object for Tracking Analyst that provides a common way to access and determine the processing environment.

Product Availability

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

See Also:

Serialized Form

Field Summary

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(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TrackingEngineUtil theTrackingEngineUtil = (TrackingEngineUtil) obj;

Method Summary

boolean	equals(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 String	getClsid() getClsid.
IBasicMap	getFocusBasicMap() The current focus map.
IMap	getFocusMap() The current focus map.
IMaps	getMaps() The collection of maps in the control or application.
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	shutdown() Shuts down the extension.
void	startup(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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

TrackingEngineUtil

public TrackingEngineUtil()
                   throws IOException,
                          UnknownHostException

Constructs a TrackingEngineUtil using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TrackingEngineUtil

public TrackingEngineUtil(Object obj)
                   throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

isMapControl

public boolean isMapControl()
                     throws IOException,
                            AutomationException

Identifies if this object is part of a MapControl.

Remarks

This method has been superseded by the ITrackingEngineUtil::get_ClientEnvironment property.

Product Availability

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

Specified by:

isMapControl in interface ITrackingEngineUtil

Returns:

The pbvarTrue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplication

public boolean isApplication()
                      throws IOException,
                             AutomationException

Identifies if this object is part of an application.

Remarks

This method has been superseded by the ITrackingEngineUtil::get_ClientEnvironment property.

Product Availability

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

Specified by:

isApplication in interface ITrackingEngineUtil

Returns:

The pbvarTrue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInCatalog

public boolean isRunningInCatalog()
                           throws IOException,
                                  AutomationException

Identifies if this application is ArcCatalog.

Remarks

This method has been superseded by the ITrackingEngineUtil::get_ClientEnvironment property.

Product Availability

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

Specified by:

isRunningInCatalog in interface ITrackingEngineUtil

Returns:

The pbvarTrue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInArcMap

public boolean isRunningInArcMap()
                          throws IOException,
                                 AutomationException

Identifies if this application is ArcMap.

Remarks

This method has been superseded by the ITrackingEngineUtil::get_ClientEnvironment property.

Product Availability

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

Specified by:

isRunningInArcMap in interface ITrackingEngineUtil

Returns:

The pbvarTrue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if this object is in a valid state.

Product Availability

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

Specified by:

isValid in interface ITrackingEngineUtil

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws IOException,
                                 AutomationException

Active view of control or application.

Product Availability

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

Specified by:

getActiveView in interface ITrackingEngineUtil

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFocusMap

public IMap getFocusMap()
                 throws IOException,
                        AutomationException

The current focus map.

Product Availability

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

Specified by:

getFocusMap in interface ITrackingEngineUtil

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaps

public IMaps getMaps()
              throws IOException,
                     AutomationException

The collection of maps in the control or application.

Product Availability

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

Specified by:

getMaps in interface ITrackingEngineUtil

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClientEnvironment

public int getClientEnvironment()
                         throws IOException,
                                AutomationException

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

Remarks

ClientEnvironment can be used to determine the client application that Tracking Analyst is running inside. This information can be useful when different operations need to be performed depending on the client hosting Tracking Analyst, i.e. a MapControl vs. a GlobeControl. This method supersedes IsMapControl, IsApplication, IsRunningInCatalog, and IsRunningInArcMap in ITrackingEngineUtil.

Product Availability

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

Specified by:

getClientEnvironment in interface ITrackingEngineUtil2

Returns:

A com.esri.arcgis.trackinganalyst.enumTrackingEnv constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBasicMaps

public IArray getBasicMaps()
                    throws IOException,
                           AutomationException

The collection of maps in the control or application.

Remarks

This property supersedes ITrackingEngineUtil::get_Maps. This property returns a collection of IBasicMap interfaces that are contained in the Map (2D) or Globe (3D) coclass.

Product Availability

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

Specified by:

getBasicMaps in interface ITrackingEngineUtil2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFocusBasicMap

public IBasicMap getFocusBasicMap()
                           throws IOException,
                                  AutomationException

The current focus map.

Remarks

A user's map may comprise one or more Map objects. This property returns an IBasicMap reference to the Map object that currently has focus. In ArcMap, the focus map is the one visible in data view and the one selected in layout view. In ArcGlobe, there can only be one Globe object and FocusBasicMap returns a reference to this object.

Product Availability

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

Specified by:

getFocusBasicMap in interface ITrackingEngineUtil2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the extension.

Specified by:

getName in interface IExtension

Returns:

The extensionName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startup

public void startup(Object initializationData)
             throws IOException,
                    AutomationException

Starts up the extension with the given initialization data.

Specified by:

startup in interface IExtension

Parameters:

initializationData - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException

Shuts down the extension.

Specified by:

shutdown in interface IExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.