C# Class HistorianAdapters.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

Show file Open project: GridProtectionAlliance/gsf

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.
StatisticsReader ( ) : System	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 sourceConfigPath ) : System	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.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the StatisticsReader object and optionally releases the managed resources.

Private Methods

Method	Description
OpenArchiveFile ( ) : ArchiveFile

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

Dispose() protected method

Releases the unmanaged resources used by the StatisticsReader object and optionally releases the managed resources.

protected Dispose ( bool disposing ) : void
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.
return	void

Open() public method

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

public Open ( ) : void
return	void

StatisticsReader() public method

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 StatisticsReader ( ) : System
return	System

StatisticsReader() public method

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.

public StatisticsReader ( string sourceConfigPath ) : System
sourceConfigPath	string	Path to the source configuration file.
return	System