ChannelFrameBaseT Class

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

Definition

Namespace: Gemstone.PhasorProtocols
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.128 -- Release Build+dd7f32701ba80de4d5b0557e84e0ddc18a34573f
Inheritance
Object    BinaryImageBase    ChannelBase    ChannelFrameBaseT
Derived
Implements
ISupportBinaryImage, IChannel, IChannelFrame, IChannelFrameT, IFrame, IComparable, IComparableIFrame, IEquatableIFrame, ISerializable

Type Parameters

T
Specific IChannelCell type that the ChannelFrameBaseT contains.

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 ChannelFrameBaseT), 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.

Constructors

ChannelFrameBaseT(SerializationInfo, StreamingContext) Creates a new ChannelFrameBaseT from serialization parameters.
ChannelFrameBaseT(UInt16, IChannelCellCollectionT, Ticks) Creates a new ChannelFrameBaseT from specified parameters.

Properties

AllowQueuedPublication Gets flag that determines if frame image can be queued for publication or should be processed immediately.
AttributesDictionaryTKey, TValue of string based property names and values for the ChannelFrameBaseT object.
(Overrides ChannelBaseAttributes)
BinaryImage Gets the binary image of this ChannelFrameBaseT.
(Overrides ChannelBaseBinaryImage)
BinaryLength Gets the length of the BinaryImage.
(Overrides BinaryLength)
BodyImage Gets the binary body image of this ChannelFrameBaseT.
(Overrides ChannelBaseBodyImage)
BodyLength Gets the length of the BodyImage.
(Overrides BodyLength)
Cells Gets the strongly-typed reference to the collection of cells for this ChannelFrameBaseT.
Checksum Gets calculated checksum for this ChannelFrameBaseT.
CreatedTimestamp Gets timestamp, in ticks, of when this ChannelFrameBaseT 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 ChannelFrameBaseT.
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 ChannelFrameBaseT.
LastSortedMeasurement Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBaseT.
Lifespan Gets the life-span of this ChannelFrameBaseT since its creation.
Measurements Keyed measurements in this ChannelFrameBaseT.
ParsedBinaryLength Gets the parsed binary length derived from the parsing state, if any.
Published Gets or sets published state of this ChannelFrameBaseT.
SortedMeasurements Gets or sets total number of measurements that have been sorted into this ChannelFrameBaseT.
Source Gets or sets the data source identifier for this ChannelFrameBaseT.
State Gets or sets the parsing state for the this ChannelFrameBaseT.
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.
TimeTag Gets UNIX based time representation of the ticks of this ChannelFrameBaseT.
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.

Methods

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 ChannelFrameBaseT with an IFrame.
CompareTo(Object) Compares the ChannelFrameBaseT with the specified Object.
Equals(IFrame) Determines whether the specified IFrame is equal to the current ChannelFrameBaseT.
Equals(Object) Determines whether the specified Object is equal to the current ChannelFrameBaseT.
(Overrides ObjectEquals(Object))
FinalizeAllows 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.
(Overrides ObjectGetHashCode)
GetObjectData Populates a SerializationInfo with the data needed to serialize the target object.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ParseBinaryImage Parses the binary image.
(Overrides ParseBinaryImage(Byte[], Int32, Int32))
ParseBodyImage Parses the binary body image.
(Overrides ParseBodyImage(Byte[], Int32, Int32))
ParseFooterImage(Byte[], Int32, Int32) Parses the binary footer image.
(Inherited from BinaryImageBase)
ParseHeaderImage(Byte[], Int32, Int32) Parses the binary header image.
(Inherited from BinaryImageBase)
ToStringReturns 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