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.218-beta

Syntax

C++

JavaScript

Copy

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

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

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

[<SerializableAttribute>]
type CommonFrameHeader = 
    class
        interface ICommonHeader<FrameType>
        interface ISerializable
    end

GSF.PhasorProtocols.IEEE1344.CommonFrameHeader = function();

Type.createClass(
	'GSF.PhasorProtocols.IEEE1344.CommonFrameHeader',
	null,
	GSF.Parsing.ICommonHeader`1,
	ISerializable);

View Source

The CommonFrameHeader type exposes the following members.

Constructors

	Name	Description
	CommonFrameHeader(Byte, Int32)	Creates a new CommonFrameHeader from given buffer.
	CommonFrameHeader(FrameType, Ticks)	Creates a new CommonFrameHeader from specified parameters.
	CommonFrameHeader(SerializationInfo, StreamingContext)	Creates a new CommonFrameHeader from serialization parameters.

Top

Properties

	Name	Description
	BinaryImage	Gets the binary image of the common header portion of this frame.
	DataLength	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).
	FrameCount	Gets or sets the total frame count.
	FrameImages	Gets or sets reference to a FrameImageCollector associated the IEEE 1344 frame, if any.
	FrameLength	Gets or sets the entire length of the IEEE 1344 frame.
	FrameType	Gets the fundamental frame type of this frame.
	IsFirstFrame	Gets or sets flag from that determines if this is the first frame image in a series of images representing an entire frame.
	IsLastFrame	Gets or sets flag that determines if this is the last frame image in a series of images representing an entire frame.
	SampleCount	Gets or sets the sample number (i.e., frame count) of this frame.
	State	Gets or sets the parsing state for the CommonFrameHeader object.
	Timestamp	Gets or sets timestamp of this CommonFrameHeader.
	TimeTag	Gets the timestamp of this frame in NTP format.
	TypeID	Gets or sets the IEEE 1344 specific frame type of this frame.

Top

Methods

	Name	Description
	ChecksumIsValid	Validates the CRC-CCITT for the specified IEEE 1344 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)

Top

Fields

	Name	Description
	FixedLength	Total fixed length of CommonFrameHeader.

Top

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)

Top

Reference

GSF.PhasorProtocols.IEEE1344 Namespace