com.esri.arcgis.trackinganalyst
Interface ITAUpdateControl

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITAUpdateControlProxy, TADynamicDisplayRefreshController

public interface ITAUpdateControl
extends java.io.Serializable

COM Interface 'ITAUpdateControl'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to methods needed to manage the dynamic updating of events drawn in ArcMap.' 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	IIDcc018a63_24fb_11d4_b34c_00104ba2abcc
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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.

Field Detail

IIDcc018a63_24fb_11d4_b34c_00104ba2abcc

static final int IIDcc018a63_24fb_11d4_b34c_00104ba2abcc

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

addLayer

void addLayer(ILayer piLayer)
              throws java.io.IOException,
                     AutomationException

Obsolete Method that is unsupported.

Parameters:

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeLayer

void removeLayer(ILayer piLayer)
                 throws java.io.IOException,
                        AutomationException

Obsolete Method that is unsupported.

Parameters:

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRefreshRate

double getRefreshRate()
                      throws java.io.IOException,
                             AutomationException

Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefreshRate

void setRefreshRate(double pVal)
                    throws java.io.IOException,
                           AutomationException

Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxUpdateRate

double getMaxUpdateRate()
                        throws java.io.IOException,
                               AutomationException

Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxUpdateRate

void setMaxUpdateRate(double pVal)
                      throws java.io.IOException,
                             AutomationException

Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshDisplay

void refreshDisplay(int enumUpdateType)
                    throws java.io.IOException,
                           AutomationException

Refreshes the map display in ArcMap.

Parameters:

enumUpdateType - A com.esri.arcgis.trackinganalyst.enumScreenUpdateType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdateMethod

int getUpdateMethod()
                    throws java.io.IOException,
                           AutomationException

Defines how the display refresh is determined: by number of points or CPU usage.

Returns:

A com.esri.arcgis.trackinganalyst.enumScreenUpdateThresholdType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateMethod

void setUpdateMethod(int pVal)
                     throws java.io.IOException,
                            AutomationException

Defines how the display refresh is determined: by number of points or CPU usage.

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumScreenUpdateThresholdType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdateValue

int getUpdateValue()
                   throws java.io.IOException,
                          AutomationException

Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateValue

void setUpdateValue(int pVal)
                    throws java.io.IOException,
                           AutomationException

Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatistics

java.lang.String getStatistics()
                               throws java.io.IOException,
                                      AutomationException

Various statistics about dynamic display processing.

Returns:

The pbstrXMLData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isManualUpdate

boolean isManualUpdate()
                       throws java.io.IOException,
                              AutomationException

Indicates whether or not map display must be updated manually when new data is received.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setManualUpdate

void setManualUpdate(boolean pVal)
                     throws java.io.IOException,
                            AutomationException

Indicates whether or not map display must be updated manually when new data is received.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoRefresh

boolean isAutoRefresh()
                      throws java.io.IOException,
                             AutomationException

Indicates whether or not the map display will refresh automatically when no new data has been received.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoRefresh

void setAutoRefresh(boolean pVal)
                    throws java.io.IOException,
                           AutomationException

Indicates whether or not the map display will refresh automatically when no new data has been received.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.