com.esri.arcgis.trackinganalyst
Class ITemporalFeatureClassStatisticsProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.ITemporalFeatureClassStatisticsProxy

All Implemented Interfaces:

ITemporalFeatureClassStatistics, Externalizable, Serializable

public class ITemporalFeatureClassStatisticsProxy
extends com.esri.arcgis.interop.Dispatch
implements ITemporalFeatureClassStatistics, Serializable

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

Description

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.

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, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ITemporalFeatureClassStatisticsProxy()
	ITemporalFeatureClassStatisticsProxy(Object obj)
protected	ITemporalFeatureClassStatisticsProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
void	resetFeatureCount() Resets total feature count.
void	resetMessageRate() Resets message rate.
void	setSampleSize(int plSampleSize) Indicates the sample size used to calculate message rate.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ITemporalFeatureClassStatisticsProxy

public ITemporalFeatureClassStatisticsProxy()

ITemporalFeatureClassStatisticsProxy

public ITemporalFeatureClassStatisticsProxy(Object obj)
                                     throws IOException

Throws:

IOException

ITemporalFeatureClassStatisticsProxy

protected ITemporalFeatureClassStatisticsProxy(Object obj,
                                               String iid)
                                        throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getTrackCount

public 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.

Specified by:

getTrackCount in interface ITemporalFeatureClassStatistics

Returns:

The plTrackCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalWorkspaceStatistics.getAllTrackCounts()

getMessageRate

public 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 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 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.

Product Availability

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

Specified by:

getMessageRate in interface ITemporalFeatureClassStatistics

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

public 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.

Remarks

The default sample size is 500.

Product Availability

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

Specified by:

getSampleSize in interface ITemporalFeatureClassStatistics

Returns:

The plSampleSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalFeatureClassStatistics.getMessageRate()

setSampleSize

public 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.

Specified by:

setSampleSize in interface ITemporalFeatureClassStatistics

Parameters:

plSampleSize - The plSampleSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalFeatureCount

public 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.

Specified by:

getTotalFeatureCount in interface ITemporalFeatureClassStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalFeatureClassStatistics.resetFeatureCount()

resetFeatureCount

public void resetFeatureCount()
                       throws IOException,
                              AutomationException

Resets total feature count.

Description

This method resets total feature count to zero.

Product Availability

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

Specified by:

resetFeatureCount in interface ITemporalFeatureClassStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalFeatureClassStatistics.getTotalFeatureCount()

resetMessageRate

public 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.

Specified by:

resetMessageRate in interface ITemporalFeatureClassStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalFeatureClassStatistics.getMessageRate()