DataFrame Class

Represents the IEC 61850-90-5 implementation of a IDataFrame that can be sent or received.

Inheritance Hierarchy

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

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

Syntax

C++

JavaScript

Copy

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

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

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

[<SerializableAttribute>]
type DataFrame = 
    class
        inherit DataFrameBase
        interface ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>
        interface ISupportFrameImage<FrameType>
        interface ISupportBinaryImage
    end

GSF.PhasorProtocols.IEC61850_90_5.DataFrame = function();

Type.createClass(
	'GSF.PhasorProtocols.IEC61850_90_5.DataFrame',
	GSF.PhasorProtocols.DataFrameBase,
	GSF.Parsing.ISupportSourceIdentifiableFrameImage`2,
	GSF.Parsing.ISupportFrameImage`1,
	GSF.Parsing.ISupportBinaryImage);

View Source

The DataFrame type exposes the following members.

Constructors

	Name	Description
	DataFrame()	Creates a new DataFrame.
	DataFrame(SerializationInfo, StreamingContext)	Creates a new DataFrame from serialization parameters.
	DataFrame(Ticks, ConfigurationFrame, String, Int32, Byte[][], UInt32)	Creates a new DataFrame 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 DataFrame object. (Overrides ChannelFrameBase<T>.Attributes)
	BinaryImage	Gets the binary image of this DataFrame object. (Overrides ChannelFrameBase<T>.BinaryImage)
	BinaryLength	Gets the length of the BinaryImage. (Overrides ChannelFrameBase<T>.BinaryLength)
	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 DataFrame.
	Checksum	Gets calculated checksum for this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	CommonHeader	Gets or sets current CommonFrameHeader.
	ConfigurationFrame	Gets or sets ConfigurationFrame associated with this DataFrame.
	CreatedTimestamp	Gets timestamp, in ticks, of when this ChannelFrameBase<T> was created. (Inherited from ChannelFrameBase<T>)
	FooterImage	Gets the binary footer image of the DataFrame object. (Overrides ChannelBase.FooterImage)
	FooterLength	Gets the length of the FooterImage. (Overrides BinaryImageBase.FooterLength)
	FrameType	Gets the FundamentalFrameType for this DataFrameBase. (Inherited from DataFrameBase)
	HeaderImage	Gets the binary header image of the DataFrame object. (Overrides ChannelBase.HeaderImage)
	HeaderLength	Gets the length of the header image. (Overrides BinaryImageBase.HeaderLength)
	IDCode	Gets or sets the ID code. (Overrides DataFrameBase.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 DataFrame. (Overrides DataFrameBase.QualityFlags)
	SampleCount	Gets or sets sample count for the DataFrame.
	SampleSynchronization	Gets or sets IEC 61850-90-5 sample synchronization state.
	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. (Inherited from DataFrameBase)
	Tag	Gets or sets a user definable reference to an object associated with this ChannelBase object. (Inherited from ChannelBase)
	TimeQualityFlags	Gets or sets the TimeQualityFlags associated with this DataFrame.
	TimeQualityIndicatorCode	Gets or sets the TimeQualityIndicatorCode associated with this DataFrame.
	Timestamp	Gets or sets exact timestamp, in ticks, of the data represented by this DataFrame. (Overrides ChannelFrameBase<T>.Timestamp)
	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>)
	TypeID	Gets the identifier that is used to identify the IEC 61850-90-5 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 ChannelFrameBase<T>)

Top

Methods

	Name	Description
	AppendChecksum	Appends checksum onto buffer starting at startIndex. (Inherited from ChannelFrameBase<T>)
	CalculateChecksum	Calculates checksum of given buffer. (Overrides ChannelFrameBase<T>.CalculateChecksum(Byte[], Int32, Int32))
	ChecksumIsValid	Determines if checksum in the buffer is valid. (Overrides ChannelFrameBase<T>.ChecksumIsValid(Byte[], Int32))
	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 DataFrameBase.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 DataFrameBase.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.IEC61850_90_5 Namespace