Click or drag to resize
Grid Solutions Framework

StatisticsReader Class

Reads certain device and input stream statistics from the statistics archive. The statistics that are read are the total frame count, the missing frame count, connectivity, average latency, the actual data rate, data quality errors, and time quality errors.
Inheritance Hierarchy
SystemObject
  HistorianAdaptersStatisticsReader

Namespace: HistorianAdapters
Assembly: HistorianAdapters (in HistorianAdapters.dll) Version: 2.4.181-beta
Syntax
public class StatisticsReader : IDisposable
View Source

The StatisticsReader type exposes the following members.

Constructors
 NameDescription
Public methodStatisticsReader 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.
Public methodStatisticsReader(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.
Top
Properties
 NameDescription
Public propertyActualDataRate After the StatisticsReader has read statistics from the archive file, this will contain the statistics on the actual data rate.
Public propertyArchiveFilePath Path to the archive file (*_archive.d).
Public propertyAverageLatency After the StatisticsReader has read statistics from the archive file, this will contain the statistics on the average latency.
Public propertyConnectedStats After the StatisticsReader has read statistics from the archive file, this will contain the statistics on input stream connectivity.
Public propertyDataQualityErrors After the StatisticsReader has read statistics from the archive file, this will contain the statistics on data quality errors.
Public propertyEndTime The timestamp at which to stop gathering statistics from the archive.
Public propertyIntercomFilePath Path to the intercom file (scratch.dat).
Public propertyMetadataFilePath Path to the metadata file (*_dbase.dat).
Public propertyMissingFrames After the StatisticsReader has read statistics from the archive file, this will contain the statistics on missing frames.
Public propertyStartTime The timestamp at which to start gathering statistics from the archive.
Public propertyStateFilePath Path to the state file (*_startup.dat).
Public propertyTimeQualityErrors After the StatisticsReader has read statistics from the archive file, this will contain the statistics on time quality errors.
Public propertyTotalFrames After the StatisticsReader has read statistics from the archive file, this will contain the statistics on the total number of frames.
Top
Methods
 NameDescription
Public methodClose Closes the archive file once the statistics are no longer needed.
Public methodDispose Releases all the resources used by the StatisticsReader object.
Protected methodDispose(Boolean) Releases the unmanaged resources used by the StatisticsReader object and optionally releases the managed resources.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodOpen Causes the StatisticsReader to open the archive file and retrieve the statistics.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also