com.esri.arcgis.trackinganalyst
Class ITimeControlProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.ITimeControlBaseProxy
          com.esri.arcgis.trackinganalyst.ITimeControlProxy

All Implemented Interfaces:

ITimeControl, ITimeControlBase, Externalizable, Serializable

Direct Known Subclasses:

ITimeControl2Proxy

public class ITimeControlProxy
extends ITimeControlBaseProxy
implements ITimeControl, Serializable

Provides access to methods and properties needed to manage Playback Manager functions.

Superseded By

ITimeControl2

Description

The Time control interface is the main interface to interact with the timecontrol. This interface allows a consumer to set a time controls properties such as:

• Temporal extent
• Visibility
• Controlling Temporal References
• Play Forward
• Play Backwards
• Continuous loop
• Stop a play

The main purpose of the time control is to control TemporalReference Objects. The Timecontrol adjusts one or more temporal reference's temporal perspective property.

In this way many temporal references are synchronized.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ITimeControlProxy()
	ITimeControlProxy(Object obj)
protected	ITimeControlProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	addTemporalReference(ITemporalReference varTemporalReference) Adds playback window, which defines the temporal reference of the data during playback.
IMap	getCurrentMap() Indicates value of the current map display during playback.
Object	getCurrentTime() Indicates current time during playback.
int	getDefaultDateFormat() Indicates the default date format used in the Playback Manager.
Object	getEndTime() Indicates end time for playback window.
int	getHistogramBackgroundColor() Indicates background color on the Playback Manager's histogram display.
int	getHistogramFillColor() Indicates fill color on the Playback Manager's histogram display.
int	getHistogramOutlineColor() Indicates outline color on the Playback Manager's histogram display.
int	getHWnd() Application handle used by the time control.
int	getNudgeMethod() Indicates whether or not to nudge the playback needle forward or backward by an increment determined by the current playback rate adjusted by the speed factor.
short	getNumberOfSamples() Indicates the number of samples used to draw the events on the map during playback.
double	getPlaySpeedFactor() Indicates the factor by which the playback rate is multiplied to speed or slow the playback of data.
Object	getStartTime() Indicates start time for playback window.
int	getStatus() Indicates current status of playback.
int	getTemporalMode() Indicates whether data is being shown in real-time or playback mode.
ITemporalReference	getTemporalReference(int nIndex) The value of the playback window applied to the data during playback.
int	getTemporalReferenceCount() Number of playback windows applied to the data.
double	getTimeSequenceInterval(int enumUnits) Indicates interval between events played on the map.
double	getTimeSequenceRate() Indicates rate at which temporal data is played in playback.
int	getTimeSequenceUnits() Indicates time units used in playback.
String	getWindowTitle() Text appearing in the title bar of the Playback Manager window.
boolean	isHideHistogram() Indicates whether the histogram is hidden from view in the Playback Manager.
boolean	isPlayContinously() Indicates whether the Continuous Loop check box is activated, to replay the data repeatedly.
boolean	isUpdateDisplay() Indicates display update information.
boolean	isVisible() Indicates whether or not object is visible during playback.
void	monitor() Configures the temporal reference for real-time and evaluates the temporal meta data.
void	play(int enumDir) Starts playback of data on the map.
void	removeAllTemporalReferences() Removes all playback window boundaries from the data during playback.
void	removeListener(String iidStr, Object theListener)
void	removeTemporalReference(ITemporalReference pvarTemporalReference) Removes the playback window, which defines the temporal reference of the data during playback.
void	setCurrentMapByRef(IMap ppiCurrentMap) Indicates value of the current map display during playback.
void	setCurrentTime(Object pvarCurrentTime) Indicates current time during playback.
void	setDefaultDateFormat(int penumDefaultDateFormat) Indicates the default date format used in the Playback Manager.
void	setEndTime(Object pvarEndTime) Indicates end time for playback window.
void	setHideHistogram(boolean pbvarHideHistogram) Indicates whether the histogram is hidden from view in the Playback Manager.
void	setHistogramBackgroundColor(int pVal) Indicates background color on the Playback Manager's histogram display.
void	setHistogramFillColor(int pVal) Indicates fill color on the Playback Manager's histogram display.
void	setHistogramOutlineColor(int pVal) Indicates outline color on the Playback Manager's histogram display.
void	setNudgeMethod(int penumMethod) Indicates whether or not to nudge the playback needle forward or backward by an increment determined by the current playback rate adjusted by the speed factor.
void	setNumberOfSamples(short pVal) Indicates the number of samples used to draw the events on the map during playback.
void	setPlayContinously(boolean pbvarPlayContinously) Indicates whether the Continuous Loop check box is activated, to replay the data repeatedly.
void	setPlaySpeedFactor(double pdPlaySpeedFactor) Indicates the factor by which the playback rate is multiplied to speed or slow the playback of data.
void	setStartTime(Object pvarStartTime) Indicates start time for playback window.
void	setTemporalMode(int pVal) Indicates whether data is being shown in real-time or playback mode.
void	setTemporalReferencesFromMap() Sets the playback window values for the data based on map values during playback.
void	setTimeRangeFromLayers(String bstrLayerName) Sets playback window based on a specific layer's temporal extent.
void	setTimeSequenceRate(double pdTimeSequenceRate) Indicates rate at which temporal data is played in playback.
void	setUpdateDisplay(boolean pVal) Indicates display update information.
void	setVisible(int hParentWindow, boolean bvarVisible) Sets object to display during playback as a visible item on the map.
void	setWindowTitle(String pbstrWindowTitle) Text appearing in the title bar of the Playback Manager window.
void	stop() Stops playback of data on the map.

Methods inherited from class com.esri.arcgis.trackinganalyst.ITimeControlBaseProxy

setTimeSequenceInterval

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.esri.arcgis.trackinganalyst.ITimeControlBase

setTimeSequenceInterval

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ITimeControlProxy

public ITimeControlProxy()

ITimeControlProxy

public ITimeControlProxy(Object obj)
                  throws IOException

Throws:

IOException

ITimeControlProxy

protected ITimeControlProxy(Object obj,
                            String iid)
                     throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class ITimeControlBaseProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class ITimeControlBaseProxy

Throws:

IOException

play

public void play(int enumDir)
          throws IOException,
                 AutomationException

Starts playback of data on the map.

Description

The play method starts a play sequence. This method requires one argument, enumPlayDirection, which indicates which direction in time to sequence the time.

Product Availability

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

Specified by:

play in interface ITimeControl

Parameters:

enumDir - A com.esri.arcgis.trackinganalyst.enumDirection constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws IOException,
                 AutomationException

Stops playback of data on the map.

Description

This method simply stops a play sequence. If a play sequence is not running then this method is a no-op.

Product Availability

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

Specified by:

stop in interface ITimeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

monitor

public void monitor()
             throws IOException,
                    AutomationException

Configures the temporal reference for real-time and evaluates the temporal meta data.

Description

Reserved for future use. The monitor method configures the temporal reference for real-time and evaluates the temporal meta data.

See the enum TimeControl Status for more details.

Product Availability

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

Specified by:

monitor in interface ITimeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

public int getStatus()
              throws IOException,
                     AutomationException

Indicates current status of playback.

Description

This property indicates the current status of the time control in Playback Manager. This status could indicate that the time control is playing forward, playing in reverse, stopped, using the slider, or monitoring real-time data display.

Product Availability

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

Specified by:

getStatus in interface ITimeControl

Returns:

A com.esri.arcgis.trackinganalyst.enumTimeControlStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeSequenceRate

public double getTimeSequenceRate()
                           throws IOException,
                                  AutomationException

Indicates rate at which temporal data is played in playback.

Description

This property indicates how often, in seconds, to update the temporal reference's temporal perspective.

Product Availability

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

Specified by:

getTimeSequenceRate in interface ITimeControl

Returns:

The pdTimeSequenceRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeSequenceRate

public void setTimeSequenceRate(double pdTimeSequenceRate)
                         throws IOException,
                                AutomationException

Indicates rate at which temporal data is played in playback.

Description

This property indicates how often, in seconds, to update the temporal reference's temporal perspective.

Product Availability

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

Specified by:

setTimeSequenceRate in interface ITimeControl

Parameters:

pdTimeSequenceRate - The pdTimeSequenceRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeSequenceInterval

public double getTimeSequenceInterval(int enumUnits)
                               throws IOException,
                                      AutomationException

Indicates interval between events played on the map.

Product Availability

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

Specified by:

getTimeSequenceInterval in interface ITimeControl

Parameters:

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

Returns:

The pdTimeSequenceInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates whether or not object is visible during playback.

Description

This property controls the visibility of the Playback Manager dialog box.

This method will create a new modeless window if one does not exist or will activate and make visible a previous window.

If the visibility is set to false it will close the window.

Product Availability

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

Specified by:

isVisible in interface ITimeControl

Returns:

The pbvarVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(int hParentWindow,
                       boolean bvarVisible)
                throws IOException,
                       AutomationException

Sets object to display during playback as a visible item on the map.

Description

This property controls the visibility of the Playback Manager dialog box.

This method will create a new modeless window if one does not exist or will activate and make visible a previous window.

If the visibility is set to false it will close the window.

Product Availability

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

Specified by:

setVisible in interface ITimeControl

Parameters:

hParentWindow - The hParentWindow (in)

bvarVisible - The bvarVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTime

public Object getStartTime()
                    throws IOException,
                           AutomationException

Indicates start time for playback window.

Description

Returns the start time in a variant. This value is either a date, string, or internal format. The format is controlled by the Default Date format property.

Product Availability

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

Specified by:

getStartTime in interface ITimeControl

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTime

public void setStartTime(Object pvarStartTime)
                  throws IOException,
                         AutomationException

Indicates start time for playback window.

Description

Sets the start time in a variant. This value is either a date, string, or internal format.

Product Availability

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

Specified by:

setStartTime in interface ITimeControl

Parameters:

pvarStartTime - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentTime

public Object getCurrentTime()
                      throws IOException,
                             AutomationException

Indicates current time during playback.

Description

Returns the timecontrols current time in a variant. This value is either a date, string, or internal format. The format is controlled by the Default Date format property.

Product Availability

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

Specified by:

getCurrentTime in interface ITimeControl

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentTime

public void setCurrentTime(Object pvarCurrentTime)
                    throws IOException,
                           AutomationException

Indicates current time during playback.

Description

Sets the current time control's time in a variant. This value can be either a date, string, or internal format.

Product Availability

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

Specified by:

setCurrentTime in interface ITimeControl

Parameters:

pvarCurrentTime - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTime

public Object getEndTime()
                  throws IOException,
                         AutomationException

Indicates end time for playback window.

Description

Returns the end time in a variant. This value is either a date, string, or internal format. The format is controlled by the Default Date format property.

Product Availability

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

Specified by:

getEndTime in interface ITimeControl

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTime

public void setEndTime(Object pvarEndTime)
                throws IOException,
                       AutomationException

Indicates end time for playback window.

Description

Sets the end time in a variant. This value can be either a date, string, or internal format.

Product Availability

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

Specified by:

setEndTime in interface ITimeControl

Parameters:

pvarEndTime - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addTemporalReference

public void addTemporalReference(ITemporalReference varTemporalReference)
                          throws IOException,
                                 AutomationException

Adds playback window, which defines the temporal reference of the data during playback.

Description

This method allows a consumer to add a specified temporal reference object to control. Once Added the timecontrol will adjust the temporal references temporal perspective property. Multiple temporal references can be added in order for the time control to synchronize all referenced temporal references..

Product Availability

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

Specified by:

addTemporalReference in interface ITimeControl

Parameters:

varTemporalReference - A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTemporalReference

public void removeTemporalReference(ITemporalReference pvarTemporalReference)
                             throws IOException,
                                    AutomationException

Removes the playback window, which defines the temporal reference of the data during playback.

Description

Removes the specfied temporal reference from the time control's collection.

Product Availability

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

Specified by:

removeTemporalReference in interface ITimeControl

Parameters:

pvarTemporalReference - A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalReferenceCount

public int getTemporalReferenceCount()
                              throws IOException,
                                     AutomationException

Number of playback windows applied to the data.

Description

Returns the number of temporal references that the timecontrol is adjusting.

Product Availability

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

Specified by:

getTemporalReferenceCount in interface ITimeControl

Returns:

The plCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalReference

public ITemporalReference getTemporalReference(int nIndex)
                                        throws IOException,
                                               AutomationException

The value of the playback window applied to the data during playback.

Product Availability

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

Specified by:

getTemporalReference in interface ITimeControl

Parameters:

nIndex - The nIndex (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllTemporalReferences

public void removeAllTemporalReferences()
                                 throws IOException,
                                        AutomationException

Removes all playback window boundaries from the data during playback. Playback window will be determined by the temporal extent of the data.

Description

removes all temporal references from the timecontrols collection.

Product Availability

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

Specified by:

removeAllTemporalReferences in interface ITimeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalReferencesFromMap

public void setTemporalReferencesFromMap()
                                  throws IOException,
                                         AutomationException

Sets the playback window values for the data based on map values during playback.

Description

scans all temporal layers in the provided map and adds the temporal layers temporal references to the timecontrols collection. In most cases all temporal references from a given map have one and only one temporal reference. Duplicate instances of temporalperspective objects are not added.

Product Availability

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

Specified by:

setTemporalReferencesFromMap in interface ITimeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeRangeFromLayers

public void setTimeRangeFromLayers(String bstrLayerName)
                            throws IOException,
                                   AutomationException

Sets playback window based on a specific layer's temporal extent.

Description

This method sets the temporal extent of the timecontrol based on the specfied layer. This method requires the presence of a valided currentmap property. Additionally the following strings support alternate behavior:

• "!" = TimeControls current layer name.
• "<>" = Do not change the temporal extend just update the histogram based on the timecontrols current extent

Product Availability

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

Specified by:

setTimeRangeFromLayers in interface ITimeControl

Parameters:

bstrLayerName - The bstrLayerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultDateFormat

public int getDefaultDateFormat()
                         throws IOException,
                                AutomationException

Indicates the default date format used in the Playback Manager.

Description

The default date format that the EndTime CurrentTime, and StartTime properties return. The enumeration specifies:

• Date - Variant Date.
• String - The string representation
• Internal - An internal representation.

Product Availability

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

Specified by:

getDefaultDateFormat in interface ITimeControl

Returns:

A com.esri.arcgis.trackinganalyst.enumDefaultDateFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultDateFormat

public void setDefaultDateFormat(int penumDefaultDateFormat)
                          throws IOException,
                                 AutomationException

Indicates the default date format used in the Playback Manager.

Description

The default date format that the EndTime CurrentTime, and StartTime properties return. The enumeration specifies:

• Date - Variant Date.
• String - The string representation
• Internal - An internal representation.

Product Availability

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

Specified by:

setDefaultDateFormat in interface ITimeControl

Parameters:

penumDefaultDateFormat - A com.esri.arcgis.trackinganalyst.enumDefaultDateFormat constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWindowTitle

public String getWindowTitle()
                      throws IOException,
                             AutomationException

Text appearing in the title bar of the Playback Manager window.

Product Availability

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

Specified by:

getWindowTitle in interface ITimeControl

Returns:

The pbstrWindowTitle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWindowTitle

public void setWindowTitle(String pbstrWindowTitle)
                    throws IOException,
                           AutomationException

Text appearing in the title bar of the Playback Manager window.

Product Availability

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

Specified by:

setWindowTitle in interface ITimeControl

Parameters:

pbstrWindowTitle - The pbstrWindowTitle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlayContinously

public boolean isPlayContinously()
                          throws IOException,
                                 AutomationException

Indicates whether the Continuous Loop check box is activated, to replay the data repeatedly.

Description

The PlayContinously property indicates whether to start over at the opposite time when the end time is reached during play.

Product Availability

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

Specified by:

isPlayContinously in interface ITimeControl

Returns:

The pbvarPlayContinously

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlayContinously

public void setPlayContinously(boolean pbvarPlayContinously)
                        throws IOException,
                               AutomationException

Indicates whether the Continuous Loop check box is activated, to replay the data repeatedly.

Description

The PlayContinously property indicates whether to start over at the opposite time when the end time is reached during play.

Product Availability

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

Specified by:

setPlayContinously in interface ITimeControl

Parameters:

pbvarPlayContinously - The pbvarPlayContinously (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlaySpeedFactor

public double getPlaySpeedFactor()
                          throws IOException,
                                 AutomationException

Indicates the factor by which the playback rate is multiplied to speed or slow the playback of data.

Product Availability

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

Specified by:

getPlaySpeedFactor in interface ITimeControl

Returns:

The pdPlaySpeedFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlaySpeedFactor

public void setPlaySpeedFactor(double pdPlaySpeedFactor)
                        throws IOException,
                               AutomationException

Indicates the factor by which the playback rate is multiplied to speed or slow the playback of data.

Product Availability

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

Specified by:

setPlaySpeedFactor in interface ITimeControl

Parameters:

pdPlaySpeedFactor - The pdPlaySpeedFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNudgeMethod

public int getNudgeMethod()
                   throws IOException,
                          AutomationException

Indicates whether or not to nudge the playback needle forward or backward by an increment determined by the current playback rate adjusted by the speed factor.

Product Availability

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

Specified by:

getNudgeMethod in interface ITimeControl

Returns:

A com.esri.arcgis.trackinganalyst.enumPlaybackNudgeMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNudgeMethod

public void setNudgeMethod(int penumMethod)
                    throws IOException,
                           AutomationException

Indicates whether or not to nudge the playback needle forward or backward by an increment determined by the current playback rate adjusted by the speed factor.

Product Availability

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

Specified by:

setNudgeMethod in interface ITimeControl

Parameters:

penumMethod - A com.esri.arcgis.trackinganalyst.enumPlaybackNudgeMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalMode

public int getTemporalMode()
                    throws IOException,
                           AutomationException

Indicates whether data is being shown in real-time or playback mode.

Product Availability

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

Specified by:

getTemporalMode in interface ITimeControl

Returns:

A com.esri.arcgis.trackinganalyst.enumPlaybackTemporalMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalMode

public void setTemporalMode(int pVal)
                     throws IOException,
                            AutomationException

Indicates whether data is being shown in real-time or playback mode.

Product Availability

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

Specified by:

setTemporalMode in interface ITimeControl

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpdateDisplay

public boolean isUpdateDisplay()
                        throws IOException,
                               AutomationException

Indicates display update information.

Product Availability

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

Specified by:

isUpdateDisplay in interface ITimeControl

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateDisplay

public void setUpdateDisplay(boolean pVal)
                      throws IOException,
                             AutomationException

Indicates display update information.

Product Availability

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

Specified by:

setUpdateDisplay in interface ITimeControl

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberOfSamples

public short getNumberOfSamples()
                         throws IOException,
                                AutomationException

Indicates the number of samples used to draw the events on the map during playback.

Product Availability

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

Specified by:

getNumberOfSamples in interface ITimeControl

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberOfSamples

public void setNumberOfSamples(short pVal)
                        throws IOException,
                               AutomationException

Indicates the number of samples used to draw the events on the map during playback.

Product Availability

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

Specified by:

setNumberOfSamples in interface ITimeControl

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHistogramFillColor

public int getHistogramFillColor()
                          throws IOException,
                                 AutomationException

Indicates fill color on the Playback Manager's histogram display.

Product Availability

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

Specified by:

getHistogramFillColor in interface ITimeControl

Returns:

The pVal (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHistogramFillColor

public void setHistogramFillColor(int pVal)
                           throws IOException,
                                  AutomationException

Indicates fill color on the Playback Manager's histogram display.

Product Availability

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

Specified by:

setHistogramFillColor in interface ITimeControl

Parameters:

pVal - The pVal (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHistogramBackgroundColor

public int getHistogramBackgroundColor()
                                throws IOException,
                                       AutomationException

Indicates background color on the Playback Manager's histogram display.

Product Availability

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

Specified by:

getHistogramBackgroundColor in interface ITimeControl

Returns:

The pVal (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHistogramBackgroundColor

public void setHistogramBackgroundColor(int pVal)
                                 throws IOException,
                                        AutomationException

Indicates background color on the Playback Manager's histogram display.

Product Availability

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

Specified by:

setHistogramBackgroundColor in interface ITimeControl

Parameters:

pVal - The pVal (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHistogramOutlineColor

public int getHistogramOutlineColor()
                             throws IOException,
                                    AutomationException

Indicates outline color on the Playback Manager's histogram display.

Product Availability

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

Specified by:

getHistogramOutlineColor in interface ITimeControl

Returns:

The pVal (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHistogramOutlineColor

public void setHistogramOutlineColor(int pVal)
                              throws IOException,
                                     AutomationException

Indicates outline color on the Playback Manager's histogram display.

Product Availability

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

Specified by:

setHistogramOutlineColor in interface ITimeControl

Parameters:

pVal - The pVal (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideHistogram

public boolean isHideHistogram()
                        throws IOException,
                               AutomationException

Indicates whether the histogram is hidden from view in the Playback Manager.

Product Availability

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

Specified by:

isHideHistogram in interface ITimeControl

Returns:

The pbvarHideHistogram

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideHistogram

public void setHideHistogram(boolean pbvarHideHistogram)
                      throws IOException,
                             AutomationException

Indicates whether the histogram is hidden from view in the Playback Manager.

Product Availability

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

Specified by:

setHideHistogram in interface ITimeControl

Parameters:

pbvarHideHistogram - The pbvarHideHistogram (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentMap

public IMap getCurrentMap()
                   throws IOException,
                          AutomationException

Indicates value of the current map display during playback.

Description

The CurrentMap property indicates the current map that methods such as setTimeRangeFromLayers requires. In general this is the current map that is being controled temporally.

Product Availability

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

Specified by:

getCurrentMap in interface ITimeControl

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentMapByRef

public void setCurrentMapByRef(IMap ppiCurrentMap)
                        throws IOException,
                               AutomationException

Indicates value of the current map display during playback.

Description

The CurrentMap property indicates the current map that methods such as setTimeRangeFromLayers requires. In general this is the current map that is being controled temporally.

Product Availability

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

Specified by:

setCurrentMapByRef in interface ITimeControl

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

Application handle used by the time control.

Product Availability

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

Specified by:

getHWnd in interface ITimeControl

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeSequenceUnits

public int getTimeSequenceUnits()
                         throws IOException,
                                AutomationException

Indicates time units used in playback.

Product Availability

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

Specified by:

getTimeSequenceUnits in interface ITimeControl

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.