com.esri.arcgis.trackinganalyst
Interface ITAUpdateControl

All Superinterfaces:
Serializable
All Known Implementing Classes:
ITAUpdateControlProxy, TADynamicDisplayRefreshController

public interface ITAUpdateControl
extends Serializable

Provides access to methods needed to manage the dynamic updating of events drawn in ArcMap.

Product Availability

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


Method Summary
 void addLayer(ILayer piLayer)
          Obsolete Method that is unsupported.
 double getMaxUpdateRate()
          Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.
 double getRefreshRate()
          Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.
 String getStatistics()
          Various statistics about dynamic display processing.
 int getUpdateMethod()
          Defines how the display refresh is determined: by number of points or CPU usage.
 int getUpdateValue()
          Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.
 boolean isAutoRefresh()
          Indicates whether or not the map display will refresh automatically when no new data has been received.
 boolean isManualUpdate()
          Indicates whether or not map display must be updated manually when new data is received.
 void refreshDisplay(int enumUpdateType)
          Refreshes the map display in ArcMap.
 void removeLayer(ILayer piLayer)
          Obsolete Method that is unsupported.
 void setAutoRefresh(boolean pVal)
          Indicates whether or not the map display will refresh automatically when no new data has been received.
 void setManualUpdate(boolean pVal)
          Indicates whether or not map display must be updated manually when new data is received.
 void setMaxUpdateRate(double pVal)
          Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.
 void setRefreshRate(double pVal)
          Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.
 void setUpdateMethod(int pVal)
          Defines how the display refresh is determined: by number of points or CPU usage.
 void setUpdateValue(int pVal)
          Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.
 

Method Detail

addLayer

void addLayer(ILayer piLayer)
              throws IOException,
                     AutomationException
Obsolete Method that is unsupported.

Description

This method adds a layer to the Display update controller. Only temporal layers are permitted. If a non-temporal layer is added it is rejected and S_False is returned.

Product Availability

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

Parameters:
piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeLayer

void removeLayer(ILayer piLayer)
                 throws IOException,
                        AutomationException
Obsolete Method that is unsupported.

Description

This method removes a layer from the Controller's management.

Product Availability

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

Parameters:
piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRefreshRate

double getRefreshRate()
                      throws IOException,
                             AutomationException
Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.

Description

Gets and sets the maximum number of seconds between map refreshes if no new data has been received when AutoRefresh is enabled on the dynamic update controller. If no new data has been received to trigger an update refresh this timer will cause the map to refresh. This is important for maintaining time windows and aging. The RefreshRate must be greater than or equal to the MaxUpdateRate and less than or equal to 500 seconds.

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.

setRefreshRate

void setRefreshRate(double pVal)
                    throws IOException,
                           AutomationException
Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.

Product Availability

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

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

getMaxUpdateRate

double getMaxUpdateRate()
                        throws IOException,
                               AutomationException
Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.

Description

Gets and sets the minimum number of seconds between map refreshes when real-time data is being received and AutoRefresh is enabled. The MaxUpdateRate must be between 0.5 and 60 seconds. This timer is triggered only if new data has been received since the last refresh. If data stops being received for an extended period the timer specified by the RefreshRate property will execute to maintain temporal windows and aging.

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.

setMaxUpdateRate

void setMaxUpdateRate(double pVal)
                      throws IOException,
                             AutomationException
Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.

Product Availability

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

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

refreshDisplay

void refreshDisplay(int enumUpdateType)
                    throws IOException,
                           AutomationException
Refreshes the map display in ArcMap.

Remarks

There are five types of screen updates available:

Product Availability

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

Parameters:
enumUpdateType - A com.esri.arcgis.trackinganalyst.enumScreenUpdateType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUpdateMethod

int getUpdateMethod()
                    throws IOException,
                           AutomationException
Defines how the display refresh is determined: by number of points or CPU usage.

Product Availability

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

Returns:
A com.esri.arcgis.trackinganalyst.enumScreenUpdateThresholdType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUpdateMethod

void setUpdateMethod(int pVal)
                     throws IOException,
                            AutomationException
Defines how the display refresh is determined: by number of points or CPU usage.

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumScreenUpdateThresholdType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUpdateValue

int getUpdateValue()
                   throws IOException,
                          AutomationException
Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.

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.

setUpdateValue

void setUpdateValue(int pVal)
                    throws IOException,
                           AutomationException
Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.

Product Availability

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

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

getStatistics

String getStatistics()
                     throws IOException,
                            AutomationException
Various statistics about dynamic display processing.

Description

This method returns a XML string containing named variables of various statistics about display processing for temporal data.

Product Availability

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

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

isManualUpdate

boolean isManualUpdate()
                       throws IOException,
                              AutomationException
Indicates whether or not map display must be updated manually when new data is received.

Remarks

If ManualUpdate is set to true then you are responsible for causing map refreshes to animate the display of tracking data. The primary mechanism to cause a screen refresh is using RefreshDisplay. you can also using IActiveView::Refresh and IActiveView::PartialRefresh, but they are not as optimized for updating tracking data.

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.

setManualUpdate

void setManualUpdate(boolean pVal)
                     throws IOException,
                            AutomationException
Indicates whether or not map display must be updated manually when new data is received.

Product Availability

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

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

isAutoRefresh

boolean isAutoRefresh()
                      throws IOException,
                             AutomationException
Indicates whether or not the map display will refresh automatically when no new data has been received.

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.

setAutoRefresh

void setAutoRefresh(boolean pVal)
                    throws IOException,
                           AutomationException
Indicates whether or not the map display will refresh automatically when no new data has been received.

Product Availability

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

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