C# Class PDQTrackerManager.StatisticsReader

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: IDisposable

Exibir arquivo Open project: GridProtectionAlliance/pdqtracker Class Usage Examples

Public Methods

Method	Description
Close ( ) : void	Closes the archive file once the statistics are no longer needed.
Dispose ( ) : void	Releases all the resources used by the StatisticsReader object.
Open ( ) : void	Causes the StatisticsReader to open the archive file and retrieve the statistics.
Read ( int severity ) : IEnumerable>.Dictionary	Reads data for a specified signal. All parameters--ArchiveFilePath, StartTime, and EndTime--must be set manually before attempting to read statistics from the archive.
Read ( string statisticSuffix, int signalIndex ) : IEnumerable>.Dictionary	Reads data for a specified statistic. All parameters--ArchiveFilePath, StartTime, and EndTime--must be set manually before attempting to read statistics from the archive.

Method Details

Close() public method

Closes the archive file once the statistics are no longer needed.

public Close ( ) : void
return	void

Dispose() public method

Releases all the resources used by the StatisticsReader object.

public Dispose ( ) : void
return	void

Open() public method

Causes the StatisticsReader to open the archive file and retrieve the statistics.

public Open ( ) : void
return	void

Read() public method

Reads data for a specified signal.

All parameters--ArchiveFilePath, StartTime, and EndTime--must be set manually before attempting to read statistics from the archive.

public Read ( int severity ) : IEnumerable>.Dictionary
severity	int	The index that defines which statistic in the given category is to be retrieved.
return	IEnumerable>.Dictionary

Read() public method

Reads data for a specified statistic.

All parameters--ArchiveFilePath, StartTime, and EndTime--must be set manually before attempting to read statistics from the archive.

public Read ( string statisticSuffix, int signalIndex ) : IEnumerable>.Dictionary
statisticSuffix	string	The suffix that defines the category of the statistic.
signalIndex	int	The index that defines which statistic in the given category is to be retrieved.
return	IEnumerable>.Dictionary