|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITimeControl
Provides access to methods and properties needed to manage Playback Manager functions.
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:
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.
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. |
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 |
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 interface com.esri.arcgis.trackinganalyst.ITimeControlBase |
---|
setTimeSequenceInterval |
Method Detail |
---|
void play(int enumDir) throws IOException, AutomationException
The play method starts a play sequence. This method requires one argument, enumPlayDirection, which indicates which direction in time to sequence the time.
enumDir
- A com.esri.arcgis.trackinganalyst.enumDirection constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void stop() throws IOException, AutomationException
This method simply stops a play sequence. If a play sequence is not running then this method is a no-op.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void monitor() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getStatus() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getTimeSequenceRate() throws IOException, AutomationException
This property indicates how often, in seconds, to update the temporal reference's temporal perspective.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTimeSequenceRate(double pdTimeSequenceRate) throws IOException, AutomationException
This property indicates how often, in seconds, to update the temporal reference's temporal perspective.
pdTimeSequenceRate
- The pdTimeSequenceRate (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getTimeSequenceInterval(int enumUnits) throws IOException, AutomationException
enumUnits
- A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isVisible() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setVisible(int hParentWindow, boolean bvarVisible) throws IOException, AutomationException
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.
hParentWindow
- The hParentWindow (in)bvarVisible
- The bvarVisible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.Object getStartTime() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setStartTime(Object pvarStartTime) throws IOException, AutomationException
Sets the start time in a variant. This value is either a date, string, or internal format.
pvarStartTime
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.Object getCurrentTime() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCurrentTime(Object pvarCurrentTime) throws IOException, AutomationException
Sets the current time control's time in a variant. This value can be either a date, string, or internal format.
pvarCurrentTime
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.Object getEndTime() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEndTime(Object pvarEndTime) throws IOException, AutomationException
Sets the end time in a variant. This value can be either a date, string, or internal format.
pvarEndTime
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addTemporalReference(ITemporalReference varTemporalReference) throws IOException, AutomationException
varTemporalReference
- A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void removeTemporalReference(ITemporalReference pvarTemporalReference) throws IOException, AutomationException
Removes the specfied temporal reference from the time control's collection.
pvarTemporalReference
- A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getTemporalReferenceCount() throws IOException, AutomationException
Returns the number of temporal references that the timecontrol is adjusting.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ITemporalReference getTemporalReference(int nIndex) throws IOException, AutomationException
nIndex
- The nIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void removeAllTemporalReferences() throws IOException, AutomationException
removes all temporal references from the timecontrols collection.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTemporalReferencesFromMap() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTimeRangeFromLayers(String bstrLayerName) throws IOException, AutomationException
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:
bstrLayerName
- The bstrLayerName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getDefaultDateFormat() throws IOException, AutomationException
The default date format that the EndTime CurrentTime, and StartTime properties return. The enumeration specifies:
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDefaultDateFormat(int penumDefaultDateFormat) throws IOException, AutomationException
The default date format that the EndTime CurrentTime, and StartTime properties return. The enumeration specifies:
penumDefaultDateFormat
- A com.esri.arcgis.trackinganalyst.enumDefaultDateFormat constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getWindowTitle() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setWindowTitle(String pbstrWindowTitle) throws IOException, AutomationException
pbstrWindowTitle
- The pbstrWindowTitle (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isPlayContinously() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setPlayContinously(boolean pbvarPlayContinously) throws IOException, AutomationException
The PlayContinously property indicates whether to start over at the opposite time when the end time is reached during play.
pbvarPlayContinously
- The pbvarPlayContinously (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getPlaySpeedFactor() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setPlaySpeedFactor(double pdPlaySpeedFactor) throws IOException, AutomationException
pdPlaySpeedFactor
- The pdPlaySpeedFactor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getNudgeMethod() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setNudgeMethod(int penumMethod) throws IOException, AutomationException
penumMethod
- A com.esri.arcgis.trackinganalyst.enumPlaybackNudgeMethod constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getTemporalMode() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTemporalMode(int pVal) throws IOException, AutomationException
pVal
- A com.esri.arcgis.trackinganalyst.enumPlaybackTemporalMode constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isUpdateDisplay() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setUpdateDisplay(boolean pVal) throws IOException, AutomationException
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.short getNumberOfSamples() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setNumberOfSamples(short pVal) throws IOException, AutomationException
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getHistogramFillColor() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHistogramFillColor(int pVal) throws IOException, AutomationException
pVal
- The pVal (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getHistogramBackgroundColor() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHistogramBackgroundColor(int pVal) throws IOException, AutomationException
pVal
- The pVal (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getHistogramOutlineColor() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHistogramOutlineColor(int pVal) throws IOException, AutomationException
pVal
- The pVal (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isHideHistogram() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHideHistogram(boolean pbvarHideHistogram) throws IOException, AutomationException
pbvarHideHistogram
- The pbvarHideHistogram (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IMap getCurrentMap() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCurrentMapByRef(IMap ppiCurrentMap) throws IOException, AutomationException
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.
ppiCurrentMap
- A reference to a com.esri.arcgis.carto.IMap (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getHWnd() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getTimeSequenceUnits() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |