com.esri.arcgis.trackinganalyst
Class ITemporalLayerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.ITemporalLayerProxy

All Implemented Interfaces:

ITemporalLayer, Externalizable, Serializable

public class ITemporalLayerProxy
extends com.esri.arcgis.interop.Dispatch
implements ITemporalLayer, Serializable

Provides access to properties and methods needed to manage temporal layer functionality.

Description

The temporal layer interface controls property content that enables a layer to be rendered or exploited temporally. This interface provides properties and methods to control how the events are displayed (e.g. displaying future events, last known events), whether and how to cache features, and temporal and spatial attributes. This interface also provides property and methods to access action collection and process actions.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
IActionCollection	getActionCollection() The collection of action objects for this temporal layer.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
String	getEventIDFieldName() Indicates the field containing the EventID information for the data.
int	getFeatureCacheWindow() Determines the number of features to cache if the CacheFeatures property is true.
double	getMaximumScale() Maximum scale (representative fraction) at which the layer will display.
double	getMinimumScale() Minimum scale (representative fraction) at which the layer will display.
String	getName() Layer name.
int	getRelativeTimeColor() Indicates a relative color differential based on temporal class characteristics.
ITemporalOperator	getRelativeTimeOperator() The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.
IFeatureRenderer	getRenderer() Controls the temporal renderer for the layer.
int	getSupportedDrawPhases() Supported draw phases.
String	getTemporalFieldName() Identifies the temporal field, which must be a field type with data that can be converted to a date value.
ITemporalLegendGroup	getTemporalLegendGroup() Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.
ITemporalReference	getTemporalReference() Defines the reference in time used to draw, identify, or perform other layer-based activities.
String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isCacheFeatures() Controls whether Features are cached in the renderer's feature memory or are read from the feature class.
boolean	isDisplayFutureEvents() Indicates whether or not to display future events for a real-time data layer.
boolean	isDisplayOnlyLastKnownEvent() Indicates whether to display only the last known temporal event or all events in a layer.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
void	processActions(boolean bvarResetActions) Apply the actions, contained in the action collection, to this temporal layer.
void	queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime) Obtain the start and end temporal values of the temporal layer's features.
void	removeListener(String iidStr, Object theListener)
void	setActionCollectionByRef(IActionCollection pVal) The collection of action objects for this temporal layer.
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setCacheFeatures(boolean pbAreFeaturesCached) Controls whether Features are cached in the renderer's feature memory or are read from the feature class.
void	setDisplayFutureEvents(boolean pbvarFutureEvents) Indicates whether or not to display future events for a real-time data layer.
void	setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent) Indicates whether to display only the last known temporal event or all events in a layer.
void	setFeatureCacheWindow(int pnPercent) Determines the number of features to cache if the CacheFeatures property is true.
void	setMaximumScale(double maxScale) Maximum scale (representative fraction) at which the layer will display.
void	setMinimumScale(double minScale) Minimum scale (representative fraction) at which the layer will display.
void	setName(String name) Layer name.
void	setRelativeTimeColor(int pVal) Indicates a relative color differential based on temporal class characteristics.
void	setRelativeTimeOperator(ITemporalOperator pVal) The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.
void	setRendererByRef(IFeatureRenderer renderer) Controls the temporal renderer for the layer.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup) Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.
void	setTemporalReferenceByRef(ITemporalReference ppiTemporalReference) Defines the reference in time used to draw, identify, or perform other layer-based activities.
void	setVisible(boolean visible) Indicates if the layer is currently visible.
void	suspendIndexing(boolean bvarSuspend) This method suspends or resumes indexing on a temporal layer.

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ITemporalLayerProxy

public ITemporalLayerProxy()

ITemporalLayerProxy

public ITemporalLayerProxy(Object obj)
                    throws IOException

Throws:

IOException

ITemporalLayerProxy

protected ITemporalLayerProxy(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 com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

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

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getName

public String getName()
               throws IOException,
                      AutomationException

Layer name.

Product Availability

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

Specified by:

getName in interface ITemporalLayer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Layer name.

Product Availability

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

Specified by:

setName in interface ITemporalLayer

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the layer is currently valid.

Product Availability

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

Specified by:

isValid in interface ITemporalLayer

Returns:

The valid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The default area of interest for the layer.

Product Availability

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

Specified by:

getAreaOfInterest in interface ITemporalLayer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException

Minimum scale (representative fraction) at which the layer will display.

Product Availability

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

Specified by:

getMinimumScale in interface ITemporalLayer

Returns:

The minScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Product Availability

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

Specified by:

setMinimumScale in interface ITemporalLayer

Parameters:

minScale - The minScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException

Maximum scale (representative fraction) at which the layer will display.

Product Availability

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

Specified by:

getMaximumScale in interface ITemporalLayer

Returns:

The maxScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Product Availability

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

Specified by:

setMaximumScale in interface ITemporalLayer

Parameters:

maxScale - The maxScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the layer is currently visible.

Product Availability

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

Specified by:

isVisible in interface ITemporalLayer

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the layer is currently visible.

Product Availability

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

Specified by:

setVisible in interface ITemporalLayer

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws IOException,
                          AutomationException

Indicates if the layer shows map tips.

Product Availability

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

Specified by:

isShowTips in interface ITemporalLayer

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws IOException,
                        AutomationException

Indicates if the layer shows map tips.

Product Availability

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

Specified by:

setShowTips in interface ITemporalLayer

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipText

public String getTipText(double x,
                         double y,
                         double tolerance)
                  throws IOException,
                         AutomationException

Map tip text at the specified location.

Product Availability

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

Specified by:

getTipText in interface ITemporalLayer

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Remarks

Temporal layers are always cached. Therefore this property is not re-configurable.

Product Availability

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

Specified by:

isCached in interface ITemporalLayer

Returns:

The cached

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Product Availability

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

Specified by:

setCached in interface ITemporalLayer

Parameters:

cached - The cached (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws IOException,
                                  AutomationException

Supported draw phases.

Product Availability

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

Specified by:

getSupportedDrawPhases in interface ITemporalLayer

Returns:

The drawPhases

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException

Spatial reference for the layer.

Product Availability

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

Specified by:

setSpatialReferenceByRef in interface ITemporalLayer

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

Product Availability

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

Specified by:

draw in interface ITemporalLayer

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalReference

public ITemporalReference getTemporalReference()
                                        throws IOException,
                                               AutomationException

Defines the reference in time used to draw, identify, or perform other layer-based activities.

Description

The Temporal Reference Property is a Temporal Reference Object that defines the reference in time that is used to draw, identify, or perform other layer activities on this layer.

Product Availability

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

Specified by:

getTemporalReference in interface ITemporalLayer

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.

setTemporalReferenceByRef

public void setTemporalReferenceByRef(ITemporalReference ppiTemporalReference)
                               throws IOException,
                                      AutomationException

Defines the reference in time used to draw, identify, or perform other layer-based activities.

Description

The Temporal Reference Property is a Temporal Reference Object that defines the reference in time that is used to draw, identify, or perform other layer activities on this layer.

Product Availability

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

Specified by:

setTemporalReferenceByRef in interface ITemporalLayer

Parameters:

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

getTemporalLegendGroup

public ITemporalLegendGroup getTemporalLegendGroup()
                                            throws IOException,
                                                   AutomationException

Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.

Description

This property is a group of temporal legend classes that define the temporal intervals and symbology that the temporal renderer uses. This legend group collectively defines the temporal period that is used to draw features.

Product Availability

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

Specified by:

getTemporalLegendGroup in interface ITemporalLayer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalLegendGroupByRef

public void setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup)
                                 throws IOException,
                                        AutomationException

Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.

Description

This property is a group of temporal legend classes that define the temporal intervals and symbology that the temporal renderer uses. This legend group collectively defines the temporal period that is used to draw features.

Product Availability

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

Specified by:

setTemporalLegendGroupByRef in interface ITemporalLayer

Parameters:

ppiTemporalLegendGroup - A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheFeatures

public void setCacheFeatures(boolean pbAreFeaturesCached)
                      throws IOException,
                             AutomationException

Controls whether Features are cached in the renderer's feature memory or are read from the feature class.

Description

This property controls whether features are cached in the renderer's feature memory or are read from the feature class.

Product Availability

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

Specified by:

setCacheFeatures in interface ITemporalLayer

Parameters:

pbAreFeaturesCached - The pbAreFeaturesCached (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheFeatures

public boolean isCacheFeatures()
                        throws IOException,
                               AutomationException

Controls whether Features are cached in the renderer's feature memory or are read from the feature class.

Description

This property controls whether features are cached in the renderer's feature memory or are read from the feature class.

Product Availability

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

Specified by:

isCacheFeatures in interface ITemporalLayer

Returns:

The pbAreFeaturesCached

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureCacheWindow

public int getFeatureCacheWindow()
                          throws IOException,
                                 AutomationException

Determines the number of features to cache if the CacheFeatures property is true.

Description

Reserved for future use.

Product Availability

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

Specified by:

getFeatureCacheWindow in interface ITemporalLayer

Returns:

The pnPercent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureCacheWindow

public void setFeatureCacheWindow(int pnPercent)
                           throws IOException,
                                  AutomationException

Determines the number of features to cache if the CacheFeatures property is true.

Description

Reserved for future use

Product Availability

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

Specified by:

setFeatureCacheWindow in interface ITemporalLayer

Parameters:

pnPercent - The pnPercent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(IFeatureRenderer renderer)
                      throws IOException,
                             AutomationException

Controls the temporal renderer for the layer.

Product Availability

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

Specified by:

setRendererByRef in interface ITemporalLayer

Parameters:

renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

public IFeatureRenderer getRenderer()
                             throws IOException,
                                    AutomationException

Controls the temporal renderer for the layer.

Product Availability

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

Specified by:

getRenderer in interface ITemporalLayer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalFieldName

public String getTemporalFieldName()
                            throws IOException,
                                   AutomationException

Identifies the temporal field, which must be a field type with data that can be converted to a date value.

Product Availability

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

Specified by:

getTemporalFieldName in interface ITemporalLayer

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayOnlyLastKnownEvent

public boolean isDisplayOnlyLastKnownEvent()
                                    throws IOException,
                                           AutomationException

Indicates whether to display only the last known temporal event or all events in a layer.

Product Availability

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

Specified by:

isDisplayOnlyLastKnownEvent in interface ITemporalLayer

Returns:

The pbvarLastKnownEvent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayOnlyLastKnownEvent

public void setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent)
                                  throws IOException,
                                         AutomationException

Indicates whether to display only the last known temporal event or all events in a layer.

Product Availability

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

Specified by:

setDisplayOnlyLastKnownEvent in interface ITemporalLayer

Parameters:

pbvarLastKnownEvent - The pbvarLastKnownEvent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayFutureEvents

public boolean isDisplayFutureEvents()
                              throws IOException,
                                     AutomationException

Indicates whether or not to display future events for a real-time data layer.

Product Availability

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

Specified by:

isDisplayFutureEvents in interface ITemporalLayer

Returns:

The pbvarFutureEvents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayFutureEvents

public void setDisplayFutureEvents(boolean pbvarFutureEvents)
                            throws IOException,
                                   AutomationException

Indicates whether or not to display future events for a real-time data layer.

Product Availability

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

Specified by:

setDisplayFutureEvents in interface ITemporalLayer

Parameters:

pbvarFutureEvents - The pbvarFutureEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActionCollection

public IActionCollection getActionCollection()
                                      throws IOException,
                                             AutomationException

The collection of action objects for this temporal layer.

Product Availability

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

Specified by:

getActionCollection in interface ITemporalLayer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionCollectionByRef

public void setActionCollectionByRef(IActionCollection pVal)
                              throws IOException,
                                     AutomationException

The collection of action objects for this temporal layer.

Product Availability

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

Specified by:

setActionCollectionByRef in interface ITemporalLayer

Parameters:

pVal - A reference to a com.esri.arcgis.carto.IActionCollection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

processActions

public void processActions(boolean bvarResetActions)
                    throws IOException,
                           AutomationException

Apply the actions, contained in the action collection, to this temporal layer.

Remarks

If bvarResetActions is true, actions collection will be reset to the default state.

Product Availability

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

Specified by:

processActions in interface ITemporalLayer

Parameters:

bvarResetActions - The bvarResetActions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelativeTimeColor

public int getRelativeTimeColor()
                         throws IOException,
                                AutomationException

Indicates a relative color differential based on temporal class characteristics.

Product Availability

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

Specified by:

getRelativeTimeColor in interface ITemporalLayer

Returns:

The pVal (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativeTimeColor

public void setRelativeTimeColor(int pVal)
                          throws IOException,
                                 AutomationException

Indicates a relative color differential based on temporal class characteristics.

Product Availability

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

Specified by:

setRelativeTimeColor in interface ITemporalLayer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelativeTimeOperator

public ITemporalOperator getRelativeTimeOperator()
                                          throws IOException,
                                                 AutomationException

The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.

Description

This property indicates the relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer. The temporal offset can be an interval.

Product Availability

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

Specified by:

getRelativeTimeOperator in interface ITemporalLayer

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativeTimeOperator

public void setRelativeTimeOperator(ITemporalOperator pVal)
                             throws IOException,
                                    AutomationException

The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.

Product Availability

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

Specified by:

setRelativeTimeOperator in interface ITemporalLayer

Parameters:

pVal - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTemporalExtent

public void queryTemporalExtent(Object[] pvarStartTime,
                                Object[] pvarEndTime)
                         throws IOException,
                                AutomationException

Obtain the start and end temporal values of the temporal layer's features.

Product Availability

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

Specified by:

queryTemporalExtent in interface ITemporalLayer

Parameters:

pvarStartTime - A Variant (in/out: use single element array)

pvarEndTime - A Variant (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventIDFieldName

public String getEventIDFieldName()
                           throws IOException,
                                  AutomationException

Indicates the field containing the EventID information for the data.

Product Availability

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

Specified by:

getEventIDFieldName in interface ITemporalLayer

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

suspendIndexing

public void suspendIndexing(boolean bvarSuspend)
                     throws IOException,
                            AutomationException

This method suspends or resumes indexing on a temporal layer.

Product Availability

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

Specified by:

suspendIndexing in interface ITemporalLayer

Parameters:

bvarSuspend - The bvarSuspend (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.