openPDC Synchrophasor Help
ChannelFrameBase<(Of <(<'T>)>)> Class
NamespacesTVA.PhasorProtocolsChannelFrameBase<(Of <(<'T>)>)>
Represents the protocol independent common implementation of any frame of data that can be sent or received.
Declaration Syntax
C#Visual BasicVisual C++
[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
Generic Template Parameters
T
Specific IChannelCell type that the ChannelFrameBase<(Of <(<'T>)>)> contains.
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
ChannelFrameBase<(Of <(<'T>)>)>(UInt16, IChannelCellCollection<(Of <<'(T>)>>), Ticks)
Creates a new ChannelFrameBase<(Of <(<'T>)>)> from specified parameters.

ChannelFrameBase<(Of <(<'T>)>)>(SerializationInfo, StreamingContext)
Creates a new ChannelFrameBase<(Of <(<'T>)>)> from serialization parameters.

AppendChecksum(array<Byte>[]()[][], Int32)
Appends checksum onto buffer starting at startIndex.

Attributes
Dictionary<(Of <(<'TKey, TValue>)>)> of string based property names and values for the ChannelFrameBase<(Of <(<'T>)>)> object.
(Overrides ChannelBase.Attributes.)
BinaryImage
Gets the binary image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Overrides BinaryImageBase.BinaryImage()()()().)
BinaryLength
Gets the length of the BinaryImage.
(Overrides BinaryImageBase.BinaryLength()()()().)
BodyImage
Gets the binary body image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Overrides BinaryImageBase.BodyImage()()()().)
BodyLength
Gets the length of the BodyImage.
(Overrides BinaryImageBase.BodyLength()()()().)
CalculateChecksum(array<Byte>[]()[][], Int32, Int32)
Calculates checksum of given buffer.

Cells
Gets the strongly-typed reference to the collection of cells for this ChannelFrameBase<(Of <(<'T>)>)>.

ChecksumIsValid(array<Byte>[]()[][], Int32)
Determines if checksum in the buffer is valid.

CompareTo(IFrame)
Compares the ChannelFrameBase<(Of <(<'T>)>)> with an IFrame.

CompareTo(Object)
Compares the ChannelFrameBase<(Of <(<'T>)>)> with the specified Object.

CopyImage(ISupportBinaryImage, array<Byte>[]()[][], Int32%)
This is a common optimized block copy function for any kind of data.
(Inherited from Common.)
Equals(IFrame)
Determines whether the specified IFrame is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.

Equals(Object)
Determines whether the specified Object is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.
(Overrides Object.Equals(Object).)
Finalize()()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
FooterImage()()()() (Inherited from BinaryImageBase.)
FooterLength()()()() (Inherited from BinaryImageBase.)
FrameType
Gets the FundamentalFrameType for this ChannelFrameBase<(Of <(<'T>)>)>.

GetHashCode()()()()
Returns the hash code for this instance.
(Overrides Object.GetHashCode()()()().)
GetObjectData(SerializationInfo, StreamingContext)
Populates a SerializationInfo with the data needed to serialize the target object.

GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
HeaderImage()()()() (Inherited from BinaryImageBase.)
HeaderLength()()()() (Inherited from BinaryImageBase.)
IDCode
Gets or sets the ID code of this ChannelFrameBase<(Of <(<'T>)>)>.

Initialize(array<Byte>[]()[][], Int32, Int32)
Parses the binary image.
(Overrides BinaryImageBase.Initialize(array<Byte>[]()[][], Int32, Int32).)
LastSortedMeasurement
Gets ot sets reference to last IMeasurement that was sorted into this ChannelFrameBase<(Of <(<'T>)>)>.

Measurements
Keyed measurements in this ChannelFrameBase<(Of <(<'T>)>)>.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
ParseBodyImage(array<Byte>[]()[][], Int32, Int32)
Parses the binary body image.
(Overrides BinaryImageBase.ParseBodyImage(array<Byte>[]()[][], Int32, Int32).)
ParsedBinaryLength
Gets the parsed binary length derived from the parsing state, if any.

ParseFooterImage(array<Byte>[]()[][], Int32, Int32) (Inherited from BinaryImageBase.)
ParseHeaderImage(array<Byte>[]()[][], Int32, Int32) (Inherited from BinaryImageBase.)
Published
Gets or sets published state of this ChannelFrameBase<(Of <(<'T>)>)>.

PublishedTimestamp
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was published (post-processing).

ReceivedTimestamp
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was received (i.e., created).

SortedMeasurements
Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<(Of <(<'T>)>)>.

State
Gets or sets the parsing state for the this ChannelFrameBase<(Of <(<'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<(Of <(<'T>)>)>.

TimeTag
Gets UNIX based time representation of the ticks of this ChannelFrameBase<(Of <(<'T>)>)>.

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
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<(Of <(<'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.

Inheritance Hierarchy
Object
BinaryImageBase
 ChannelBase
  ChannelFrameBase<(Of <(<'T>)>)>
   CommandFrameBase
   ConfigurationFrameBase
   DataFrameBase
   HeaderFrameBase

Assembly: TVA.PhasorProtocols (Module: TVA.PhasorProtocols) Version: 1.4.192.0