Gemstone PhasorProtocols Library
Show/Hide TOC

# DataFrameBase Class

Represents the protocol independent common implementation of any IDataFrame that can be sent or received.

## Definition

Namespace: Gemstone.PhasorProtocols
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.164 -- Release Build+e526f121ce33f6a601f5d1519047de17ef46ec99
C#
View Source Request Example

    [SerializableAttribute]
    public abstract class DataFrameBase : ChannelFrameBase<IDataCell>,
    	IDataFrame, IChannelFrame, IChannel, ISupportBinaryImage, IFrame,
    	IEquatable<IFrame>, IComparable<IFrame>, IComparable,
    	ISerializable

VB
View Source Request Example

    <SerializableAttribute>
    Public MustInherit Class DataFrameBase
    	Inherits ChannelFrameBase(Of IDataCell)
    	Implements IDataFrame, IChannelFrame, IChannel, ISupportBinaryImage,
    	IFrame, IEquatable(Of IFrame), IComparable(Of IFrame),
    	IComparable, ISerializable

C++
View Source Request Example

    [SerializableAttribute]
    public ref class DataFrameBase abstract : public ChannelFrameBase<IDataCell^>,
    	IDataFrame, IChannelFrame, IChannel, ISupportBinaryImage, IFrame,
    	IEquatable<IFrame^>, IComparable<IFrame^>, IComparable,
    	ISerializable

JavaScript
View Source Request Example

    Gemstone.PhasorProtocols.DataFrameBase = function();

    Type.createClass(
    	'Gemstone.PhasorProtocols.DataFrameBase',
    	Gemstone.PhasorProtocols.ChannelFrameBase`1,
    	Gemstone.PhasorProtocols.IDataFrame,
    	Gemstone.PhasorProtocols.IChannelFrame,
    	Gemstone.PhasorProtocols.IChannel,
    	ISupportBinaryImage,
    	IFrame,
    	IEquatable`1,
    	IComparable`1,
    	IComparable,
    	ISerializable);

Inheritance
  Object BinaryImageBase ChannelBase ChannelFrameBase IDataCell DataFrameBase

Derived
  Gemstone.PhasorProtocols.BPAPDCstreamDataFrame
  Gemstone.PhasorProtocols.FNETDataFrame
  Gemstone.PhasorProtocols.IEC61850_90_5DataFrame
  Gemstone.PhasorProtocols.IEEE1344DataFrame
  Gemstone.PhasorProtocols.IEEEC37_118DataFrame
  Gemstone.PhasorProtocols.MacrodyneDataFrame
  Gemstone.PhasorProtocols.SelCWSDataFrame
  Gemstone.PhasorProtocols.SelFastMessageDataFrame
  More Less

Implements
  ISupportBinaryImage, IChannel, IChannelFrame, IDataFrame, IFrame, IComparable, IComparable IFrame, IEquatable IFrame, ISerializable

## Constructors

DataFrameBase(SerializationInfo, StreamingContext) | Creates a new DataFrameBase from serialization parameters.
DataFrameBase(DataCellCollection, Ticks, IConfigurationFrame) | Creates a new DataFrameBase 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 ChannelFrameBaseT object. (Inherited from ChannelFrameBaseT)
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 DataFrameBase.
Checksum | Gets calculated checksum for this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
ConfigurationFrame | Gets or sets IConfigurationFrame associated with this DataFrameBase.
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. (Overrides ChannelFrameBaseT FrameType)
HeaderImage | Gets the binary header image of the ChannelBase object. (Inherited from ChannelBase)
HeaderLength | Gets the length of the header portion of the BinaryImageBase object. (Inherited from BinaryImageBase)
IDCode | Gets the numeric ID code for this DataFrameBase. (Overrides ChannelFrameBaseT IDCode)
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.
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.
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 ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
TimeTag | Gets UNIX based time representation of the ticks of this ChannelFrameBaseT. (Inherited from ChannelFrameBaseT)
TrustHeaderLength | Gets or sets flag that determines if header lengths should be trusted over parsed byte count. (Inherited from ChannelFrameBaseT)
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. (Inherited from ChannelFrameBaseT)
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 ChannelFrameBaseT GetObjectData(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. (Overrides ChannelFrameBaseT ParseBinaryImage(Byte, Int32, Int32))
ParseBodyImage | Parses the binary body image. (Inherited from ChannelFrameBaseT)
ParseFooterImage(Byte[], Int32, Int32) | Parses the binary footer image. (Inherited from BinaryImageBase)
ParseHeaderImage(Byte[], Int32, Int32) | Parses the binary header image. (Inherited from BinaryImageBase)
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 Namespace