|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ITemporalFeatureClassStatistics
Provides access to properties and methods needed to manage message rate statistics.
This interface provides properties to indicate track count, message rate, sample size, total number of messages received in a temporal feature class. This interface also provides methods to reset total feature count and message rate.
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.
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 |
|---|
int getTrackCount()
throws IOException,
AutomationException
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.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ITemporalWorkspaceStatistics.getAllTrackCounts()
double getMessageRate()
throws IOException,
AutomationException
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 by the SampleSize property. Use ResetMessageRate to clear the internal state and reset the message rate to zero.
It is unlikely, but the message rate could generate an inconsistent 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 and it will correct itself if the old messages get pushed out of the sampling window by enough new messages being received.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ITemporalFeatureClassStatistics.getSampleSize(),
ITemporalFeatureClassStatistics.resetMessageRate()
int getSampleSize()
throws IOException,
AutomationException
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.
The default sample size is 500.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ITemporalFeatureClassStatistics.getMessageRate()
void setSampleSize(int plSampleSize)
throws IOException,
AutomationException
plSampleSize - The plSampleSize (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Object getTotalFeatureCount()
throws IOException,
AutomationException
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.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ITemporalFeatureClassStatistics.resetFeatureCount()
void resetFeatureCount()
throws IOException,
AutomationException
This method resets total feature count to zero.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ITemporalFeatureClassStatistics.getTotalFeatureCount()
void resetMessageRate()
throws IOException,
AutomationException
Resets the message rate to zero.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ITemporalFeatureClassStatistics.getMessageRate()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||