Click or drag to resize

ISupportFrameImageTTypeIdentifier Interface

Specifies that this Type can produce or consume a frame of data represented as a binary image.

Namespace: GSF.Parsing
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax
public interface ISupportFrameImage<TTypeIdentifier> : ISupportBinaryImage

Type Parameters

TTypeIdentifier
Type of the frame identifier.

The ISupportFrameImageTTypeIdentifier type exposes the following members.

Properties
 NameDescription
Public propertyAllowQueuedPublication Gets flag that determines if frame image can queued for publication or should be processed immediately.
Public propertyBinaryLength Gets the length of the binary image.
(Inherited from ISupportBinaryImage)
Public propertyCommonHeader Gets or sets current ICommonHeaderTTypeIdentifier.
Public propertyTypeID Gets the identifier that can be used for identifying the Type.
Top
Methods
 NameDescription
Public methodGenerateBinaryImage Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.
(Inherited from ISupportBinaryImage)
Public methodParseBinaryImage Initializes object by parsing the specified buffer containing a binary image.
(Inherited from ISupportBinaryImage)
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 MethodParseBinaryImageFromStream Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions)
Top
Remarks
Related types of protocol data that occur as frames in a stream can implement this interface for automated parsing via the FrameImageParserBaseTTypeIdentifier, TOutputType class.
See Also