|
Channel
|
Represents the common implementation of the protocol independent definition of any kind
of data that can be parsed or generated.
This is the base class of all parsing/generating classes in the phasor protocols library; it is the root of the parsing/generating class hierarchy.
This is the base class of all parsing/generating classes in the phasor protocols library; it is the root of the parsing/generating class hierarchy.
Inheritance Hierarchy
Namespace: GSF.PhasorProtocols
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.218-beta
Syntaxpublic abstract class ChannelBase : BinaryImageBase, IChannel, ISupportBinaryImage
The ChannelBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ChannelBase | Initializes a new instance of the ChannelBase class |
Properties| Name | Description | |
|---|---|---|
 | Attributes | Gets a DictionaryTKey, TValue of string based property names and values for this ChannelBase object. |
| BinaryImage | Gets the binary image of the ChannelBase object. |
| BinaryLength |
Gets the length of the BinaryImageBase object.
(Inherited from BinaryImageBase) |
 | BodyImage | Gets the binary body image of the ChannelBase object. |
| BodyLength |
Gets the length of the body portion of the BinaryImageBase object.
(Inherited from BinaryImageBase) |
| FooterImage | Gets the binary footer image of the BinaryImageBase object. |
| 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. |
| HeaderLength |
Gets the length of the header portion of the BinaryImageBase object.
(Inherited from BinaryImageBase) |
| State | Gets or sets the parsing state for this ChannelBase object. |
| Tag | Gets or sets a user definable reference to an object associated with this ChannelBase object. |
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.
(Overrides BinaryImageBaseGenerateBinaryImage(Byte, Int32)) |
| 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) |
| 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.
(Inherited from BinaryImageBase) |
| ParseFooterImage |
Parses the binary footer image.
(Inherited from BinaryImageBase) |
| ParseHeaderImage |
Parses the binary header image.
(Inherited from BinaryImageBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
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) |
Remarks
This base class represents IChannel data images for parsing or generation in
terms of a header, body and footer (see BinaryImageBase for details).
See AlsoReference
Inheritance Hierarchy