com.esri.arcgis.trackinganalyst
Interface ITrackingEnvironment

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITrackingEnvironment3

All Known Implementing Classes:

TrackingEnvironment

public interface ITrackingEnvironment
extends Serializable

Provides access to properties and methods used to control the tracking analyst extension.

Description

This interface provides access to properties to indicate the running environment, display manager, default temporal legend group and reference, and whether or not the tracking components are properly licensed.

Product Availability

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

Method Summary

void	close() Closes the Tracking Analyst Environment.
ITemporalLegendGroup	getDefaultTemporalLegendGroup() Returns the default Temporal Legend Group.
ITemporalReference	getDefaultTemporalReference() Returns the default Temporal Reference.
ITAUpdateControl	getDisplayManager() Returns the Tracking Display Manager.
ILabelEngineManager2	getLabelEngineManager() Returns the Tracking Label Engine Manager.
void	initialize(Object pInitializationData) Initializes the Tracking Analyst Environment.
boolean	isAttached() Indicates whether or not the tracking environment is attached to a document object.
boolean	isEnableTemporalDisplayManagement() Indicates if Temporal Management of the Display is enabled.
boolean	isLicensed() Indicates whether or not the tracking components are properly licensed.
boolean	isRunningInApplication() Indicates if the object is attached to an ArcGIS Application.
boolean	isRunningInArcMap() Indicates if the object is attached to ArcMap.
boolean	isRunningInCatalog() Indicates if the object is attached to ArcCatalog.
boolean	isRunningInMapControl() Indicates if the object is attached to a MapControl
void	setEnableTemporalDisplayManagement(boolean pbvarEnableTemporalDisplayManagement) Indicates if Temporal Management of the Display is enabled.
void	setHideTrackingConnectionsFolder(boolean rhs1) Controls whether the Tracking Connections folder is hidden in ArcCatalog.

Method Detail

getLabelEngineManager

ILabelEngineManager2 getLabelEngineManager()
                                           throws IOException,
                                                  AutomationException

Returns the Tracking Label Engine Manager.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ILabelEngineManager2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayManager

ITAUpdateControl getDisplayManager()
                                   throws IOException,
                                          AutomationException

Returns the Tracking Display Manager.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITAUpdateControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTemporalReference

ITemporalReference getDefaultTemporalReference()
                                               throws IOException,
                                                      AutomationException

Returns the default Temporal Reference.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTemporalLegendGroup

ITemporalLegendGroup getDefaultTemporalLegendGroup()
                                                   throws IOException,
                                                          AutomationException

Returns the default Temporal Legend Group.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws IOException,
                  AutomationException

Closes the Tracking Analyst Environment.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

void initialize(Object pInitializationData)
                throws IOException,
                       AutomationException

Initializes the Tracking Analyst Environment.

Product Availability

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

Parameters:

pInitializationData - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLicensed

boolean isLicensed()
                   throws IOException,
                          AutomationException

Indicates whether or not the tracking components are properly licensed.

Product Availability

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

Returns:

The pbvarLicensed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAttached

boolean isAttached()
                   throws IOException,
                          AutomationException

Indicates whether or not the tracking environment is attached to a document object.

Product Availability

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

Returns:

The pbvarAttached

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableTemporalDisplayManagement

boolean isEnableTemporalDisplayManagement()
                                          throws IOException,
                                                 AutomationException

Indicates if Temporal Management of the Display is enabled.

Product Availability

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

Returns:

The pbvarEnableTemporalDisplayManagement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableTemporalDisplayManagement

void setEnableTemporalDisplayManagement(boolean pbvarEnableTemporalDisplayManagement)
                                        throws IOException,
                                               AutomationException

Indicates if Temporal Management of the Display is enabled.

Product Availability

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

Parameters:

pbvarEnableTemporalDisplayManagement - The pbvarEnableTemporalDisplayManagement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInMapControl

boolean isRunningInMapControl()
                              throws IOException,
                                     AutomationException

Indicates if the object is attached to a MapControl

Product Availability

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

Returns:

The pbvarIsRunningInMapControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInApplication

boolean isRunningInApplication()
                               throws IOException,
                                      AutomationException

Indicates if the object is attached to an ArcGIS Application.

Product Availability

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

Returns:

The pbvarIsRunningInApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInCatalog

boolean isRunningInCatalog()
                           throws IOException,
                                  AutomationException

Indicates if the object is attached to ArcCatalog.

Product Availability

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

Returns:

The pbvarIsRunningInCatalog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInArcMap

boolean isRunningInArcMap()
                          throws IOException,
                                 AutomationException

Indicates if the object is attached to ArcMap.

Product Availability

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

Returns:

The pbvarIsRunningInArcMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideTrackingConnectionsFolder

void setHideTrackingConnectionsFolder(boolean rhs1)
                                      throws IOException,
                                             AutomationException

Controls whether the Tracking Connections folder is hidden in ArcCatalog.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.