ArchiveDataBlock Class

Represents a block of ArchiveDataPoints in an ArchiveFile.

Inheritance Hierarchy

SystemObject
GSF.Historian.FilesArchiveDataBlock

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.218-beta

Syntax

public class ArchiveDataBlock

Public Class ArchiveDataBlock

public ref class ArchiveDataBlock

type ArchiveDataBlock = class end

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

Type.createClass(
	'GSF.Historian.Files.ArchiveDataBlock');

The ArchiveDataBlock type exposes the following members.

Properties

	Name	Description
	Capacity	Gets the maximum number of ArchiveDataPoints that can be stored in the ArchiveDataBlock.
	Index	Gets the 0-based index of the ArchiveDataBlock.
	IsActive	Gets a boolean value that indicates whether the ArchiveDataBlock is being actively used.
	Location	Gets the start location (byte position) of the ArchiveDataBlock in the ArchiveFile.
	SlotsAvailable	Gets the number of ArchiveDataPoints that can to written to the ArchiveDataBlock.
	SlotsUsed	Gets the number of ArchiveDataPoints that have been written to the ArchiveDataBlock.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	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.
	OnDataWriteException	Raises the DataWriteException event.
	Read	Reads existing ArchiveDataPoints from the ArchiveDataBlock.
	Reset	Resets the ArchiveDataBlock by overwriting existing ArchiveDataPoints with empty ArchiveDataPoints.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	Write(IDataPoint, Boolean)	Writes the dataPoint to the ArchiveDataBlock.
	Write(IDataPoint, Exception)	Writes the dataPoint to the ArchiveDataBlock.

Events

	Name	Description
	DataReadException	Occurs when an Exception is encountered while reading IDataPoint from the ArchiveDataBlock.
	DataWriteException	Occurs when an Exception is encountered while writing IDataPoint to the ArchiveDataBlock.

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)