com.esri.arcgis.trackinganalyst
Interface ITemporalFeatureClassStatistics

All Superinterfaces:
Serializable
All Known Implementing Classes:
ITemporalFeatureClassStatisticsProxy, TemporalFeatureClass

public interface ITemporalFeatureClassStatistics
extends Serializable

Provides access to properties and methods needed to manage message rate statistics.

Description

This interface is new at ArcGIS 9.3.

Remarks

ITemporalFeatureClassStatistics provides metrics on the Temporal Feature Class for real-time data. The available metrics are message rate, total feature count, and track count. This interface can also be used to reset the counters. ITemporalWorkspaceStatistics can be used to gather all of the feature class statisics for a given workspace.

Product Availability

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

See Also:
ITemporalWorkspaceStatistics

Method Summary
 double getMessageRate()
          Indicates the TemporalFeatureClass message rate.
 int getSampleSize()
          Indicates the sample size used to calculate message rate.
 Object getTotalFeatureCount()
          Indicates the total number of features logged.
 int getTrackCount()
          Indicates the TemporalFeatureClass track count.
 void resetFeatureCount()
          Resets total feature count.
 void resetMessageRate()
          Resets message rate.
 void setSampleSize(int plSampleSize)
          Indicates the sample size used to calculate message rate.
 

Method Detail

getTrackCount

int getTrackCount()
                  throws IOException,
                         AutomationException
Indicates the TemporalFeatureClass track count.

Description

TrackCount will query the Temporal Feature Class and return the number of unique tracks it currently contains. A track is defined as all of the features in the feature class that have the same Event ID. The track count cannot be reset because it is generated from the features in the database and not a counter. If the Keep Latest Purge Rule is active or if the incoming events are distinct and do not contain an Event ID, like lightning strikes, this value should be the same as the number of rows in the feature class.

Product Availability

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

Returns:
The plTrackCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllTrackCounts()

getMessageRate

double getMessageRate()
                      throws IOException,
                             AutomationException
Indicates the TemporalFeatureClass message rate.

Description

Reports the current message rate in messages per second. This message rate uses a sliding window average to calculate the message rate in order to smooth out bursty traffic and give a more representative indication of recent performance. The size of the sliding window used is specified in by the SampleSize property. Use ResetMessageRate to clear the internal state and reset the message rate to zero.

Remarks

It is unlikely, but the message rate could generate an inconsistant result if the oldest message in your sample size used to calculate the message rate is more than 90 days old. This would require a slow feed, a large sample size, and your application to be open for over 90 straight days, so again it's very unlikely. The result of this would be a higher than actual reported message rate. This case can be corrected by using ResetMessageRate or it will correct itself if the old messages get pushed out of the sampling window by enough new message being received.

Product Availability

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

Returns:
The pdMessageRate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalFeatureClassStatistics.getSampleSize(), ITemporalFeatureClassStatistics.resetMessageRate()

getSampleSize

int getSampleSize()
                  throws IOException,
                         AutomationException
Indicates the sample size used to calculate message rate.

Description

The SampleSize determines the number of messages to use when calculating the message rate. A smaller value will give you a result that is more susceptible to variations in the data rate. This may be good if the message rate is being called often, like when using it to generate a histogram. When a larger value is used the result is closer to the average message rate of the feed.

Product Availability

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

Returns:
The plSampleSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalFeatureClassStatistics.getMessageRate()

setSampleSize

void setSampleSize(int plSampleSize)
                   throws IOException,
                          AutomationException
Indicates the sample size used to calculate message rate.

Product Availability

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

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

getTotalFeatureCount

Object getTotalFeatureCount()
                            throws IOException,
                                   AutomationException
Indicates the total number of features logged.

Description

An unsigned long integer that contains the total number of features that have been received for this feature class by Tracking Analyst since the feed was connected. The count will reset when the application is closed, ResetFeatureCount is called, or 4.2 billion features have been received (the maximum value represented by a 32-bit unsigned integer) whichever comes first.

Product Availability

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

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalFeatureClassStatistics.resetFeatureCount()

resetFeatureCount

void resetFeatureCount()
                       throws IOException,
                              AutomationException
Resets total feature count.

Description

Resets the feature count on the feature class to zero.

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.
See Also:
ITemporalFeatureClassStatistics.getTotalFeatureCount()

resetMessageRate

void resetMessageRate()
                      throws IOException,
                             AutomationException
Resets message rate.

Description

Resets the message rate to zero.

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.
See Also:
ITemporalFeatureClassStatistics.getMessageRate()