Click or drag to resize

ArchiveReader Class

Opens a local set of historian files for reading with active archive file being monitored for roll-over.
Inheritance Hierarchy
SystemObject
  GSF.Historian.FilesArchiveReader

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.207-beta
Syntax
public class ArchiveReader : IDisposable
View Source

The ArchiveReader type exposes the following members.

Constructors
 NameDescription
Public methodArchiveReader Creates a new ArchiveReader.
Top
Properties
 NameDescription
Public propertyArchiveOffloadLocation Gets the path to the offload location used by the ArchiveFile.
Public propertyFileName Gets the name of the ArchiveFile.
Public propertyIntercomFile Gets the IntercomFile used by the ArchiveFile.
Public propertyMetadataFile Gets the MetadataFile used by the ArchiveFile.
Public propertyStateFile Gets the StateFile used by the ArchiveFile.
Public propertyStatus Gets the descriptive status of the internal ArchiveFile.
Top
Methods
 NameDescription
Public methodDispose Releases all the resources used by the ArchiveReader object.
Protected methodDispose(Boolean) Releases the unmanaged resources used by the ArchiveReader object and optionally releases the managed resources.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the ArchiveReader object is reclaimed by GC.
(Overrides ObjectFinalize)
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)
Protected methodOnDataReadException Raises the DataReadException event.
Protected methodOnHistoricFileListBuildComplete Raises the HistoricFileListBuildComplete event.
Protected methodOnHistoricFileListBuildException Raise the HistoricFileListBuildException event.
Protected methodOnHistoricFileListBuildStart Raises the HistoricFileListBuildStart event.
Protected methodOnHistoricFileListUpdated Raises the HistoricFileListUpdated event.
Protected methodOnRolloverComplete Raises the RolloverComplete event.
Protected methodOnRolloverStart Raises the RolloverStart event.
Public methodOpen Opens the ArchiveFile for use.
Public methodReadData(IEnumerableInt32, Boolean) Reads all ArchiveDataPoints from the ArchiveFile for the specified historianIDs.
Public methodReadData(Int32, Boolean) Reads all ArchiveDataPoints from the ArchiveFile for the specified historianID.
Public methodReadData(IEnumerableInt32, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, TimeTag, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, DateTime, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, String, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, TimeTag, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, DateTime, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, String, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventDataReadException Occurs when an Exception is encountered while reading IDataPoint from the current or historic ArchiveFile.
Public eventHistoricFileListBuildComplete Occurs when the process of building historic ArchiveFile list is complete.
Public eventHistoricFileListBuildException Occurs when an Exception is encountered in historic ArchiveFile list building process.
Public eventHistoricFileListBuildStart Occurs when the process of building historic ArchiveFile list is started.
Public eventHistoricFileListUpdated Occurs when the historic ArchiveFile list is updated to reflect addition or deletion of historic ArchiveFiles.
Public eventRolloverComplete Occurs when Rollover to a new ArchiveFile is complete.
Public eventRolloverStart Occurs when Rollover to a new ArchiveFile is started.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
Remarks
This class is expected to be used as an out-of-process instance of the ArchiveFile that will properly open archive files as read-only and yield to roll-over processing.
See Also