|
Common
|
Represents the common header for all IEEE C37.118 frames of data.
Inheritance Hierarchy
Namespace: GSF.PhasorProtocols.IEEEC37_118
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.181-beta
Syntax[SerializableAttribute] public class CommonFrameHeader : ICommonHeader<FrameType>, ISerializable
The CommonFrameHeader type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CommonFrameHeader(SerializationInfo, StreamingContext) | Creates a new CommonFrameHeader from serialization parameters. |
 | CommonFrameHeader(ConfigurationFrame1, Byte, Int32) | Creates a new CommonFrameHeader from given buffer. |
| CommonFrameHeader(ConfigurationFrame1, FrameType, UInt16, Ticks, DraftRevision) | Creates a new CommonFrameHeader from specified parameters. |
Properties| Name | Description | |
|---|---|---|
 | BinaryImage | Gets the binary image of the common header portion of this frame. |
| ContinuationIndex | Gets or sets continuation index for fragmented frames of a ConfigurationFrame3. |
| DataLength | Gets or sets the length of the data in the IEEE C37.118 frame (i.e., the FrameLength minus the header length and checksum: FrameLength - 8). |
| FractionOfSecond | Gets the IEEE C37.118 fraction of second. |
| FrameImages | Gets or sets reference to FrameImageCollector used to cumulate fragmented frames of a ConfigurationFrame3. |
| FrameLength | Gets or sets the IEEE C37.118 frame length of this frame. |
| FrameType | Gets the fundamental frame type of this frame. |
| IDCode | Gets or sets the IEEE C37.118 ID code of this frame. |
| IsFirstFrame | Gets flag that determines if the ContinuationIndex represents the first frame in a series of frames that follow. |
| IsLastFrame | Gets flag that determines if the ContinuationIndex represents the last frame in a series of frames. |
| SecondOfCentury | Gets the IEEE C37.118 second of century. |
| State | Gets or sets the parsing state for the CommonFrameHeader object. |
| Timebase | Gets or sets the IEEE C37.118 resolution of fractional time stamps. |
| TimeQualityFlags | Gets or sets the IEEE C37.118 TimeQualityFlags. |
| TimeQualityIndicatorCode | Gets or sets the IEEE C37.118 TimeQualityIndicatorCode. |
| Timestamp | Gets or sets timestamp of this CommonFrameHeader. |
| TimeTag | Gets time as a UnixTimeTag representing seconds of current Timestamp. |
| TypeID | Gets or sets the IEEE C37.118 specific frame type of this frame. |
| Version | Gets or sets the IEEE C37.118 version of this frame. |
Methods| Name | Description | |
|---|---|---|
 | ChecksumIsValid | Validates the CRC-CCITT for the specified IEEE C37.118 buffer. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from 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) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetObjectData | Populates a SerializationInfo with the data needed to serialize the target object. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields| Name | Description | |
|---|---|---|
 | FixedLength | Total fixed length of CommonFrameHeader. |
Extension Methods| Name | Description | |
|---|---|---|
 | 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) |
See Also