ChannelFrameBase<T> Class

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

Inheritance Hierarchy

System.Object
  GSF.Parsing.BinaryImageBase
    GSF.PhasorProtocols.ChannelBase
      GSF.PhasorProtocols.ChannelFrameBase<T>
        GSF.PhasorProtocols.CommandFrameBase
        GSF.PhasorProtocols.ConfigurationFrameBase
        GSF.PhasorProtocols.DataFrameBase
        GSF.PhasorProtocols.HeaderFrameBase

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public abstract class ChannelFrameBase<T> : ChannelBase, 
	IChannelFrame<T>, IChannelFrame, IChannel, ISupportBinaryImage, IFrame, 
	IEquatable<IFrame>, IComparable<IFrame>, IComparable, 
	ISerializable
where T : IChannelCell

<SerializableAttribute>
Public MustInherit Class ChannelFrameBase(Of T As IChannelCell)
	Inherits ChannelBase
	Implements IChannelFrame(Of T), IChannelFrame, IChannel, 
	ISupportBinaryImage, IFrame, IEquatable(Of IFrame), IComparable(Of IFrame), 
	IComparable, ISerializable

[SerializableAttribute]
generic<typename T>
where T : IChannelCell
public ref class ChannelFrameBase abstract : public ChannelBase, 
	IChannelFrame<T>, IChannelFrame, IChannel, ISupportBinaryImage, IFrame, 
	IEquatable<IFrame^>, IComparable<IFrame^>, IComparable, 
	ISerializable

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type ChannelFrameBase<'T when 'T : IChannelCell> = 
    class
        inherit ChannelBase
        interface IChannelFrame<'T>
        interface IChannelFrame
        interface IChannel
        interface ISupportBinaryImage
        interface IFrame
        interface IEquatable<IFrame>
        interface IComparable<IFrame>
        interface IComparable
        interface ISerializable
    end

JavaScript does not support generic types or methods.

View Source

Type Parameters

T: Specific IChannelCell type that the ChannelFrameBase<T> contains.

The ChannelFrameBase<T> type exposes the following members.

Constructors

	Name	Description
	ChannelFrameBase<T>(SerializationInfo, StreamingContext)	Creates a new ChannelFrameBase<T> from serialization parameters.
	ChannelFrameBase<T>(UInt16, IChannelCellCollection<T>, Ticks)	Creates a new ChannelFrameBase<T> 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.
	Attributes	Dictionary<TKey, TValue> of string based property names and values for the ChannelFrameBase<T> object. (Overrides ChannelBase.Attributes)
	BinaryImage	Gets the binary image of this ChannelFrameBase<T>. (Overrides ChannelBase.BinaryImage)
	BinaryLength	Gets the length of the BinaryImage. (Overrides BinaryImageBase.BinaryLength)
	BodyImage	Gets the binary body image of this ChannelFrameBase<T>. (Overrides ChannelBase.BodyImage)
	BodyLength	Gets the length of the BodyImage. (Overrides BinaryImageBase.BodyLength)
	Cells	Gets the strongly-typed reference to the collection of cells for this ChannelFrameBase<T>.
	Checksum	Gets calculated checksum for this ChannelFrameBase<T>.
	CreatedTimestamp	Gets timestamp, in ticks, of when this ChannelFrameBase<T> was created.
	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 ChannelFrameBase<T>.
	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 or sets the ID code of this ChannelFrameBase<T>.
	LastSortedMeasurement	Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBase<T>.
	Lifespan	Gets the life-span of this ChannelFrameBase<T> since its creation.
	Measurements	Keyed measurements in this ChannelFrameBase<T>.
	ParsedBinaryLength	Gets the parsed binary length derived from the parsing state, if any.
	Published	Gets or sets published state of this ChannelFrameBase<T>.
	SortedMeasurements	Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<T>.
	Source	Gets or sets the data source identifier for this ChannelFrameBase<T>.
	State	Gets or sets the parsing state for the this ChannelFrameBase<T>.
	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>.
	TimeTag	Gets UNIX based time representation of the ticks of this ChannelFrameBase<T>.
	TrustHeaderLength	Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
	ValidateCheckSum	Gets or sets flag that determines if frame's check-sum should be validated - this should normally be left as true.

Top

Methods

	Name	Description
	AppendChecksum	Appends checksum onto buffer starting at startIndex.
	CalculateChecksum	Calculates checksum of given buffer.
	ChecksumIsValid	Determines if checksum in the buffer is valid.
	CompareTo(IFrame)	Compares the ChannelFrameBase<T> with an IFrame.
	CompareTo(Object)	Compares the ChannelFrameBase<T> with the specified Object.
	Equals(IFrame)	Determines whether the specified IFrame is equal to the current ChannelFrameBase<T>.
	Equals(Object)	Determines whether the specified Object is equal to the current ChannelFrameBase<T>. (Overrides Object.Equals(Object))
	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. (Overrides Object.GetHashCode())
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	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 BinaryImageBase.ParseBinaryImage(Byte[], Int32, Int32))
	ParseBodyImage	Parses the binary body image. (Overrides BinaryImageBase.ParseBodyImage(Byte[], Int32, Int32))
	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

Remarks

This phasor protocol implementation defines a "frame" as a collection of cells (logical units of data). For example, a DataCellBase could be defined as a PMU within a frame of data, a DataFrameBase (derived from ChannelFrameBase<T>), that contains multiple PMU's coming from a PDC.

This class implements the IFrame interface so it can be cooperatively integrated into measurement concentration. For more information see the ConcentratorBase class.

Reference

GSF.PhasorProtocols Namespace