Represents the IEEE 1344 implementation of a IHeaderFrame that can be sent or received.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class HeaderFrame : HeaderFrameBase, ISupportFrameImage<FrameType>, ISupportBinaryImage
<SerializableAttribute> _ Public Class HeaderFrame _ Inherits HeaderFrameBase _ Implements ISupportFrameImage(Of FrameType), ISupportBinaryImage
[SerializableAttribute] public ref class HeaderFrame : public HeaderFrameBase, ISupportFrameImage<FrameType>, ISupportBinaryImage
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | HeaderFrame()()()() |
Creates a new HeaderFrame.
|
 | HeaderFrame(SerializationInfo, StreamingContext) |
Creates a new HeaderFrame from serialization parameters.
|
| AppendChecksum(array<Byte>[]()[][], Int32) |
Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
 | Attributes | Dictionary<(Of <(<'TKey, TValue>)>)> of string based property names and values for the HeaderFrame object.
(Overrides HeaderFrameBase.Attributes.) |
| BinaryImage |
Gets the binary image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| BinaryLength |
Gets the length of the BinaryImage.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
 | BodyImage |
Gets the binary body image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| BodyLength |
Gets the length of the BodyImage.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| CalculateChecksum(array<Byte>[]()[][], Int32, Int32) |
Calculates checksum of given buffer.
(Overrides ChannelFrameBase<(Of <(<'IHeaderCell>)>)>.CalculateChecksum(array<Byte>[]()[][], Int32, Int32).) |
| Cells |
Gets reference to the HeaderCellCollection for this HeaderFrameBase.
(Inherited from HeaderFrameBase.) |
| ChecksumIsValid(array<Byte>[]()[][], Int32) |
Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| CommonHeader |
Gets or sets current CommonFrameHeader.
|
| CompareTo(IFrame) |
Compares the ChannelFrameBase<(Of <(<'T>)>)> with an IFrame.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| CompareTo(Object) |
Compares the ChannelFrameBase<(Of <(<'T>)>)> with the specified Object.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| 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>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| Equals(Object) |
Determines whether the specified Object is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| 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 HeaderFrameBase.
(Inherited from HeaderFrameBase.) |
| GetHashCode()()()() |
Returns the hash code for this instance.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| GetObjectData(SerializationInfo, StreamingContext) |
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides ChannelFrameBase<(Of <(<'IHeaderCell>)>)>.GetObjectData(SerializationInfo, StreamingContext).) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| HeaderData |
Gets or sets header data for this HeaderFrameBase.
(Inherited from HeaderFrameBase.) |
| HeaderImage |
Gets the binary header image of the HeaderFrame object.
(Overrides BinaryImageBase.HeaderImage()()()().) |
| HeaderLength |
Gets the length of the HeaderImage.
(Overrides BinaryImageBase.HeaderLength()()()().) |
| IDCode |
Gets or sets the ID code of this HeaderFrame.
|
| Initialize(array<Byte>[]()[][], Int32, Int32) |
Parses the binary image.
(Overrides ChannelFrameBase<(Of <(<'IHeaderCell>)>)>.Initialize(array<Byte>[]()[][], Int32, Int32).) |
| LastSortedMeasurement |
Gets ot sets reference to last IMeasurement that was sorted into this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| Measurements |
Keyed measurements in this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from 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.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| ParsedBinaryLength |
Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| ParseFooterImage(array<Byte>[]()[][], Int32, Int32) | (Inherited from BinaryImageBase.) |
| ParseHeaderImage(array<Byte>[]()[][], Int32, Int32) |
Parses the binary header image.
(Overrides BinaryImageBase.ParseHeaderImage(array<Byte>[]()[][], Int32, Int32).) |
| Published |
Gets or sets published state of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| PublishedTimestamp |
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was published (post-processing).
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| ReceivedTimestamp |
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was received (i.e., created).
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| SortedMeasurements |
Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| State |
Gets or sets the parsing state for the this HeaderFrameBase.
(Inherited from HeaderFrameBase.) |
| 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 HeaderFrame.
(Overrides ChannelFrameBase<(Of <(<'IHeaderCell>)>)>.Timestamp.) |
| TimeTag |
Gets the timestamp of this frame in NTP format.
|
| ToString()()()() | (Inherited from Object.) |
| TypeID |
Gets the identifier that is used to identify the IEEE 1344 frame.
|
Inheritance Hierarchy| Object | |||||
 | BinaryImageBase | ||||
| ChannelBase | ||||
| ChannelFrameBase<(Of <(<'IHeaderCell>)>)> | ||||
| HeaderFrameBase | ||||
| HeaderFrame | ||||