|
ISupport
|
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.218-beta+101eee949414e414795e55a6e73d88938f0177b8
Syntaxpublic interface ISupportFrameImage<TTypeIdentifier> : ISupportBinaryImage
Type Parameters
- TTypeIdentifier
- Type of the frame identifier.
The ISupportFrameImageTTypeIdentifier type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowQueuedPublication | Gets flag that determines if frame image can queued for publication or should be processed immediately. |
| BinaryLength |
Gets the length of the binary image.
(Inherited from ISupportBinaryImage) |
| CommonHeader | Gets or sets current ICommonHeaderTTypeIdentifier. |
| TypeID | Gets the identifier that can be used for identifying the Type. |
Methods| Name | Description | |
|---|---|---|
 | GenerateBinaryImage |
Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.
(Inherited from ISupportBinaryImage) |
| ParseBinaryImage |
Initializes object by parsing the specified buffer containing a binary image.
(Inherited from ISupportBinaryImage) |
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) |
| ParseBinaryImageFromStream |
Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions) |
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