|
ArchiveReader Class
|
Opens a local set of historian files for reading with active archive file being monitored for roll-over.
Inheritance Hierarchy
Namespace: GSF.Historian.FilesAssembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.207-beta
Syntax GSF.Historian.Files.ArchiveReader = function();
Type.createClass(
'GSF.Historian.Files.ArchiveReader',
null,
IDisposable);
View SourceThe ArchiveReader type exposes the following members.
Constructors Properties Methods | Name | Description |
---|
| Dispose |
Releases all the resources used by the ArchiveReader object.
|
| Dispose(Boolean) |
Releases the unmanaged resources used by the ArchiveReader object and optionally releases the managed resources.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the ArchiveReader object is reclaimed by GC.
(Overrides ObjectFinalize) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnDataReadException |
Raises the DataReadException event.
|
| OnHistoricFileListBuildComplete |
Raises the HistoricFileListBuildComplete event.
|
| OnHistoricFileListBuildException |
Raise the HistoricFileListBuildException event.
|
| OnHistoricFileListBuildStart |
Raises the HistoricFileListBuildStart event.
|
| OnHistoricFileListUpdated |
Raises the HistoricFileListUpdated event.
|
| OnRolloverComplete |
Raises the RolloverComplete event.
|
| OnRolloverStart |
Raises the RolloverStart event.
|
| Open |
Opens the ArchiveFile for use.
|
| ReadData(IEnumerableInt32, Boolean) |
Reads all ArchiveDataPoints from the ArchiveFile for the specified historianIDs.
|
| ReadData(Int32, Boolean) |
Reads all ArchiveDataPoints from the ArchiveFile for the specified historianID.
|
| ReadData(IEnumerableInt32, TimeTag, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(IEnumerableInt32, DateTime, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(IEnumerableInt32, String, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(Int32, TimeTag, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(Int32, DateTime, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(Int32, String, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(IEnumerableInt32, TimeTag, TimeTag, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(IEnumerableInt32, DateTime, DateTime, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(IEnumerableInt32, String, String, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(Int32, TimeTag, TimeTag, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(Int32, DateTime, DateTime, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ReadData(Int32, String, String, Boolean) |
Reads ArchiveDataPoints from the ArchiveFile.
|
| ToString | Returns a string that represents the current object. (Inherited from Object) |
TopEvents Extension Methods 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