com.esri.arcgis.trackinganalyst
Interface ITrackingEngineUtil2

All Superinterfaces:

ITrackingEngineUtil, Serializable

All Known Implementing Classes:

TrackingEngineUtil

public interface ITrackingEngineUtil2
extends ITrackingEngineUtil, Serializable

Provides access to properties and methods for tracking engine utility.

Description

This interface provides properties and methods to access the running environment (e.g., running in ArcMap, ArcCatalog, etc.), and Maps, Basic Maps, FocusMap, FocusBasicMap and ActiveView for the TrackingEngineUtil object.

Remarks

ITrackingEngineUtil2 supersedes ITrackingEngineUtil. ITrackingEngineUtil2 allows users to access basic maps and focus basic map.

Product Availability

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

Method Summary

IArray	getBasicMaps() The collection of maps in the control or application.
int	getClientEnvironment() The Clients operating envirionment, e.g., ArcMap, ArcGlobe, Map Control, ...
IBasicMap	getFocusBasicMap() The current focus map.

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

getActiveView, getFocusMap, getMaps, isApplication, isMapControl, isRunningInArcMap, isRunningInCatalog, isValid

Method Detail

getClientEnvironment

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.

Returns:

A com.esri.arcgis.trackinganalyst.enumTrackingEnv constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBasicMaps

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.

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

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.

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.