CommonFrameHeader Class

Represents the common header for all BPA PDCstream frames of data.

Inheritance Hierarchy

SystemObject
GSF.PhasorProtocols.BPAPDCstreamCommonFrameHeader

Namespace: GSF.PhasorProtocols.BPAPDCstream
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.181-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.BPAPDCstream.CommonFrameHeader = function();

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

View Source

The CommonFrameHeader type exposes the following members.

Constructors

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

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 BPA PDCstream frame (i.e., the FrameLength minus the header length and checksum: FrameLength - 8).
	FileType	Gets or sets file type for this CommonFrameHeader used when frame is configuration frame and use phasor file format is true.
	FileVersion	Gets or sets file version for this CommonFrameHeader used when frame is configuration frame and use phasor file format is true.
	FrameLength	Gets or sets the BPA PDCstream frame length of this frame.
	FrameRate	Gets frame rate based on sample rate and sample interval for the CommonFrameHeader object.
	FrameType	Gets the fundamental frame type of this frame.
	PacketNumber	Gets or sets the BPA PDCstream packet number of this frame - set to 00 for configuration frame
	PmuCount	Gets or sets PMU count (i.e., number of cells) for the CommonFrameHeader object when use phasor file format is true.
	PreTriggerRows	Gets or sets pre-trigger rows for the CommonFrameHeader object when use phasor file format is true.
	RoughTimestamp	Gets rough timestamp, accurate to the second, that can be used until configuration frame arrives.
	RowFlags	Gets or sets row flags for this CommonFrameHeader when frame is a data frame and use phasor file format is true.
	RowLength	Gets or sets row length for the CommonFrameHeader object when use phasor file format is true.
	SampleInterval	Gets or sets sample interval for the CommonFrameHeader object.
	SampleRate	Gets or sets sample rate for the CommonFrameHeader object.
	SourceID	Gets or sets source ID for the CommonFrameHeader object.
	StartSample	Gets or sets start sample for the CommonFrameHeader object.
	State	Gets or sets the parsing state for the CommonFrameHeader object.
	TotalRows	Gets or sets total number of data rows for the CommonFrameHeader object when use phasor file format is true.
	TriggerPMU	Gets or sets trigger PMU number for the CommonFrameHeader object when use phasor file format is true.
	TriggerSample	Gets or sets trigger sample for the CommonFrameHeader object when use phasor file format is true.
	TriggerTime	Gets or sets trigger time for the CommonFrameHeader object when use phasor file format is true.
	TriggerType	Gets or sets trigger type for the CommonFrameHeader object when use phasor file format is true.
	TypeID	Gets or sets the BPA PDCstream specific frame type of this frame.
	UsePhasorDataFileFormat	Gets or sets flag that determines if source data is in the Phasor Data File Format (i.e., a DST file).
	UserInformation	Gets or sets free-form user information that can be added to the CommonFrameHeader object when use phasor file format is true.
	WordCount	Gets or sets the BPA PDcstream word count.

Top

Methods

	Name	Description
	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
	DstHeaderFixedLength	Total fixed length of CommonFrameHeader for header in phasor file format data.
	FixedLength	Total fixed length of CommonFrameHeader, streaming data or data row in phasor file format data.

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.BPAPDCstream Namespace