com.esri.arcgis.trackinganalyst
Interface ITemporalCursor

All Superinterfaces:
IFeatureCursor, Serializable
All Known Implementing Classes:
ITemporalCursorProxy, TemporalCursor

public interface ITemporalCursor
extends IFeatureCursor, Serializable

Provides access to methods needed to control the temporal cursor.

Description

This interface exposes property and methods needed to control the temporal cursor. Using methods under this interface, users can iterate through a database in temporal order.

Product Availability

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


Method Summary
 void nextObject(IFeature[] ppiFeature, Object[] pvarTimeSeries, long[] phyTimeStamp, int[] plOID)
          Advances the position of the cursor by one and returns the feature object at that position.
 void reset()
          Resets the cursor position.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IFeatureCursor
deleteFeature, findField, flush, getFields, insertFeature, nextFeature, updateFeature
 

Method Detail

nextObject

void nextObject(IFeature[] ppiFeature,
                Object[] pvarTimeSeries,
                long[] phyTimeStamp,
                int[] plOID)
                throws IOException,
                       AutomationException
Advances the position of the cursor by one and returns the feature object at that position.

Description

Advance the position of the cursor by one and return the Feature object at that position. This routine is optimized to return the individual items that the temporal renderer will need.

Product Availability

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

Parameters:
ppiFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in/out: use single element array)
pvarTimeSeries - A Variant (in/out: use single element array)
phyTimeStamp - Signed 64-bit int (in/out: use single element array)
plOID - The plOID (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException
Resets the cursor position.

Description

This method resets the cursor to the first record that it pointed to.

Product Availability

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

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