Represents the common header for all BPA PDCstream frames of data.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class CommonFrameHeader : ICommonHeader<FrameType>, ISerializable
<SerializableAttribute> _ Public Class CommonFrameHeader _ Implements ICommonHeader(Of FrameType), ISerializable
[SerializableAttribute] public ref class CommonFrameHeader : ICommonHeader<FrameType>, ISerializable
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | CommonFrameHeader(Byte) |
Creates a new CommonFrameHeader from specified parameters.
|
| CommonFrameHeader(Boolean, Boolean, ConfigurationFrame, array<Byte>[]()[][], Int32, Int32) |
Creates a new CommonFrameHeader from given binaryImage.
|
 | CommonFrameHeader(SerializationInfo, StreamingContext) |
Creates a new CommonFrameHeader from serialization parameters.
|
 | 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).
|
  | DstHeaderFixedLength |
Total fixed length of CommonFrameHeader for header in phasor file format data.
|
| Equals(Object) | (Inherited from Object.) |
| 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.
|
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| FixedLength |
Total fixed length of CommonFrameHeader, streaming data or data row in phasor file format data.
|
| 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.
|
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetObjectData(SerializationInfo, StreamingContext) |
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.) |
| 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, accuarate 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.
|
| ToString()()()() | (Inherited from 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.
|
Inheritance Hierarchy| Object | |
 | CommonFrameHeader |