com.esri.arcgis.trackinganalyst
Interface ITrackingEnvironment

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ITrackingEnvironment3
All Known Implementing Classes:
ITrackingEnvironment3Proxy, ITrackingEnvironmentProxy, TrackingEnvironment

public interface ITrackingEnvironment
extends java.io.Serializable

COM Interface 'ITrackingEnvironment'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties and methods used to control the tracking analyst extension.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDdfa80020_7dd6_11d7_b877_00010265adc5
           
static int xxDummy
          Deprecated. Internal use only
 
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(java.lang.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.
 

Field Detail

IIDdfa80020_7dd6_11d7_b877_00010265adc5

static final int IIDdfa80020_7dd6_11d7_b877_00010265adc5
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getLabelEngineManager

ILabelEngineManager2 getLabelEngineManager()
                                           throws java.io.IOException,
                                                  AutomationException
Returns the Tracking Label Engine Manager.

Returns:
A reference to a com.esri.arcgis.trackinganalyst.ILabelEngineManager2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayManager

ITAUpdateControl getDisplayManager()
                                   throws java.io.IOException,
                                          AutomationException
Returns the Tracking Display Manager.

Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITAUpdateControl
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultTemporalReference

ITemporalReference getDefaultTemporalReference()
                                               throws java.io.IOException,
                                                      AutomationException
Returns the default Temporal Reference.

Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultTemporalLegendGroup

ITemporalLegendGroup getDefaultTemporalLegendGroup()
                                                   throws java.io.IOException,
                                                          AutomationException
Returns the default Temporal Legend Group.

Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws java.io.IOException,
                  AutomationException
Closes the Tracking Analyst Environment.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initialize

void initialize(java.lang.Object pInitializationData)
                throws java.io.IOException,
                       AutomationException
Initializes the Tracking Analyst Environment.

Parameters:
pInitializationData - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLicensed

boolean isLicensed()
                   throws java.io.IOException,
                          AutomationException
Indicates whether or not the tracking components are properly licensed.

Returns:
The pbvarLicensed
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAttached

boolean isAttached()
                   throws java.io.IOException,
                          AutomationException
Indicates whether or not the tracking environment is attached to a document object.

Returns:
The pbvarAttached
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnableTemporalDisplayManagement

boolean isEnableTemporalDisplayManagement()
                                          throws java.io.IOException,
                                                 AutomationException
Indicates if Temporal Management of the Display is enabled.

Returns:
The pbvarEnableTemporalDisplayManagement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnableTemporalDisplayManagement

void setEnableTemporalDisplayManagement(boolean pbvarEnableTemporalDisplayManagement)
                                        throws java.io.IOException,
                                               AutomationException
Indicates if Temporal Management of the Display is enabled.

Parameters:
pbvarEnableTemporalDisplayManagement - The pbvarEnableTemporalDisplayManagement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRunningInMapControl

boolean isRunningInMapControl()
                              throws java.io.IOException,
                                     AutomationException
Indicates if the object is attached to a MapControl

Returns:
The pbvarIsRunningInMapControl
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRunningInApplication

boolean isRunningInApplication()
                               throws java.io.IOException,
                                      AutomationException
Indicates if the object is attached to an ArcGIS Application.

Returns:
The pbvarIsRunningInApplication
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRunningInCatalog

boolean isRunningInCatalog()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the object is attached to ArcCatalog.

Returns:
The pbvarIsRunningInCatalog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRunningInArcMap

boolean isRunningInArcMap()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the object is attached to ArcMap.

Returns:
The pbvarIsRunningInArcMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHideTrackingConnectionsFolder

void setHideTrackingConnectionsFolder(boolean rhs1)
                                      throws java.io.IOException,
                                             AutomationException
Controls whether the Tracking Connections folder is hidden in ArcCatalog.

Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.