com.esri.arcgis.trackinganalyst
Interface ITemporalSearch

All Superinterfaces:
Serializable
All Known Implementing Classes:
ITemporalSearchProxy, TemporalFeatureClass, TemporalFeatureLayer

public interface ITemporalSearch
extends Serializable

Provides access to properties and methods needed to manage searching temporal datasets.

Product Availability

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


Method Summary
 ICursor lastKnownFeatures(Object varStartingTime, Object varEndingTime)
          Searches for last known features in the dataset.
 IFeatureIDSet lastKnownOIDs(Object varStartingTime, Object varEndingTime)
          Searches for the last known OIDs in the dataset.
 void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime)
          Queries temporal data within the full temporal extent of the dataset.
 

Method Detail

lastKnownOIDs

IFeatureIDSet lastKnownOIDs(Object varStartingTime,
                            Object varEndingTime)
                            throws IOException,
                                   AutomationException
Searches for the last known OIDs in the dataset.

Description

Returns a FeatureIDSet containing the most recent OID for each track. If a start and/or end time are specified then features occuring outside of the time span are not factored into the search. Passing NULL for the start time and end time will cause all data in the temporal extent to be evaluated.

Remarks

The start and end time automation compliant date types. In C++ you can use any type that converts to a VT_DATE type, in VB a Date type, and in C# a DateTime type.

Getting the LastKnownOIDs is faster than getting the LastKnownFeatures so it is advisable to use this method where possible.

Product Availability

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

Parameters:
varStartingTime - A Variant (in)
varEndingTime - A Variant (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureIDSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lastKnownFeatures

ICursor lastKnownFeatures(Object varStartingTime,
                          Object varEndingTime)
                          throws IOException,
                                 AutomationException
Searches for last known features in the dataset.

Description

Returns an ICursor containing the most recent feature for each track. If a start and/or end time are specified then features occuring outside of the time span are not factored into the search. Passing NULL for the start time and end time will cause all data in the temporal extent to be evaluated.

Remarks

The start and end time automation compliant date types. In C++ you can use any type that converts to a VT_DATE type, in VB a Date type, and in C# a DateTime type.

Product Availability

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

Parameters:
varStartingTime - A Variant (in)
varEndingTime - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTemporalExtent

void queryTemporalExtent(Object[] pvarStartTime,
                         Object[] pvarEndTime)
                         throws IOException,
                                AutomationException
Queries temporal data within the full temporal extent of the dataset.

Description

Queries the dataset to find the dates of the oldest feature and newest feature. This time span is the temporal extent of the dataset.

Product Availability

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

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.