com.esri.arcgis.trackinganalyst
Interface ITrackingEngineUtil

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITrackingEngineUtil2

All Known Implementing Classes:

TrackingEngineUtil

public interface ITrackingEngineUtil
extends Serializable

Provides access to properties and methods for tracking engine utility.

Superseded By

ITrackingEngineUtil2

Description

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

Remarks

The ITrackingEngineUtil interface has been superseded by ITrackingEngineUtil2. Please consider using the more recent version.

Product Availability

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

Method Summary

IActiveView	getActiveView() Active view of control or application.
IMap	getFocusMap() The current focus map.
IMaps	getMaps() The collection of maps in the control or application.
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.

Method Detail

isMapControl

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.

Returns:

The pbvarTrue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplication

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.

Returns:

The pbvarTrue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInCatalog

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.

Returns:

The pbvarTrue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInArcMap

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.

Returns:

The pbvarTrue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveView

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.

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

IMap getFocusMap()
                 throws IOException,
                        AutomationException

The current focus map.

Product Availability

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

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

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.

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.