C# Класс GSF.Historian.Files.ArchiveDataBlock

Represents a block of ArchiveDataPoints in an ArchiveFile.
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
Read ( ) : IEnumerable

Reads existing ArchiveDataPoints from the ArchiveDataBlock.

Reset ( ) : void

Resets the ArchiveDataBlock by overwriting existing ArchiveDataPoints with empty ArchiveDataPoints.

Write ( IDataPoint dataPoint, Exception &exception ) : bool

Writes the dataPoint to the ArchiveDataBlock.

Write ( IDataPoint dataPoint, bool suppressExceptions = false ) : bool

Writes the dataPoint to the ArchiveDataBlock.

If suppressExceptions is false, the default value, any encountered exception will be thrown on the call stack.

Защищенные методы

Метод Описание
OnDataReadException ( Exception ex ) : void

Raises the DataReadException event.

OnDataWriteException ( Exception ex ) : void

Raises the DataWriteException event.

Приватные методы

Метод Описание
ArchiveDataBlock ( ArchiveFile parent, int index, int historianID, bool preRead = true ) : System

Initializes a new instance of the ArchiveDataBlock class.

Описание методов

OnDataReadException() защищенный Метод

Raises the DataReadException event.
protected OnDataReadException ( Exception ex ) : void
ex System.Exception to send to event.
Результат void

OnDataWriteException() защищенный Метод

Raises the DataWriteException event.
protected OnDataWriteException ( Exception ex ) : void
ex System.Exception to send to event.
Результат void

Read() публичный Метод

Reads existing ArchiveDataPoints from the ArchiveDataBlock.
public Read ( ) : IEnumerable
Результат IEnumerable

Reset() публичный Метод

Resets the ArchiveDataBlock by overwriting existing ArchiveDataPoints with empty ArchiveDataPoints.
public Reset ( ) : void
Результат void

Write() публичный Метод

Writes the dataPoint to the ArchiveDataBlock.
public Write ( IDataPoint dataPoint, Exception &exception ) : bool
dataPoint IDataPoint to write.
exception System.Exception Any that may have been encountered while writing.
Результат bool

Write() публичный Метод

Writes the dataPoint to the ArchiveDataBlock.
If suppressExceptions is false, the default value, any encountered exception will be thrown on the call stack.
public Write ( IDataPoint dataPoint, bool suppressExceptions = false ) : bool
dataPoint IDataPoint to write.
suppressExceptions bool Set to true to suppress write exceptions; defaults to false.
Результат bool