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.230-beta

Syntax

C++

JavaScript

Copy

public class ArchiveReader : IDisposable

Public Class ArchiveReader
	Implements IDisposable

public ref class ArchiveReader : IDisposable

type ArchiveReader = 
    class
        interface IDisposable
    end

GSF.Historian.Files.ArchiveReader = function();

Type.createClass(
	'GSF.Historian.Files.ArchiveReader',
	null,
	IDisposable);

View Source

The ArchiveReader type exposes the following members.

Constructors

	Name	Description
	ArchiveReader	Creates a new ArchiveReader.

Top

Properties

	Name	Description
	ArchiveOffloadLocation	Gets the path to the offload location used by the ArchiveFile.
	FileName	Gets the name of the ArchiveFile.
	IntercomFile	Gets the IntercomFile used by the ArchiveFile.
	MetadataFile	Gets the MetadataFile used by the ArchiveFile.
	StateFile	Gets the StateFile used by the ArchiveFile.
	Status	Gets the descriptive status of the internal ArchiveFile.

Top

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)

Top

Events

	Name	Description
	DataReadException	Occurs when an Exception is encountered while reading IDataPoint from the current or historic ArchiveFile.
	HistoricFileListBuildComplete	Occurs when the process of building historic ArchiveFile list is complete.
	HistoricFileListBuildException	Occurs when an Exception is encountered in historic ArchiveFile list building process.
	HistoricFileListBuildStart	Occurs when the process of building historic ArchiveFile list is started.
	HistoricFileListUpdated	Occurs when the historic ArchiveFile list is updated to reflect addition or deletion of historic ArchiveFiles.
	RolloverComplete	Occurs when Rollover to a new ArchiveFile is complete.
	RolloverStart	Occurs when Rollover to a new ArchiveFile is started.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	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.

Reference

GSF.Historian.Files Namespace