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.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class StatisticsReader
Public Class StatisticsReader
public ref class StatisticsReader
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | 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.
|
 | 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.
|
| Close()()()() |
Closes the archive file once the statistics are no longer needed.
|
| 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.
|
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| IntercomFilePath |
Path to the intercom file (scratch.dat).
|
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| 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.
|
| Open()()()() |
Causes the StatisticsReader to open the archive file and retrieve the statistics.
|
| 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.
|
| ToString()()()() | (Inherited from Object.) |
| TotalFrames |
After the StatisticsReader has read statistics from the archive file,
this will contain the statistics on the total number of frames.
|
Inheritance Hierarchy| Object | |
 | StatisticsReader |