Click or drag to resize

StateRecordSummary Class

A class with just CurrentData. The generated binary image of MetadataRecordSummary is sent back as a reply to PacketType11.
Inheritance Hierarchy
SystemObject
  GSF.Historian.FilesStateRecordSummary

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

The StateRecordSummary type exposes the following members.

Constructors
 NameDescription
Public methodStateRecordSummary(StateRecord) Initializes a new instance of the StateRecordSummary class.
Public methodStateRecordSummary(Byte, Int32, Int32) Initializes a new instance of the StateRecordSummary class.
Top
Properties
 NameDescription
Public propertyBinaryLength Gets the length of the StateRecordSummary.
Public propertyCurrentData Same as CurrentData.
Public propertyHistorianID Same as HistorianID.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from 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 StateRecordSummary 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 StateRecordSummary from the specified buffer.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberFixedLength Specifies the number of bytes in the binary image of StateRecordSummary.
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