Click or drag to resize

ISupportSourceIdentifiableFrameImageTSourceIdentifier, TTypeIdentifier Interface
Specifies that this Type can produce or consume a frame of data represented as a binary image that can be identified by its data source.

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

Type Parameters

TSourceIdentifier
Type of identifier for the data source.
TTypeIdentifier
Type of the frame identifier.

The ISupportSourceIdentifiableFrameImageTSourceIdentifier, TTypeIdentifier 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.
(Inherited from ISupportFrameImageTTypeIdentifier)
Public propertyBinaryLength Gets the length of the binary image.
(Inherited from ISupportBinaryImage)
Public propertyCommonHeader Gets or sets current ICommonHeaderTTypeIdentifier.
(Inherited from ISupportFrameImageTTypeIdentifier)
Public propertySource Gets or sets the data source identifier of the frame image.
Public propertyTypeID Gets the identifier that can be used for identifying the Type.
(Inherited from ISupportFrameImageTTypeIdentifier)
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 MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType class.
See Also