Click or drag to resize

CommonFrameHeader Class

Represents the common header for all IEEE 1344 frames of data.
Inheritance Hierarchy
SystemObject
  GSF.PhasorProtocols.IEEE1344CommonFrameHeader

Namespace: GSF.PhasorProtocols.IEEE1344
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.205-beta
Syntax
[SerializableAttribute]
public class CommonFrameHeader : ICommonHeader<FrameType>, 
	ISerializable
View Source

The CommonFrameHeader type exposes the following members.

Constructors
 NameDescription
Public methodCommonFrameHeader(Byte, Int32) Creates a new CommonFrameHeader from given buffer.
Public methodCommonFrameHeader(FrameType, Ticks) Creates a new CommonFrameHeader from specified parameters.
Protected methodCommonFrameHeader(SerializationInfo, StreamingContext) Creates a new CommonFrameHeader from serialization parameters.
Top
Properties
 NameDescription
Public propertyBinaryImage Gets the binary image of the common header portion of this frame.
Public propertyDataLength Gets or sets the length of the data in the IEEE 1344 frame (i.e., the FrameLength minus the header length and checksum: FrameLength - 8).
Public propertyFrameCount Gets or sets the total frame count.
Public propertyFrameImages Gets or sets reference to a FrameImageCollector associated the IEEE 1344 frame, if any.
Public propertyFrameLength Gets or sets the entire length of the IEEE 1344 frame.
Public propertyFrameType Gets the fundamental frame type of this frame.
Public propertyIsFirstFrame Gets or sets flag from that determines if this is the first frame image in a series of images representing an entire frame.
Public propertyIsLastFrame Gets or sets flag that determines if this is the last frame image in a series of images representing an entire frame.
Public propertySampleCount Gets or sets the sample number (i.e., frame count) of this frame.
Public propertyState Gets or sets the parsing state for the CommonFrameHeader object.
Public propertyTimestamp Gets or sets timestamp of this CommonFrameHeader.
Public propertyTimeTag Gets the timestamp of this frame in NTP format.
Public propertyTypeID Gets or sets the IEEE 1344 specific frame type of this frame.
Top
Methods
 NameDescription
Public methodStatic memberChecksumIsValid Validates the CRC-CCITT for the specified IEEE 1344 buffer.
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 methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetObjectData Populates a SerializationInfo with the data needed to serialize the target 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 methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberFixedLength Total fixed length of CommonFrameHeader.
Top
Extension Methods
 NameDescription
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)
Top
See Also