BinaryImageBase Class

Defines a base class that represents binary images for parsing or generation in terms of a header, body and footer.

Inheritance Hierarchy

SystemObject
GSF.ParsingBinaryImageBase
GSF.PhasorProtocolsChannelBase

Namespace: GSF.Parsing
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

[SerializableAttribute]
public abstract class BinaryImageBase : ISupportBinaryImage

<SerializableAttribute>
Public MustInherit Class BinaryImageBase
	Implements ISupportBinaryImage

[SerializableAttribute]
public ref class BinaryImageBase abstract : ISupportBinaryImage

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type BinaryImageBase = 
    class
        interface ISupportBinaryImage
    end

GSF.Parsing.BinaryImageBase = function();

Type.createClass(
	'GSF.Parsing.BinaryImageBase',
	null,
	GSF.Parsing.ISupportBinaryImage);

The BinaryImageBase type exposes the following members.

Constructors

	Name	Description
	BinaryImageBase	Initializes a new instance of the BinaryImageBase class

Properties

	Name	Description
	BinaryLength	Gets the length of the BinaryImageBase object.
	BodyLength	Gets the length of the body portion of the BinaryImageBase object.
	FooterLength	Gets the length of the footer portion of the BinaryImageBase object.
	HeaderLength	Gets the length of the header portion of the BinaryImageBase 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.
	GenerateBodyImage	Generates the binary body image and copies it into the given buffer, for BodyLength bytes.
	GenerateFooterImage	Generates the binary footer image and copies it into the given buffer, for FooterLength bytes.
	GenerateHeaderImage	Generates the binary header image and copies it into the given buffer, for HeaderLength bytes.
	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.
	ParseBodyImage	Parses the binary body image.
	ParseFooterImage	Parses the binary footer image.
	ParseHeaderImage	Parses the binary header image.
	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)