StateRecord Class

Represents a record in the StateFile that contains the state information associated to a HistorianID.

Inheritance Hierarchy

SystemObject
GSF.Historian.FilesStateRecord

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

Syntax

C++

JavaScript

Copy

public class StateRecord : ISupportBinaryImage, 
	IComparable

Public Class StateRecord
	Implements ISupportBinaryImage, IComparable

public ref class StateRecord : ISupportBinaryImage, 
	IComparable

type StateRecord = 
    class
        interface ISupportBinaryImage
        interface IComparable
    end

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

Type.createClass(
	'GSF.Historian.Files.StateRecord',
	null,
	GSF.Parsing.ISupportBinaryImage,
	IComparable);

View Source

The StateRecord type exposes the following members.

Constructors

	Name	Description
	StateRecord(Int32)	Initializes a new instance of the StateRecord class.
	StateRecord(Int32, Byte, Int32, Int32)	Initializes a new instance of the StateRecord class.

Top

Properties

	Name	Description
	ActiveDataBlockIndex	Gets or sets the 0-based index of the active ArchiveDataBlock for the HistorianID.
	ActiveDataBlockSlot	Gets or sets the next slot position in the active ArchiveDataBlock for the HistorianID where data can be written.
	ArchivedData	Gets or sets the most recently archived StateRecordDataPoint for the HistorianID.
	BinaryLength	Gets the length of the StateRecord.
	CurrentData	Gets or sets the most current StateRecordDataPoint received for the HistorianID.
	HistorianID	Gets the historian identifier of StateRecord.
	PreviousData	Gets or sets the previous StateRecordDataPoint received for the HistorianID.
	Slope1	Gets or sets slope #1 used in the piece-wise linear compression of data.
	Slope2	Gets or sets slope #2 used in the piece-wise linear compression of data.
	Summary	Gets the StateRecordSummary object for StateRecord.

Top

Methods

	Name	Description
	CompareTo	Compares the current StateRecord object to obj.
	Equals	Determines whether the current StateRecord object is equal to obj. (Overrides ObjectEquals(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)
	GenerateBinaryImage	Generates binary image of the StateRecord and copies it into the given buffer, for BinaryLength bytes.
	GetHashCode	Returns the hash code for the current StateRecord object. (Overrides ObjectGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParseBinaryImage	Initializes StateRecord from the specified buffer.
	ToString	Returns the text representation of StateRecord object. (Overrides ObjectToString)

Top

Fields

	Name	Description
	FixedLength	Specifies the number of bytes in the binary image of StateRecord.

Top

Extension Methods

	Name	Description
	BinaryImage	Returns a binary image of an object that implements ISupportBinaryImage. (Defined by ISupportBinaryImageExtensions)
	CopyBinaryImageToStream	Copies binary image of object that implements ISupportBinaryImage to a Stream. (Defined by ISupportBinaryImageExtensions)
	CopyImage	This is a common optimized block copy function for any kind of data. (Defined by Common)
	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)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)

Top

Reference

GSF.Historian.Files Namespace

StateFile

StateRecordSummary

StateRecordDataPoint