Statistics
|
public class StatisticsReader : IDisposable
The StatisticsReader type exposes the following members.
Name | Description | |
---|---|---|
StatisticsReader | Creates a new instance of the StatisticsReader class. All parameters--ArchiveFilePath, StateFilePath, IntercomFilePath, MetadataFilePath, StartTime, and EndTime--must be set manually before attempting to read statistics from the archive. | |
StatisticsReader(String) | Creates a new instance of the StatisticsReader class. The configuration file specified in the parameter must contain the statistics historian records in order to automatically locate the archive files. Otherwise, the other constructor should be used. The StartTime and EndTime parameters are not set when using this constructor and must be set manually before attempting to read statistics from the archive. |
Name | Description | |
---|---|---|
ActualDataRate | After the StatisticsReader has read statistics from the archive file, this will contain the statistics on the actual data rate. | |
ArchiveFilePath | Path to the archive file (*_archive.d). | |
AverageLatency | After the StatisticsReader has read statistics from the archive file, this will contain the statistics on the average latency. | |
ConnectedStats | After the StatisticsReader has read statistics from the archive file, this will contain the statistics on input stream connectivity. | |
DataQualityErrors | After the StatisticsReader has read statistics from the archive file, this will contain the statistics on data quality errors. | |
EndTime | The timestamp at which to stop gathering statistics from the archive. | |
IntercomFilePath | Path to the intercom file (scratch.dat). | |
MetadataFilePath | Path to the metadata file (*_dbase.dat). | |
MissingFrames | After the StatisticsReader has read statistics from the archive file, this will contain the statistics on missing frames. | |
StartTime | The timestamp at which to start gathering statistics from the archive. | |
StateFilePath | Path to the state file (*_startup.dat). | |
TimeQualityErrors | After the StatisticsReader has read statistics from the archive file, this will contain the statistics on time quality errors. | |
TotalFrames | After the StatisticsReader has read statistics from the archive file, this will contain the statistics on the total number of frames. |
Name | Description | |
---|---|---|
Close | Closes the archive file once the statistics are no longer needed. | |
Dispose | Releases all the resources used by the StatisticsReader object. | |
Dispose(Boolean) | Releases the unmanaged resources used by the StatisticsReader object and optionally releases the managed resources. | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
GetHashCode | Serves as the default hash function. (Inherited from Object) | |
GetType | Gets the Type of the current instance. (Inherited from Object) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
Open | Causes the StatisticsReader to open the archive file and retrieve the statistics. | |
ToString | Returns a string that represents the current object. (Inherited from Object) |