com.esri.arcgis.trackinganalyst
Interface ITemporalWorkspaceStatistics

All Superinterfaces:
Serializable
All Known Implementing Classes:
AMSWorkspace, AMSWorkspaceFactory, ITemporalWorkspaceStatisticsProxy

public interface ITemporalWorkspaceStatistics
extends Serializable

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

Description

This interface is new at ArcGIS 9.3.

Remarks

ITemporalWorkspaceStatistics provides a central location to obtain the statistics for all of the feature classes contained in the workspace.

Product Availability

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

See Also:
ITemporalFeatureClassStatistics

Method Summary
 IPropertySet getAllMessageRates()
          Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.
 IPropertySet getAllSampleSizes()
          Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.
 IPropertySet getAllTotalFeatureCounts()
          Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.
 IPropertySet getAllTrackCounts()
          Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.
 IPropertySet getConnectionStatus()
          Indicates the connection status of each workspace under the workspace factory
 IPropertySet getCurrentDiscardedMessageCounts()
          Indicates current number of messages discarded.
 IPropertySet getDiscardedMessageCounts()
          Indicates total number of messages discarded.
 IPropertySet getPulledMessageCounts()
          Indicates total number of messages pulled.
 IPropertySet getQueuedMessageCounts()
          Indicates total number of messages queued.
 IPropertySet getReceivedMessageCounts()
          Indicates total number of messages received.
 void resetAllFeatureCounts()
          Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.
 void resetAllMessageRates()
          Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.
 void setAllSampleSizes(int lSampleSize)
          Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.
 

Method Detail

getAllTrackCounts

IPropertySet getAllTrackCounts()
                               throws IOException,
                                      AutomationException
Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.

Description

Retrieves the track counts from all of the feature classes in the workspace. The name of each property in the PropertySet is the feature class name and the value is the output from IFeatureClassStatistics::get_TrackCount.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllTrackCounts(), ITemporalFeatureClassStatistics.getTrackCount()

getAllMessageRates

IPropertySet getAllMessageRates()
                                throws IOException,
                                       AutomationException
Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

Retrieves the message rates from all of the feature classes in the workspace. The name of each property in the PropertySet is the feature class name and the value is the output from IFeatureClassStatistics::get_MessageRate.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllSampleSizes(), ITemporalWorkspaceStatistics.setAllSampleSizes(int)

getAllSampleSizes

IPropertySet getAllSampleSizes()
                               throws IOException,
                                      AutomationException
Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

Retrieves the sample sizes from all of the feature classes in the workspace. The name of each property in the PropertySet is the feature class name and the value is the output from IFeatureClassStatistics::get_SampleSize.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllMessageRates(), ITemporalWorkspaceStatistics.setAllSampleSizes(int)

getAllTotalFeatureCounts

IPropertySet getAllTotalFeatureCounts()
                                      throws IOException,
                                             AutomationException
Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.

Description

Retrieves the total feature counts from all of the feature classes in the workspace. The name of each property in the PropertySet is the feature class name and the value is the output from IFeatureClassStatistics::get_TotalFeatureCount.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.resetAllFeatureCounts()

getConnectionStatus

IPropertySet getConnectionStatus()
                                 throws IOException,
                                        AutomationException
Indicates the connection status of each workspace under the workspace factory

Description

Returns the current state of workspace's connection to the server. The propery's name is the name of the connection and its value is an esriWorkspaceConnectionStatus.

Product Availability

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

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

getReceivedMessageCounts

IPropertySet getReceivedMessageCounts()
                                      throws IOException,
                                             AutomationException
Indicates total number of messages received.

Product Availability

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

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

getPulledMessageCounts

IPropertySet getPulledMessageCounts()
                                    throws IOException,
                                           AutomationException
Indicates total number of messages pulled.

Product Availability

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

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

getDiscardedMessageCounts

IPropertySet getDiscardedMessageCounts()
                                       throws IOException,
                                              AutomationException
Indicates total number of messages discarded.

Product Availability

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

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

getCurrentDiscardedMessageCounts

IPropertySet getCurrentDiscardedMessageCounts()
                                              throws IOException,
                                                     AutomationException
Indicates current number of messages discarded.

Product Availability

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

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

getQueuedMessageCounts

IPropertySet getQueuedMessageCounts()
                                    throws IOException,
                                           AutomationException
Indicates total number of messages queued.

Product Availability

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

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

resetAllFeatureCounts

void resetAllFeatureCounts()
                           throws IOException,
                                  AutomationException
Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.

Description

Resets the total feature counts on all of the feature classes in the workspace.

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:
ITemporalWorkspaceStatistics.getAllTotalFeatureCounts()

resetAllMessageRates

void resetAllMessageRates()
                          throws IOException,
                                 AutomationException
Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

Resets the message rates on all of the feature classes in the workspace.

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:
ITemporalWorkspaceStatistics.getAllMessageRates()

setAllSampleSizes

void setAllSampleSizes(int lSampleSize)
                       throws IOException,
                              AutomationException
Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.

Description

Sets the message rate sample size for all of the feature classes in the workspace. This method is convenient, but may result in less than optimal sampling sizes if the feature classes in the workspace are receiving data at different rates. In this case you should use ITemporalFeatureClassStatistics::put_SampleSize to fine tune individual sampling sizes.

Product Availability

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

Parameters:
lSampleSize - The lSampleSize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllMessageRates(), ITemporalWorkspaceStatistics.getAllSampleSizes(), ITemporalFeatureClassStatistics.getMessageRate()