HeaderCell Class

Represents the protocol independent common implementation of an element of header data for cells in a IHeaderFrame.

Inheritance Hierarchy

SystemObject
  GSF.ParsingBinaryImageBase
    GSF.PhasorProtocolsChannelBase
      GSF.PhasorProtocolsChannelCellBase
        GSF.PhasorProtocolsHeaderCell

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class HeaderCell : ChannelCellBase, IHeaderCell, 
	IChannelCell, IChannel, ISupportBinaryImage, ISerializable

<SerializableAttribute>
Public Class HeaderCell
	Inherits ChannelCellBase
	Implements IHeaderCell, IChannelCell, IChannel, ISupportBinaryImage, 
	ISerializable

[SerializableAttribute]
public ref class HeaderCell : public ChannelCellBase, 
	IHeaderCell, IChannelCell, IChannel, ISupportBinaryImage, ISerializable

[<SerializableAttribute>]
type HeaderCell = 
    class
        inherit ChannelCellBase
        interface IHeaderCell
        interface IChannelCell
        interface IChannel
        interface ISupportBinaryImage
        interface ISerializable
    end

GSF.PhasorProtocols.HeaderCell = function();

Type.createClass(
	'GSF.PhasorProtocols.HeaderCell',
	GSF.PhasorProtocols.ChannelCellBase,
	GSF.PhasorProtocols.IHeaderCell,
	GSF.PhasorProtocols.IChannelCell,
	GSF.PhasorProtocols.IChannel,
	GSF.Parsing.ISupportBinaryImage,
	ISerializable);

View Source

The HeaderCell type exposes the following members.

Constructors

	Name	Description
	HeaderCell(IHeaderFrame, Byte)	Creates a new HeaderCell from specified parameters.
	HeaderCell(SerializationInfo, StreamingContext)	Creates a new HeaderCell from serialization parameters.

Top

Properties

	Name	Description
	Attributes	DictionaryTKey, TValue of string based property names and values for the HeaderCell object. (Overrides ChannelCellBaseAttributes)
	BinaryImage	Gets the binary image of the ChannelBase object. (Inherited from ChannelBase)
	BinaryLength	Gets the length of the BinaryImageBase object. (Inherited from BinaryImageBase)
	BodyImage	Gets the binary body image of the HeaderCell object. (Overrides ChannelBaseBodyImage)
	BodyLength	Gets the length of the BodyImage. (Overrides BinaryImageBaseBodyLength)
	Character	Gets or sets ASCII character as a Byte that represents this HeaderCell.
	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)
	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 numeric ID code for this ChannelCellBase. (Inherited from ChannelCellBase)
	Parent	Gets or sets a reference to the parent ICommandFrame for this HeaderCell.
	State	Gets or sets the parsing state for the this ChannelCellBase. (Inherited from ChannelCellBase)
	Tag	Gets or sets a user definable reference to an object associated with this ChannelBase object. (Inherited from ChannelBase)

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from 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	Serves as the default hash function. (Inherited from Object)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides ChannelCellBaseGetObjectData(SerializationInfo, StreamingContext))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParseBinaryImage	Initializes object by parsing the specified buffer containing a binary image. (Inherited from BinaryImageBase)
	ParseBodyImage	Parses the binary body image. (Overrides BinaryImageBaseParseBodyImage(Byte, Int32, Int32))
	ParseFooterImage	Parses the binary footer image. (Inherited from BinaryImageBase)
	ParseHeaderImage	Parses the binary header image. (Inherited from BinaryImageBase)
	ToString	Gets the string representation of this ChannelCellBase. (Inherited from ChannelCellBase)

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)
	GetEnumValueOrDefaultT	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

Reference

GSF.PhasorProtocols Namespace