com.esri.arcgis.trackinganalyst
Interface ITxFeatureClass

All Superinterfaces:
Serializable
All Known Implementing Classes:
ITxFeatureClassProxy, TemporalRecordSet

public interface ITxFeatureClass
extends Serializable

Provides access to tracking feature class.

Product Availability

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


Method Summary
 int getCachingMode()
          The feature class caching mode.
 String getEndTimeFieldName()
          The feature end time field name.
 IFeatureClass getFeatureClass()
          The internal feature class.
 String getStartTimeFieldName()
          The feature start time field name.
 String getTimeFieldAmFormat()
          Custom string representation of the AM symbol.
 String getTimeFieldFormat()
          The format used to parse time fields.
 int getTimeFieldLocaleID()
          Language identifier to be used when parsing time fields from a custom time string.
 String getTimeFieldPmFormat()
          Custom string representation of the PM symbol.
 String getTrackIDFieldName()
          The name of the field used to group features into tracks.
 void indexFeatureClass2(Object startingTime, Object endingTime, ISelectionSet selSet, IQueryFilter queryFilter)
          Re-build the temporal index and cache, according to the ITxFeatureClass properties and given parameters.
 void rebuildIndex()
          Re-build the temporal index and cache, according to the ITxFeatureClass properties.
 void setCachingMode(int cachingMode)
          The feature class caching mode.
 void setEndTimeFieldName(String name)
          The feature end time field name.
 void setFeatureClassByRef(IFeatureClass featureClass)
          The internal feature class.
 void setStartTimeFieldName(String name)
          The feature start time field name.
 void setTimeFieldAmFormat(String amFormat)
          Custom string representation of the AM symbol.
 void setTimeFieldFormat(String timeFieldFormat)
          The format used to parse time fields.
 void setTimeFieldLocaleID(int localeID)
          Language identifier to be used when parsing time fields from a custom time string.
 void setTimeFieldPmFormat(String pmFormat)
          Custom string representation of the PM symbol.
 void setTrackIDFieldName(String name)
          The name of the field used to group features into tracks.
 

Method Detail

getFeatureClass

IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException
The internal feature class.

Product Availability

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

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

setFeatureClassByRef

void setFeatureClassByRef(IFeatureClass featureClass)
                          throws IOException,
                                 AutomationException
The internal feature class.

Product Availability

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

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

getCachingMode

int getCachingMode()
                   throws IOException,
                          AutomationException
The feature class caching mode.

Product Availability

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

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

setCachingMode

void setCachingMode(int cachingMode)
                    throws IOException,
                           AutomationException
The feature class caching mode.

Product Availability

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

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

getTrackIDFieldName

String getTrackIDFieldName()
                           throws IOException,
                                  AutomationException
The name of the field used to group features into tracks.

Product Availability

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

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

setTrackIDFieldName

void setTrackIDFieldName(String name)
                         throws IOException,
                                AutomationException
The name of the field used to group features into tracks.

Product Availability

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

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

getStartTimeFieldName

String getStartTimeFieldName()
                             throws IOException,
                                    AutomationException
The feature start time field name.

Product Availability

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

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

setStartTimeFieldName

void setStartTimeFieldName(String name)
                           throws IOException,
                                  AutomationException
The feature start time field name.

Product Availability

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

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

getEndTimeFieldName

String getEndTimeFieldName()
                           throws IOException,
                                  AutomationException
The feature end time field name.

Product Availability

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

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

setEndTimeFieldName

void setEndTimeFieldName(String name)
                         throws IOException,
                                AutomationException
The feature end time field name.

Product Availability

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

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

getTimeFieldFormat

String getTimeFieldFormat()
                          throws IOException,
                                 AutomationException
The format used to parse time fields.

Product Availability

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

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

setTimeFieldFormat

void setTimeFieldFormat(String timeFieldFormat)
                        throws IOException,
                               AutomationException
The format used to parse time fields.

Product Availability

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

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

getTimeFieldAmFormat

String getTimeFieldAmFormat()
                            throws IOException,
                                   AutomationException
Custom string representation of the AM symbol.

Product Availability

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

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

setTimeFieldAmFormat

void setTimeFieldAmFormat(String amFormat)
                          throws IOException,
                                 AutomationException
Custom string representation of the AM symbol.

Product Availability

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

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

getTimeFieldPmFormat

String getTimeFieldPmFormat()
                            throws IOException,
                                   AutomationException
Custom string representation of the PM symbol.

Product Availability

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

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

setTimeFieldPmFormat

void setTimeFieldPmFormat(String pmFormat)
                          throws IOException,
                                 AutomationException
Custom string representation of the PM symbol.

Product Availability

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

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

getTimeFieldLocaleID

int getTimeFieldLocaleID()
                         throws IOException,
                                AutomationException
Language identifier to be used when parsing time fields from a custom time string.

Product Availability

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

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

setTimeFieldLocaleID

void setTimeFieldLocaleID(int localeID)
                          throws IOException,
                                 AutomationException
Language identifier to be used when parsing time fields from a custom time string.

Product Availability

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

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

indexFeatureClass2

void indexFeatureClass2(Object startingTime,
                        Object endingTime,
                        ISelectionSet selSet,
                        IQueryFilter queryFilter)
                        throws IOException,
                               AutomationException
Re-build the temporal index and cache, according to the ITxFeatureClass properties and given parameters.

Product Availability

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

Parameters:
startingTime - A Variant (in)
endingTime - A Variant (in)
selSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rebuildIndex

void rebuildIndex()
                  throws IOException,
                         AutomationException
Re-build the temporal index and cache, according to the ITxFeatureClass properties.

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.