openPDC Synchrophasor Help
DataFrame Class
NamespacesTVA.PhasorProtocols.BpaPdcStreamDataFrame
Represents the BPA PDCstream implementation of a IDataFrame that can be sent or received.
Declaration Syntax
C#Visual BasicVisual C++
[SerializableAttribute]
public class DataFrame : DataFrameBase, ISupportFrameImage<FrameType>, 
	ISupportBinaryImage
<SerializableAttribute> _
Public Class DataFrame _
	Inherits DataFrameBase _
	Implements ISupportFrameImage(Of FrameType), ISupportBinaryImage
[SerializableAttribute]
public ref class DataFrame : public DataFrameBase, 
	ISupportFrameImage<FrameType>, ISupportBinaryImage
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
DataFrame()()()()
Creates a new DataFrame.

DataFrame(Ticks, ConfigurationFrame, Byte, UInt16)
Creates a new DataFrame from specified parameters.

DataFrame(SerializationInfo, StreamingContext)
Creates a new DataFrame from serialization parameters.

AppendChecksum(array<Byte>[]()[][], Int32)
Appends checksum onto buffer starting at startIndex.
(Overrides ChannelFrameBase<(Of <(<'IDataCell>)>)>.AppendChecksum(array<Byte>[]()[][], Int32).)
Attributes
Dictionary<(Of <(<'TKey, TValue>)>)> of string based property names and values for the DataFrame object.
(Overrides ChannelFrameBase<(Of <(<'IDataCell>)>)>.Attributes.)
BinaryImage
Gets the binary image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
BinaryLength
Gets the length of the BinaryImage.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
BodyImage
Gets the binary body image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
BodyLength
Gets the length of the BodyImage.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
CalculateChecksum(array<Byte>[]()[][], Int32, Int32)
Calculates checksum of given buffer.
(Overrides ChannelFrameBase<(Of <(<'IDataCell>)>)>.CalculateChecksum(array<Byte>[]()[][], Int32, Int32).)
Cells
Gets reference to the DataCellCollection for this DataFrame.

ChecksumIsValid(array<Byte>[]()[][], Int32)
Determines if checksum in the buffer is valid.
(Overrides ChannelFrameBase<(Of <(<'IDataCell>)>)>.ChecksumIsValid(array<Byte>[]()[][], Int32).)
CommonHeader
Gets or sets current CommonFrameHeader.

CompareTo(IFrame)
Compares the ChannelFrameBase<(Of <(<'T>)>)> with an IFrame.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
CompareTo(Object)
Compares the ChannelFrameBase<(Of <(<'T>)>)> with the specified Object.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ConfigurationFrame
Gets or sets ConfigurationFrame associated with this DataFrame.

CopyImage(ISupportBinaryImage, array<Byte>[]()[][], Int32%)
This is a common optimized block copy function for any kind of data.
(Inherited from Common.)
Equals(IFrame)
Determines whether the specified IFrame is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
Equals(Object)
Determines whether the specified Object is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
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.)
FooterImage()()()() (Inherited from BinaryImageBase.)
FooterLength()()()() (Inherited from BinaryImageBase.)
FrameType
Gets the FundamentalFrameType for this DataFrameBase.
(Inherited from DataFrameBase.)
GetHashCode()()()()
Returns the hash code for this instance.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
GetObjectData(SerializationInfo, StreamingContext)
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides DataFrameBase.GetObjectData(SerializationInfo, StreamingContext).)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
HeaderImage
Gets the binary header image of the DataFrame object.
(Overrides BinaryImageBase.HeaderImage()()()().)
HeaderLength
Gets the length of the HeaderImage.
(Overrides BinaryImageBase.HeaderLength()()()().)
IDCode
Gets the numeric ID code for this DataFrameBase.
(Inherited from DataFrameBase.)
Initialize(array<Byte>[]()[][], Int32, Int32)
Parses the binary image.
(Overrides DataFrameBase.Initialize(array<Byte>[]()[][], Int32, Int32).)
LastSortedMeasurement
Gets ot sets reference to last IMeasurement that was sorted into this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
LegacyLabels
Gets the legacy labels parsed from the DataFrame, if any.

Measurements
Keyed measurements in this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
NtpTimeTag
Gets the timestamp of this DataFrame formatted as NTP.

PacketNumber
Gets or sets the packet number of this DataFrame.

ParseBodyImage(array<Byte>[]()[][], Int32, Int32)
Parses the binary body image.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ParsedBinaryLength
Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ParseFooterImage(array<Byte>[]()[][], Int32, Int32) (Inherited from BinaryImageBase.)
ParseHeaderImage(array<Byte>[]()[][], Int32, Int32)
Parses the binary header image.
(Overrides BinaryImageBase.ParseHeaderImage(array<Byte>[]()[][], Int32, Int32).)
Published
Gets or sets published state of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
PublishedTimestamp
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was published (post-processing).
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ReceivedTimestamp
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was received (i.e., created).
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
SampleNumber
Gets or sets the sample number of this DataFrame.

SortedMeasurements
Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
State
Gets or sets the parsing state for the this DataFrame.

Tag
Gets or sets a user definable reference to an object associated with this ChannelBase object.
(Inherited from ChannelBase.)
Timestamp
Gets or sets exact timestamp, in ticks, of the data represented by this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
TimeTag
Gets UNIX based time representation of the ticks of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
TypeID
Gets the identifier that is used to identify the IEEE C37.118 frame.

UsePhasorDataFileFormat
Gets or sets flag that determines if source data is in the Phasor Data File Format (i.e., a DST file).

Inheritance Hierarchy
Object
BinaryImageBase
 ChannelBase
  ChannelFrameBase<(Of <(<'IDataCell>)>)>
   DataFrameBase
    DataFrame

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