Click or drag to resize

HeaderFrame Class

Represents the IEEE C37.118 implementation of a IHeaderFrame that can be sent or received.
Inheritance Hierarchy
System.Object
  GSF.Parsing.BinaryImageBase
    GSF.PhasorProtocols.ChannelBase
      GSF.PhasorProtocols.ChannelFrameBase<IHeaderCell>
        GSF.PhasorProtocols.HeaderFrameBase
          GSF.PhasorProtocols.IEEEC37_118.HeaderFrame

Namespace: GSF.PhasorProtocols.IEEEC37_118
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.230-beta
Syntax

The HeaderFrame type exposes the following members.

Constructors
 NameDescription
Public methodHeaderFrame() Creates a new HeaderFrame.
Public methodHeaderFrame(String) Creates a new HeaderFrame.
Protected methodHeaderFrame(SerializationInfo, StreamingContext) Creates a new HeaderFrame from serialization parameters.
Top
Properties
 NameDescription
Public propertyAllowQueuedPublication Gets flag that determines if frame image can be queued for publication or should be processed immediately.
(Inherited from ChannelFrameBase<T>)
Public propertyAttributesDictionary<TKey, TValue> of string based property names and values for the HeaderFrame object.
(Overrides HeaderFrameBase.Attributes)
Public propertyBinaryImage Gets the binary image of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Public propertyBinaryLength Gets the length of the BinaryImage.
(Inherited from ChannelFrameBase<T>)
Protected propertyBodyImage Gets the binary body image of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Protected propertyBodyLength Gets the length of the BodyImage.
(Inherited from ChannelFrameBase<T>)
Public propertyCells Gets reference to the HeaderCellCollection for this HeaderFrameBase.
(Inherited from HeaderFrameBase)
Public propertyChecksum Gets calculated checksum for this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Public propertyCommonHeader Gets or sets current CommonFrameHeader.
Public propertyCreatedTimestamp Gets timestamp, in ticks, of when this ChannelFrameBase<T> was created.
(Inherited from ChannelFrameBase<T>)
Protected propertyFooterImage Gets the binary footer image of the BinaryImageBase object.
(Inherited from ChannelBase)
Protected propertyFooterLength Gets the length of the footer portion of the BinaryImageBase object.
(Inherited from BinaryImageBase)
Public propertyFrameType Gets the FundamentalFrameType for this HeaderFrameBase.
(Inherited from HeaderFrameBase)
Public propertyHeaderData Gets or sets header data for this HeaderFrameBase.
(Inherited from HeaderFrameBase)
Protected propertyHeaderImage Gets the binary header image of the HeaderFrame object.
(Overrides ChannelBase.HeaderImage)
Protected propertyHeaderLength Gets the length of the HeaderImage.
(Overrides BinaryImageBase.HeaderLength)
Public propertyIDCode Gets or sets the ID code.
(Overrides ChannelFrameBase<T>.IDCode)
Public propertyLastSortedMeasurement Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Public propertyLifespan Gets the life-span of this ChannelFrameBase<T> since its creation.
(Inherited from ChannelFrameBase<T>)
Public propertyMeasurements Keyed measurements in this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Protected propertyParsedBinaryLength Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBase<T>)
Public propertyPublished Gets or sets published state of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Public propertySortedMeasurements Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Public propertySource Gets or sets the data source identifier for this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Public propertyState Gets or sets the parsing state for the this HeaderFrameBase.
(Inherited from HeaderFrameBase)
Public propertyTag Gets or sets a user definable reference to an object associated with this ChannelBase object.
(Inherited from ChannelBase)
Public propertyTimeBase Gets the IEEE C37.118 timebase of this HeaderFrame.
Public propertyTimeQualityFlags Gets or sets the TimeQualityFlags associated with this HeaderFrame.
Public propertyTimeQualityIndicatorCode Gets or sets the TimeQualityIndicatorCode associated with this HeaderFrame.
Public propertyTimestamp Gets or sets exact timestamp, in ticks, of the data represented by this HeaderFrame.
(Overrides ChannelFrameBase<T>.Timestamp)
Public propertyTimeTag Gets UNIX based time representation of the ticks of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Public propertyTrustHeaderLength Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
(Inherited from ChannelFrameBase<T>)
Public propertyTypeID Gets the identifier that is used to identify the IEEE C37.118 frame.
Public propertyValidateCheckSum 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>)
Public propertyVersion Gets the IEEE C37.118 protocol version of this HeaderFrame.
Top
Methods
 NameDescription
Protected methodAppendChecksum Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBase<T>)
Protected methodCalculateChecksum Calculates checksum of given buffer.
(Overrides ChannelFrameBase<T>.CalculateChecksum(Byte[], Int32, Int32))
Protected methodChecksumIsValid Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBase<T>)
Public methodCompareTo(IFrame) Compares the ChannelFrameBase<T> with an IFrame.
(Inherited from ChannelFrameBase<T>)
Public methodCompareTo(Object) Compares the ChannelFrameBase<T> with the specified Object.
(Inherited from ChannelFrameBase<T>)
Public methodEquals(IFrame) Determines whether the specified IFrame is equal to the current ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Public methodEquals(Object) Determines whether the specified Object is equal to the current ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGenerateBinaryImage Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.
(Inherited from ChannelBase)
Protected methodGenerateBodyImage Generates the binary body image and copies it into the given buffer, for BodyLength bytes.
(Inherited from BinaryImageBase)
Protected methodGenerateFooterImage Generates the binary footer image and copies it into the given buffer, for FooterLength bytes.
(Inherited from BinaryImageBase)
Protected methodGenerateHeaderImage Generates the binary header image and copies it into the given buffer, for HeaderLength bytes.
(Inherited from BinaryImageBase)
Public methodGetHashCode Returns the hash code for this instance.
(Inherited from ChannelFrameBase<T>)
Public methodGetObjectData Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides ChannelFrameBase<T>.GetObjectData(SerializationInfo, StreamingContext))
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParseBinaryImage Parses the binary image.
(Inherited from ChannelFrameBase<T>)
Protected methodParseBodyImage Parses the binary body image.
(Inherited from ChannelFrameBase<T>)
Protected methodParseFooterImage Parses the binary footer image.
(Inherited from BinaryImageBase)
Protected methodParseHeaderImage Parses the binary header image.
(Overrides BinaryImageBase.ParseHeaderImage(Byte[], Int32, Int32))
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodBinaryImage Returns a binary image of an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions)
Public Extension MethodCopyBinaryImageToStream Copies binary image of object that implements ISupportBinaryImage to a Stream.
(Defined by ISupportBinaryImageExtensions)
Public Extension MethodCopyImage This is a common optimized block copy function for any kind of data.
(Defined by Common)
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefault<T> Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodParseBinaryImageFromStream Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions)
Top
See Also