Gemstone PhasorProtocols Library
Show/Hide TOC

# DataFrame Class

Represents the IEEE 1344 implementation of a IDataFrame that can be sent or received.

## Definition

Namespace: Gemstone.PhasorProtocols.IEEE1344
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.143 -- Release Build+85729467224f210ef9c8bf0e7fa8d262d89bcbcd
C#
View Source Request Example

    [SerializableAttribute]
    public class DataFrame : DataFrameBase, ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>,
    	ISupportFrameImage<FrameType>, ISupportBinaryImage

VB
View Source Request Example

    <SerializableAttribute>
    Public Class DataFrame
    	Inherits DataFrameBase
    	Implements ISupportSourceIdentifiableFrameImage(Of SourceChannel, FrameType),
    	ISupportFrameImage(Of FrameType), ISupportBinaryImage

C++
View Source Request Example

    [SerializableAttribute]
    public ref class DataFrame : public DataFrameBase,
    	ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>, ISupportFrameImage<FrameType>,
    	ISupportBinaryImage

JavaScript
View Source Request Example

    Gemstone.PhasorProtocols.IEEE1344.DataFrame = function();

    Type.createClass(
    	'Gemstone.PhasorProtocols.IEEE1344.DataFrame',
    	Gemstone.PhasorProtocols.DataFrameBase,
    	ISupportSourceIdentifiableFrameImage,
    	ISupportFrameImage,
    	ISupportBinaryImage);

Inheritance
  Object BinaryImageBase ChannelBase ChannelFrameBase IDataCell DataFrameBase DataFrame

Implements
  ISupportBinaryImage, ISupportFrameImage FrameType, ISupportSourceIdentifiableFrameImage SourceChannel, FrameType

## Constructors

DataFrame | Creates a new DataFrame.
DataFrame(SerializationInfo, StreamingContext) | Creates a new DataFrame from serialization parameters.
DataFrame(Ticks, ConfigurationFrame) | Creates a new DataFrame from specified parameters.

## Properties

AllowQueuedPublication | Gets flag that determines if frame image can be queued for publication or should be processed immediately. (Inherited from ChannelFrameBaseT)
Attributes | DictionaryTKey, TValue of string based property names and values for the DataFrame object. (Overrides ChannelFrameBaseT Attributes)
BinaryImage | Gets the binary image of this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
BinaryLength | Gets the length of the BinaryImage. (Inherited from ChannelFrameBaseT)
BodyImage | Gets the binary body image of this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
BodyLength | Gets the length of the BodyImage. (Inherited from ChannelFrameBaseT)
Cells | Gets reference to the DataCellCollection for this DataFrame.
Checksum | Gets calculated checksum for this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
CommonHeader | Gets or sets current CommonFrameHeader.
ConfigurationFrame | Gets or sets ConfigurationFrame associated with this DataFrame.
CreatedTimestamp | Gets timestamp, in ticks, of when this ChannelFrameBaseT was created. (Inherited from ChannelFrameBaseT)
FooterImage | Gets the binary footer image of the BinaryImageBase object. (Inherited from ChannelBase)
FooterLength | Gets the length of the footer portion of the BinaryImageBase object. (Inherited from BinaryImageBase)
FrameType | Gets the FundamentalFrameType for this DataFrameBase. (Inherited from DataFrameBase)
HeaderImage | Gets the binary header image of the DataFrame object. (Overrides ChannelBaseHeaderImage)
HeaderLength | Gets the length of the HeaderImage. (Overrides HeaderLength)
IDCode | Gets the numeric ID code for this DataFrame.
LastSortedMeasurement | Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
Lifespan | Gets the life-span of this ChannelFrameBaseT since its creation. (Inherited from ChannelFrameBaseT)
Measurements | Keyed measurements in this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
ParsedBinaryLength | Gets the parsed binary length derived from the parsing state, if any. (Inherited from ChannelFrameBaseT)
Published | Gets or sets published state of this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
QualityFlags | Gets or sets protocol specific quality flags for this DataFrameBase. (Inherited from DataFrameBase)
SortedMeasurements | Gets or sets total number of measurements that have been sorted into this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
Source | Gets or sets the data source identifier for this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
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 DataFrame. (Overrides ChannelFrameBaseT Timestamp)
TimeTag | Gets the timestamp of this frame in NTP format.
TrustHeaderLength | Gets or sets flag that determines if header lengths should be trusted over parsed byte count. (Inherited from ChannelFrameBaseT)
TypeID | Gets the identifier that is used to identify the IEEE 1344 frame.
ValidateCheckSum | Gets or sets flag that determines if frame's check-sum should be validated - this should normally be left as true. (Inherited from ChannelFrameBaseT)

## Methods

AppendChecksum | Appends checksum onto buffer starting at startIndex. (Inherited from ChannelFrameBaseT)
CalculateChecksum | Calculates checksum of given buffer. (Overrides ChannelFrameBaseT CalculateChecksum(Byte, Int32, Int32))
ChecksumIsValid | Determines if checksum in the buffer is valid. (Inherited from ChannelFrameBaseT)
CompareTo(IFrame) | Compares the ChannelFrameBaseT with an IFrame. (Inherited from ChannelFrameBaseT)
CompareTo(Object) | Compares the ChannelFrameBaseT with the specified Object. (Inherited from ChannelFrameBaseT)
Equals(IFrame) | Determines whether the specified IFrame is equal to the current ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
Equals(Object) | Determines whether the specified Object is equal to the current ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GenerateBinaryImage | Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes. (Inherited from ChannelBase)
GenerateBodyImage(Byte[], Int32) | Generates the binary body image and copies it into the given buffer, for BodyLength bytes. (Inherited from BinaryImageBase)
GenerateFooterImage(Byte[], Int32) | Generates the binary footer image and copies it into the given buffer, for FooterLength bytes. (Inherited from BinaryImageBase)
GenerateHeaderImage(Byte[], Int32) | Generates the binary header image and copies it into the given buffer, for HeaderLength bytes. (Inherited from BinaryImageBase)
GetHashCode | Returns the hash code for this instance. (Inherited from ChannelFrameBaseT)
GetObjectData | Populates a SerializationInfo with the data needed to serialize the target object. (Overrides DataFrameBaseGetObjectData(SerializationInfo, StreamingContext))
GetType | Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object)
ParseBinaryImage | Parses the binary image. (Inherited from DataFrameBase)
ParseBodyImage | Parses the binary body image. (Inherited from ChannelFrameBaseT)
ParseFooterImage(Byte[], Int32, Int32) | Parses the binary footer image. (Inherited from BinaryImageBase)
ParseHeaderImage | Parses the binary header image. (Overrides ParseHeaderImage(Byte[], Int32, Int32))
ToString | Returns a string that represents the current object. (Inherited from Object)

## Extension Methods

CopyImage | This is a common optimized block copy function for any kind of data. (Defined by Common)

## See Also

#### Reference

Gemstone.PhasorProtocols.IEEE1344 Namespace