DataFrameBase Class

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

Inheritance Hierarchy

System.Object
  GSF.Parsing.BinaryImageBase
    GSF.PhasorProtocols.ChannelBase
      GSF.PhasorProtocols.ChannelFrameBase<IDataCell>
        GSF.PhasorProtocols.DataFrameBase
          More

Namespace: GSF.PhasorProtocols
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.239-beta

Syntax

C++

JavaScript

Copy

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

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

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

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type DataFrameBase = 
    class
        inherit ChannelFrameBase<IDataCell>
        interface IDataFrame
        interface IChannelFrame
        interface IChannel
        interface ISupportBinaryImage
        interface IFrame
        interface IEquatable<IFrame>
        interface IComparable<IFrame>
        interface IComparable
        interface ISerializable
    end

GSF.PhasorProtocols.DataFrameBase = function();

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

View Source

The DataFrameBase type exposes the following members.

Constructors

	Name	Description
	DataFrameBase(SerializationInfo, StreamingContext)	Creates a new DataFrameBase from serialization parameters.
	DataFrameBase(DataCellCollection, Ticks, IConfigurationFrame)	Creates a new DataFrameBase from specified parameters.

Top

Properties

	Name	Description
	AllowQueuedPublication	Gets flag that determines if frame image can be queued for publication or should be processed immediately. (Inherited from ChannelFrameBase<T>)
	Attributes	Dictionary<TKey, TValue> of string based property names and values for the ChannelFrameBase<T> object. (Inherited from ChannelFrameBase<T>)
	BinaryImage	Gets the binary image of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	BinaryLength	Gets the length of the BinaryImage. (Inherited from ChannelFrameBase<T>)
	BodyImage	Gets the binary body image of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	BodyLength	Gets the length of the BodyImage. (Inherited from ChannelFrameBase<T>)
	Cells	Gets reference to the DataCellCollection for this DataFrameBase.
	Checksum	Gets calculated checksum for this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	ConfigurationFrame	Gets or sets IConfigurationFrame associated with this DataFrameBase.
	CreatedTimestamp	Gets timestamp, in ticks, of when this ChannelFrameBase<T> was created. (Inherited from ChannelFrameBase<T>)
	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 ChannelFrameBase<T>.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 ChannelFrameBase<T>.IDCode)
	LastSortedMeasurement	Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	Lifespan	Gets the life-span of this ChannelFrameBase<T> since its creation. (Inherited from ChannelFrameBase<T>)
	Measurements	Keyed measurements in this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	ParsedBinaryLength	Gets the parsed binary length derived from the parsing state, if any. (Inherited from ChannelFrameBase<T>)
	Published	Gets or sets published state of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	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 ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	Source	Gets or sets the data source identifier for this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	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 ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	TimeTag	Gets UNIX based time representation of the ticks of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	TrustHeaderLength	Gets or sets flag that determines if header lengths should be trusted over parsed byte count. (Inherited from ChannelFrameBase<T>)
	ValidateCheckSum	Gets or sets flag that determines if frame's check-sum should be validated - this should normally be left as true. (Inherited from ChannelFrameBase<T>)

Top

Methods

	Name	Description
	AppendChecksum	Appends checksum onto buffer starting at startIndex. (Inherited from ChannelFrameBase<T>)
	CalculateChecksum	Calculates checksum of given buffer. (Inherited from ChannelFrameBase<T>)
	ChecksumIsValid	Determines if checksum in the buffer is valid. (Inherited from ChannelFrameBase<T>)
	CompareTo(IFrame)	Compares the ChannelFrameBase<T> with an IFrame. (Inherited from ChannelFrameBase<T>)
	CompareTo(Object)	Compares the ChannelFrameBase<T> with the specified Object. (Inherited from ChannelFrameBase<T>)
	Equals(IFrame)	Determines whether the specified IFrame is equal to the current ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	Equals(Object)	Determines whether the specified Object is equal to the current ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	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	Generates the binary body image and copies it into the given buffer, for BodyLength bytes. (Inherited from BinaryImageBase)
	GenerateFooterImage	Generates the binary footer image and copies it into the given buffer, for FooterLength bytes. (Inherited from BinaryImageBase)
	GenerateHeaderImage	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 ChannelFrameBase<T>)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides ChannelFrameBase<T>.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 ChannelFrameBase<T>.ParseBinaryImage(Byte[], Int32, Int32))
	ParseBodyImage	Parses the binary body image. (Inherited from ChannelFrameBase<T>)
	ParseFooterImage	Parses the binary footer image. (Inherited from BinaryImageBase)
	ParseHeaderImage	Parses the binary header image. (Inherited from BinaryImageBase)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	BinaryImage	Returns a binary image of an object that implements ISupportBinaryImage. (Defined by ISupportBinaryImageExtensions)
	CopyBinaryImageToStream	Copies binary image of object that implements ISupportBinaryImage to a Stream. (Defined by ISupportBinaryImageExtensions)
	CopyImage	This is a common optimized block copy function for any kind of data. (Defined by Common)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefault<T>	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)

Top

Reference

GSF.PhasorProtocols Namespace

Inheritance Hierarchy

System.Object
  GSF.Parsing.BinaryImageBase
    GSF.PhasorProtocols.ChannelBase
      GSF.PhasorProtocols.ChannelFrameBase<IDataCell>
        GSF.PhasorProtocols.DataFrameBase
          GSF.PhasorProtocols.BPAPDCstream.DataFrame
          GSF.PhasorProtocols.FNET.DataFrame
          GSF.PhasorProtocols.IEC61850_90_5.DataFrame
          GSF.PhasorProtocols.IEEE1344.DataFrame
          GSF.PhasorProtocols.IEEEC37_118.DataFrame
          GSF.PhasorProtocols.Macrodyne.DataFrame
          GSF.PhasorProtocols.SelFastMessage.DataFrame