com.esri.arcgis.trackinganalyst
Interface ITimeControl

All Superinterfaces:
ITimeControlBase, java.io.Serializable
All Known Subinterfaces:
ITimeControl2
All Known Implementing Classes:
ITimeControl2Proxy, ITimeControlProxy

public interface ITimeControl
extends ITimeControlBase, java.io.Serializable

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

Description: 'Provides access to methods and properties needed to manage Playback Manager functions.' 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 IIDa2403fa8_2760_11d5_b7dd_00010265adc5
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITimeControlBase
IID5ac64f00_5c11_11d5_b7ec_00010265adc5
 
Method Summary
 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.
 java.lang.Object getCurrentTime()
          Indicates current time during playback.
 int getDefaultDateFormat()
          Indicates the default date format used in the Playback Manager.
 java.lang.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.
 java.lang.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.
 java.lang.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 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(java.lang.Object pvarCurrentTime)
          Indicates current time during playback.
 void setDefaultDateFormat(int penumDefaultDateFormat)
          Indicates the default date format used in the Playback Manager.
 void setEndTime(java.lang.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(java.lang.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(java.lang.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(java.lang.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 interface com.esri.arcgis.trackinganalyst.ITimeControlBase
setTimeSequenceInterval
 

Field Detail

IIDa2403fa8_2760_11d5_b7dd_00010265adc5

static final int IIDa2403fa8_2760_11d5_b7dd_00010265adc5
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

play

void play(int enumDir)
          throws java.io.IOException,
                 AutomationException
Starts playback of data on the map.

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

stop

void stop()
          throws java.io.IOException,
                 AutomationException
Stops playback of data on the map.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

monitor

void monitor()
             throws java.io.IOException,
                    AutomationException
Configures the temporal reference for real-time and evaluates the temporal meta data.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatus

int getStatus()
              throws java.io.IOException,
                     AutomationException
Indicates current status of playback.

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

getTimeSequenceRate

double getTimeSequenceRate()
                           throws java.io.IOException,
                                  AutomationException
Indicates rate at which temporal data is played in playback.

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

setTimeSequenceRate

void setTimeSequenceRate(double pdTimeSequenceRate)
                         throws java.io.IOException,
                                AutomationException
Indicates rate at which temporal data is played in playback.

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

getTimeSequenceInterval

double getTimeSequenceInterval(int enumUnits)
                               throws java.io.IOException,
                                      AutomationException
Indicates interval between events played on the map.

Parameters:
enumUnits - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)
Returns:
The pdTimeSequenceInterval
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException
Indicates whether or not object is visible during playback.

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

setVisible

void setVisible(int hParentWindow,
                boolean bvarVisible)
                throws java.io.IOException,
                       AutomationException
Sets object to display during playback as a visible item on the map.

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

getStartTime

java.lang.Object getStartTime()
                              throws java.io.IOException,
                                     AutomationException
Indicates start time for playback window.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartTime

void setStartTime(java.lang.Object pvarStartTime)
                  throws java.io.IOException,
                         AutomationException
Indicates start time for playback window.

Parameters:
pvarStartTime - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentTime

java.lang.Object getCurrentTime()
                                throws java.io.IOException,
                                       AutomationException
Indicates current time during playback.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentTime

void setCurrentTime(java.lang.Object pvarCurrentTime)
                    throws java.io.IOException,
                           AutomationException
Indicates current time during playback.

Parameters:
pvarCurrentTime - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndTime

java.lang.Object getEndTime()
                            throws java.io.IOException,
                                   AutomationException
Indicates end time for playback window.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndTime

void setEndTime(java.lang.Object pvarEndTime)
                throws java.io.IOException,
                       AutomationException
Indicates end time for playback window.

Parameters:
pvarEndTime - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addTemporalReference

void addTemporalReference(ITemporalReference varTemporalReference)
                          throws java.io.IOException,
                                 AutomationException
Adds playback window, which defines the temporal reference of the data during playback.

Parameters:
varTemporalReference - A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeTemporalReference

void removeTemporalReference(ITemporalReference pvarTemporalReference)
                             throws java.io.IOException,
                                    AutomationException
Removes the playback window, which defines the temporal reference of the data during playback.

Parameters:
pvarTemporalReference - A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalReferenceCount

int getTemporalReferenceCount()
                              throws java.io.IOException,
                                     AutomationException
Number of playback windows applied to the data.

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

getTemporalReference

ITemporalReference getTemporalReference(int nIndex)
                                        throws java.io.IOException,
                                               AutomationException
The value of the playback window applied to the data during playback.

Parameters:
nIndex - The nIndex (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAllTemporalReferences

void removeAllTemporalReferences()
                                 throws java.io.IOException,
                                        AutomationException
Removes all playback window boundaries from the data during playback. Playback window will be determined by the temporal extent of the data.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalReferencesFromMap

void setTemporalReferencesFromMap()
                                  throws java.io.IOException,
                                         AutomationException
Sets the playback window values for the data based on map values during playback.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeRangeFromLayers

void setTimeRangeFromLayers(java.lang.String bstrLayerName)
                            throws java.io.IOException,
                                   AutomationException
Sets playback window based on a specific layer's temporal extent.

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

getDefaultDateFormat

int getDefaultDateFormat()
                         throws java.io.IOException,
                                AutomationException
Indicates the default date format used in the Playback Manager.

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

setDefaultDateFormat

void setDefaultDateFormat(int penumDefaultDateFormat)
                          throws java.io.IOException,
                                 AutomationException
Indicates the default date format used in the Playback Manager.

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

getWindowTitle

java.lang.String getWindowTitle()
                                throws java.io.IOException,
                                       AutomationException
Text appearing in the title bar of the Playback Manager window.

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

setWindowTitle

void setWindowTitle(java.lang.String pbstrWindowTitle)
                    throws java.io.IOException,
                           AutomationException
Text appearing in the title bar of the Playback Manager window.

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

isPlayContinously

boolean isPlayContinously()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the Continuous Loop check box is activated, to replay the data repeatedly.

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

setPlayContinously

void setPlayContinously(boolean pbvarPlayContinously)
                        throws java.io.IOException,
                               AutomationException
Indicates whether the Continuous Loop check box is activated, to replay the data repeatedly.

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

getPlaySpeedFactor

double getPlaySpeedFactor()
                          throws java.io.IOException,
                                 AutomationException
Indicates the factor by which the playback rate is multiplied to speed or slow the playback of data.

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

setPlaySpeedFactor

void setPlaySpeedFactor(double pdPlaySpeedFactor)
                        throws java.io.IOException,
                               AutomationException
Indicates the factor by which the playback rate is multiplied to speed or slow the playback of data.

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

getNudgeMethod

int getNudgeMethod()
                   throws java.io.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.

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

setNudgeMethod

void setNudgeMethod(int penumMethod)
                    throws java.io.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.

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

getTemporalMode

int getTemporalMode()
                    throws java.io.IOException,
                           AutomationException
Indicates whether data is being shown in real-time or playback mode.

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

setTemporalMode

void setTemporalMode(int pVal)
                     throws java.io.IOException,
                            AutomationException
Indicates whether data is being shown in real-time or playback mode.

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

isUpdateDisplay

boolean isUpdateDisplay()
                        throws java.io.IOException,
                               AutomationException
Indicates display update information.

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

setUpdateDisplay

void setUpdateDisplay(boolean pVal)
                      throws java.io.IOException,
                             AutomationException
Indicates display update information.

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

getNumberOfSamples

short getNumberOfSamples()
                         throws java.io.IOException,
                                AutomationException
Indicates the number of samples used to draw the events on the map during playback.

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

setNumberOfSamples

void setNumberOfSamples(short pVal)
                        throws java.io.IOException,
                               AutomationException
Indicates the number of samples used to draw the events on the map during playback.

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

getHistogramFillColor

int getHistogramFillColor()
                          throws java.io.IOException,
                                 AutomationException
Indicates fill color on the Playback Manager's histogram display.

Returns:
The pVal (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHistogramFillColor

void setHistogramFillColor(int pVal)
                           throws java.io.IOException,
                                  AutomationException
Indicates fill color on the Playback Manager's histogram display.

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

getHistogramBackgroundColor

int getHistogramBackgroundColor()
                                throws java.io.IOException,
                                       AutomationException
Indicates background color on the Playback Manager's histogram display.

Returns:
The pVal (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHistogramBackgroundColor

void setHistogramBackgroundColor(int pVal)
                                 throws java.io.IOException,
                                        AutomationException
Indicates background color on the Playback Manager's histogram display.

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

getHistogramOutlineColor

int getHistogramOutlineColor()
                             throws java.io.IOException,
                                    AutomationException
Indicates outline color on the Playback Manager's histogram display.

Returns:
The pVal (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHistogramOutlineColor

void setHistogramOutlineColor(int pVal)
                              throws java.io.IOException,
                                     AutomationException
Indicates outline color on the Playback Manager's histogram display.

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

isHideHistogram

boolean isHideHistogram()
                        throws java.io.IOException,
                               AutomationException
Indicates whether the histogram is hidden from view in the Playback Manager.

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

setHideHistogram

void setHideHistogram(boolean pbvarHideHistogram)
                      throws java.io.IOException,
                             AutomationException
Indicates whether the histogram is hidden from view in the Playback Manager.

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

getCurrentMap

IMap getCurrentMap()
                   throws java.io.IOException,
                          AutomationException
Indicates value of the current map display during playback.

Returns:
A reference to a com.esri.arcgis.carto.IMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentMapByRef

void setCurrentMapByRef(IMap ppiCurrentMap)
                        throws java.io.IOException,
                               AutomationException
Indicates value of the current map display during playback.

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

getHWnd

int getHWnd()
            throws java.io.IOException,
                   AutomationException
Application handle used by the time control.

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

getTimeSequenceUnits

int getTimeSequenceUnits()
                         throws java.io.IOException,
                                AutomationException
Indicates time units used in playback.

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