com.esri.arcgis.trackinganalyst
Interface ITxActiveTrack

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITxActiveTrackProxy, TADynamicDisplayRefreshController

public interface ITxActiveTrack
extends java.io.Serializable

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

Description: 'Provides the ability to set and work with an active track.' 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	IID97801c2b_6eda_446e_88a9_1ed1450313f6
static int	xxDummy Deprecated. Internal use only

Method Summary

ILayer	getActiveTrack(java.lang.String[] activeTrackName, IMap[] map) The Layer containing the active track and the track name on a given map.
void	getFollowPlaybackRate(double[] playbackRate, int[] units) The playback time between periodic recentering of the most current feature in the active track.
IPoint	getFollowPoint() The most recent follow location.
double	getFollowRate() The time between periodic recentering of the most current feature in the active track.
ISymbol	getFollowSymbol() The symbol used to mark the position of the most current feature in the active track.
double	getFollowThreshold() The percent of visible area to keep the followed feature within.
boolean	isFollow() Indicates whether or not the display should stay centered on the active track.
boolean	isUseFollowRate() Indicates whether or not to follow based on elapsed time.
boolean	recenter() Center the active view around the most current feature of the active track.
void	setActiveTrack(java.lang.String activeTrackName, IMap map, ILayer layer) The Layer containing the active track and the track name on a given map.
void	setFollow(boolean follow) Indicates whether or not the display should stay centered on the active track.
void	setFollowPlaybackRate(double playbackRate, int units) The playback time between periodic recentering of the most current feature in the active track.
void	setFollowRate(double followRate) The time between periodic recentering of the most current feature in the active track.
void	setFollowSymbol(ISymbol followSymbol) The symbol used to mark the position of the most current feature in the active track.
void	setFollowThreshold(double screenPercent) The percent of visible area to keep the followed feature within.
void	setUseFollowRate(boolean useFollowRate) Indicates whether or not to follow based on elapsed time.

Field Detail

IID97801c2b_6eda_446e_88a9_1ed1450313f6

static final int IID97801c2b_6eda_446e_88a9_1ed1450313f6

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

getActiveTrack

ILayer getActiveTrack(java.lang.String[] activeTrackName,
                      IMap[] map)
                      throws java.io.IOException,
                             AutomationException

The Layer containing the active track and the track name on a given map.

Parameters:

activeTrackName - The activeTrackName (out: use single element array)

map - A reference to a com.esri.arcgis.carto.IMap (out: use single element array)

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveTrack

void setActiveTrack(java.lang.String activeTrackName,
                    IMap map,
                    ILayer layer)
                    throws java.io.IOException,
                           AutomationException

The Layer containing the active track and the track name on a given map.

Parameters:

activeTrackName - The activeTrackName (in)

map - A reference to a com.esri.arcgis.carto.IMap (in)

layer - 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.

isFollow

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

Indicates whether or not the display should stay centered on the active track.

Returns:

The follow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollow

void setFollow(boolean follow)
               throws java.io.IOException,
                      AutomationException

Indicates whether or not the display should stay centered on the active track.

Parameters:

follow - The follow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowSymbol

ISymbol getFollowSymbol()
                        throws java.io.IOException,
                               AutomationException

The symbol used to mark the position of the most current feature in the active track.

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollowSymbol

void setFollowSymbol(ISymbol followSymbol)
                     throws java.io.IOException,
                            AutomationException

The symbol used to mark the position of the most current feature in the active track.

Parameters:

followSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowThreshold

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

The percent of visible area to keep the followed feature within.

Returns:

The screenPercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollowThreshold

void setFollowThreshold(double screenPercent)
                        throws java.io.IOException,
                               AutomationException

The percent of visible area to keep the followed feature within.

Parameters:

screenPercent - The screenPercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowRate

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

The time between periodic recentering of the most current feature in the active track.

Returns:

The followRate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollowRate

void setFollowRate(double followRate)
                   throws java.io.IOException,
                          AutomationException

The time between periodic recentering of the most current feature in the active track.

Parameters:

followRate - The followRate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseFollowRate

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

Indicates whether or not to follow based on elapsed time.

Returns:

The useFollowRate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseFollowRate

void setUseFollowRate(boolean useFollowRate)
                      throws java.io.IOException,
                             AutomationException

Indicates whether or not to follow based on elapsed time.

Parameters:

useFollowRate - The useFollowRate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowPlaybackRate

void getFollowPlaybackRate(double[] playbackRate,
                           int[] units)
                           throws java.io.IOException,
                                  AutomationException

The playback time between periodic recentering of the most current feature in the active track.

Parameters:

playbackRate - The playbackRate (out: use single element array)

units - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollowPlaybackRate

void setFollowPlaybackRate(double playbackRate,
                           int units)
                           throws java.io.IOException,
                                  AutomationException

The playback time between periodic recentering of the most current feature in the active track.

Parameters:

playbackRate - The playbackRate (in)

units - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowPoint

IPoint getFollowPoint()
                      throws java.io.IOException,
                             AutomationException

The most recent follow location.

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

recenter

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

Center the active view around the most current feature of the active track.

Returns:

The wasCentered

Throws:

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

AutomationException - If the ArcObject component throws an exception.