Click or drag to resize

ArchiveFileAllocationTable Class

Represents the File Allocation Table of an ArchiveFile.
Inheritance Hierarchy
SystemObject
  GSF.Historian.FilesArchiveFileAllocationTable

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.218-beta
Syntax
public class ArchiveFileAllocationTable : ISupportBinaryImage
View Source

The ArchiveFileAllocationTable type exposes the following members.

Properties
 NameDescription
Public propertyBinaryLength Gets the length of the ArchiveFileAllocationTable.
Public propertyDataBlockCount Gets the total number of ArchiveDataBlocks in the ArchiveFile.
Public propertyDataBlockPointers Gets the ArchiveDataBlockPointers to the ArchiveDataBlocks in the ArchiveFile.
Public propertyDataBlocksAvailable Gets the number of unused ArchiveDataBlocks in the ArchiveFile.
Public propertyDataBlockSize Gets the size (in KB) of a single ArchiveDataBlock in the ArchiveFile.
Public propertyDataBlocksUsed Gets the number of used ArchiveDataBlocks in the ArchiveFile.
Public propertyDataPointsArchived Gets or sets the number ArchiveDataPoints archived by the ArchiveFile.
Public propertyDataPointsReceived Gets or sets the number ArchiveDataPoints received by the ArchiveFile for archival.
Public propertyFileEndTime Gets or sets the TimeTag of the newest ArchiveDataBlock in the ArchiveFile.
Public propertyFileStartTime Gets or sets the TimeTag of the oldest ArchiveDataBlock in the ArchiveFile.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExtend Extends the ArchiveFile by one ArchiveDataBlock.
Public methodExtend(Int32) Extends the ArchiveFile by the specified number of ArchiveDataBlocks.
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 methodFindDataBlock Returns the first ArchiveDataBlock in the ArchiveFile for the specified historianID.
Public methodFindDataBlocks(Int32, Boolean) Returns all ArchiveDataBlocks in the ArchiveFile for the specified historianID.
Public methodFindDataBlocks(Int32, TimeTag, Boolean) Returns all ArchiveDataBlocks in the ArchiveFile for the specified historianID with ArchiveDataPoint points later than the specified startTime.
Public methodFindDataBlocks(Int32, TimeTag, TimeTag, Boolean) Returns all ArchiveDataBlocks in the ArchiveFile for the specified historianID with ArchiveDataPoints between the specified startTime and endTime.
Public methodFindLastDataBlock Returns the last ArchiveDataBlock in the ArchiveFile for the specified historianID.
Public methodGenerateBinaryImage Generates binary image of the ArchiveFileAllocationTable and copies it into the given buffer, for BinaryLength bytes.
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 methodParseBinaryImage Initializes object by parsing the specified buffer containing a binary image.
Public methodSave Saves the ArchiveFileAllocationTable data to the ArchiveFile.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodBinaryImage Returns a binary image of an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions)
Public Extension MethodCopyBinaryImageToStream Copies binary image of object that implements ISupportBinaryImage to a Stream.
(Defined by ISupportBinaryImageExtensions)
Public Extension MethodCopyImage This is a common optimized block copy function for any kind of data.
(Defined by Common)
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)
Public Extension MethodParseBinaryImageFromStream Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions)
Top
See Also