com.esri.arcgis.trackinganalyst
Interface ITxActiveTrack

All Superinterfaces:

Serializable

All Known Implementing Classes:

TADynamicDisplayRefreshController

public interface ITxActiveTrack
extends Serializable

Provides the ability to set and work with an active track.

Product Availability

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

Method Summary

ILayer	getActiveTrack(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(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.

Method Detail

getActiveTrack

ILayer getActiveTrack(String[] activeTrackName,
                      IMap[] map)
                      throws IOException,
                             AutomationException

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

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveTrack

void setActiveTrack(String activeTrackName,
                    IMap map,
                    ILayer layer)
                    throws IOException,
                           AutomationException

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

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFollow

boolean isFollow()
                 throws IOException,
                        AutomationException

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

Product Availability

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

Returns:

The follow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFollow

void setFollow(boolean follow)
               throws IOException,
                      AutomationException

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

Product Availability

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

Parameters:

follow - The follow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFollowSymbol

ISymbol getFollowSymbol()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFollowSymbol

void setFollowSymbol(ISymbol followSymbol)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFollowThreshold

double getFollowThreshold()
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Returns:

The screenPercent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFollowThreshold

void setFollowThreshold(double screenPercent)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Parameters:

screenPercent - The screenPercent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFollowRate

double getFollowRate()
                     throws IOException,
                            AutomationException

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

Product Availability

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

Returns:

The followRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFollowRate

void setFollowRate(double followRate)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Parameters:

followRate - The followRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseFollowRate

boolean isUseFollowRate()
                        throws IOException,
                               AutomationException

Indicates whether or not to follow based on elapsed time.

Product Availability

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

Returns:

The useFollowRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseFollowRate

void setUseFollowRate(boolean useFollowRate)
                      throws IOException,
                             AutomationException

Indicates whether or not to follow based on elapsed time.

Product Availability

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

Parameters:

useFollowRate - The useFollowRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFollowPlaybackRate

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

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

Product Availability

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

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFollowPlaybackRate

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

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

Product Availability

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

Parameters:

playbackRate - The playbackRate (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFollowPoint

IPoint getFollowPoint()
                      throws IOException,
                             AutomationException

The most recent follow location.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

recenter

boolean recenter()
                 throws IOException,
                        AutomationException

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

Product Availability

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

Returns:

The wasCentered

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.