Click or drag to resize

ArchiveFileScanner Class
Scans an archive file for data points in a given time range and returns them in the order that they are scanned.
Inheritance Hierarchy
SystemObject
  GSF.Historian.FilesArchiveFileScanner

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.257-beta
Syntax
Copy
public class ArchiveFileScanner : IArchiveFileScanner
View Source

The ArchiveFileScanner type exposes the following members.

Constructors
 NameDescription
Public methodArchiveFileScanner Scans an archive file for data points in a given time range and returns them in the order that they are scanned.
Top
Properties
 NameDescription
Public propertyDataReadExceptionHandler Gets or sets the handler used to handle errors that occur while scanning the file.
Public propertyEndTime Gets or sets the maximum value of the timestamps of the data points returned by the scanner.
Public propertyFileAllocationTable Gets or sets the file allocation table of the file that this scanner is reading from.
Public propertyHistorianIDs Gets or sets the collection of point IDs to be scanned from the file.
Public propertyResumeFrom Gets or sets the data point from which to resume the scan if it was interrupted by a rollover.
Public propertyReverseQuery Gets flag that determines if data will be queried in reverse order.
Public propertyStartTime Gets or sets the minimum value of the timestamps of the data points returned by the scanner.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
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)
Public methodRead Reads all IDataPoints for the specified historian IDs.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
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
See Also