openPDC Synchrophasor Help
CommonFrameHeader Class
NamespacesTVA.PhasorProtocols.Ieee1344CommonFrameHeader
Represents the common header for all IEEE 1344 frames of data.
Declaration Syntax
C#Visual BasicVisual 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 MembersConstructorsMethodsPropertiesFields



IconMemberDescription
CommonFrameHeader(FrameType, Ticks)
Creates a new CommonFrameHeader from specified parameters.

CommonFrameHeader(ConfigurationFrame, array<Byte>[]()[][], 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.

ChecksumIsValid(array<Byte>[]()[][], Int32, Int32)
Validates the CRC-CCITT for the specified IEEE 1344 buffer.

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).

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
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.

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.

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.)
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.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
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.

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
TypeID
Gets or sets the IEEE 1344 specific frame type of this frame.

Inheritance Hierarchy
Object
CommonFrameHeader

Assembly: TVA.PhasorProtocols (Module: TVA.PhasorProtocols) Version: 1.4.192.0