CommonFrameHeader Class

Represents the common header for all IEEE C37.118 frames of data.

Definition

Namespace: Gemstone.PhasorProtocols.IEEEC37_118
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.147 -- Release Build+f4cca6bc29b9a344db35676d1f49d8207c89dbf5

C#View Source Request Example

[SerializableAttribute]
public class CommonFrameHeader : ICommonHeader<FrameType>, 
	ISerializable

VBView Source Request Example

<SerializableAttribute>
Public Class CommonFrameHeader
	Implements ICommonHeader(Of FrameType), ISerializable

C++View Source Request Example

[SerializableAttribute]
public ref class CommonFrameHeader : ICommonHeader<FrameType>, 
	ISerializable

JavaScriptView Source Request Example

Gemstone.PhasorProtocols.IEEEC37_118.CommonFrameHeader = function();

Type.createClass(
	'Gemstone.PhasorProtocols.IEEEC37_118.CommonFrameHeader',
	null,
	ICommonHeader,
	ISerializable);

Inheritance: Object CommonFrameHeader

Implements: ICommonHeaderFrameType, ISerializable

Constructors

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

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

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

FixedLength

Total fixed length of CommonFrameHeader.