Click or drag to resize

CommonFrameHeader Class

Represents the common header for all SEL Fast Message frames of data.
Inheritance Hierarchy
SystemObject
  GSF.ParsingCommonHeaderBaseInt32
    GSF.PhasorProtocols.SelFastMessageCommonFrameHeader

Namespace: GSF.PhasorProtocols.SelFastMessage
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.218-beta
Syntax
[SerializableAttribute]
public class CommonFrameHeader : CommonHeaderBase<int>, 
	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(FrameSize, 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 CommonFrameHeader.
Public propertyDataLength Gets the length of the data in the SEL Fast Message frame (i.e., the FrameSize minus the HeaderLength and checksum) of this CommonFrameHeader.
Public propertyFrameSize Gets or sets the SEL Fast Message frame size of this CommonFrameHeader.
Public propertyIDCode Gets or sets the SEL Fast Message destination address (PMADDR setting) of this CommonFrameHeader.
Public propertyRegisterCount Gets the SEL Fast Message register count of this CommonFrameHeader.
Public propertySampleNumber Gets the SEL Fast Message sample number of this CommonFrameHeader.
Public propertySecondOfCentury Gets the SEL Fast Message second of century of this CommonFrameHeader.
Public propertyState Gets or sets any additional state information that might be needed for parsing.
(Inherited from CommonHeaderBaseTTypeIdentifier)
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 identifier used for identifying the Type to be parsed.
(Inherited from CommonHeaderBaseTTypeIdentifier)
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 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.
Public fieldStatic memberHeaderLength Total header 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