Click or drag to resize

ArchiveDataBlockPointer Class
Represents a pointer to an ArchiveDataBlock.
Inheritance Hierarchy
SystemObject
  GSF.Historian.FilesArchiveDataBlockPointer

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.181-beta
Syntax
Copy
public class ArchiveDataBlockPointer : IComparable, 
	ISupportBinaryImage
View Source

The ArchiveDataBlockPointer type exposes the following members.

Properties
 NameDescription
Public propertyBinaryLength Gets the length of the ArchiveDataBlockPointer.
Public propertyDataBlock Gets the ArchiveDataBlock corresponding to the ArchiveDataBlockPointer.
Public propertyHistorianID Gets or sets the historian identifier of ArchiveDataBlockPointer.
Public propertyIndex Gets the 0-based index of the ArchiveDataBlockPointer.
Public propertyIsAllocated Gets a boolean value that indicates whether the DataBlock has been allocated to contain ArchiveDataPoints.
Public propertyStartTime Gets or sets the TimeTag of first ArchiveDataPoint in the DataBlock.
Top
Methods
 NameDescription
Public methodCompareTo Compares the current ArchiveDataBlockPointer object to obj.
Public methodEquals Determines whether the current ArchiveDataBlockPointer object is equal to obj.
(Overrides ObjectEquals(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 methodGenerateBinaryImage Generates binary image of the ArchiveDataBlockPointer and copies it into the given buffer, for BinaryLength bytes.
Public methodGetDataBlock Gets the ArchiveDataBlock associated with this ArchiveDataBlockPointer.
Public methodGetHashCode Returns the hash code for the current ArchiveDataBlock object.
(Overrides ObjectGetHashCode)
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 ArchiveDataBlockPointer from the specified buffer.
Public methodReset Deallocates the DataBlock to store new ArchiveDataPoints.
Public methodToString Returns the text representation of ArchiveDataBlockPointer object.
(Overrides ObjectToString)
Top
Fields
 NameDescription
Public fieldStatic memberFixedLength Specifies the number of bytes in the binary image of ArchiveDataBlockPointer.
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 MethodMatches Tests if the dataBlockPointer matches the specified search criteria.
(Defined by ArchiveDataBlockPointerExtensions)
Public Extension MethodParseBinaryImageFromStream Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions)
Top
See Also