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



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

DataFrame(Ticks, ConfigurationFrame, Int16)
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.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
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)
Method is not implemented.
(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()()()() (Inherited from BinaryImageBase.)
HeaderLength()()()() (Inherited from BinaryImageBase.)
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>)>)>.)
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.)
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) (Inherited from BinaryImageBase.)
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>)>)>.)
SampleIndex
Gets or sets the sample index 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 DataFrameBase.
(Inherited from DataFrameBase.)
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 F-NET frame.

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

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