Click or drag to resize

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.207-beta
Syntax
public class StateRecord : ISupportBinaryImage, 
	IComparable
View Source

The StateRecord type exposes the following members.

Constructors
 NameDescription
Public methodStateRecord(Int32) Initializes a new instance of the StateRecord class.
Public methodStateRecord(Int32, Byte, Int32, Int32) Initializes a new instance of the StateRecord class.
Top
Properties
 NameDescription
Public propertyActiveDataBlockIndex Gets or sets the 0-based index of the active ArchiveDataBlock for the HistorianID.
Public propertyActiveDataBlockSlot Gets or sets the next slot position in the active ArchiveDataBlock for the HistorianID where data can be written.
Public propertyArchivedData Gets or sets the most recently archived StateRecordDataPoint for the HistorianID.
Public propertyBinaryLength Gets the length of the StateRecord.
Public propertyCurrentData Gets or sets the most current StateRecordDataPoint received for the HistorianID.
Public propertyHistorianID Gets the historian identifier of StateRecord.
Public propertyPreviousData Gets or sets the previous StateRecordDataPoint received for the HistorianID.
Public propertySlope1 Gets or sets slope #1 used in the piece-wise linear compression of data.
Public propertySlope2 Gets or sets slope #2 used in the piece-wise linear compression of data.
Public propertySummary Gets the StateRecordSummary object for StateRecord.
Top
Methods
 NameDescription
Public methodCompareTo Compares the current StateRecord object to obj.
Public methodEquals Determines whether the current StateRecord 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 StateRecord and copies it into the given buffer, for BinaryLength bytes.
Public methodGetHashCode Returns the hash code for the current StateRecord 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 StateRecord from the specified buffer.
Public methodToString Returns the text representation of StateRecord object.
(Overrides ObjectToString)
Top
Fields
 NameDescription
Public fieldStatic memberFixedLength Specifies the number of bytes in the binary image of StateRecord.
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