IFrameImageParserTTypeIdentifier, TOutputType Interface

This interface represents a basic implementation of parsing functionality suitable for automating the parsing of a binary data stream represented as frames with common headers and returning the parsed data via an event.

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

Syntax

C++

JavaScript

Copy

public interface IFrameImageParser<TTypeIdentifier, TOutputType> : IBinaryImageParser, 
	IProvideStatus
where TOutputType : Object, ISupportFrameImage<TTypeIdentifier>

Public Interface IFrameImageParser(Of TTypeIdentifier, TOutputType As {Object, ISupportFrameImage(Of TTypeIdentifier)})
	Inherits IBinaryImageParser, IProvideStatus

generic<typename TTypeIdentifier, typename TOutputType>
where TOutputType : Object, ISupportFrameImage<TTypeIdentifier>
public interface class IFrameImageParser : IBinaryImageParser, 
	IProvideStatus

type IFrameImageParser<'TTypeIdentifier, 'TOutputType when 'TOutputType : Object and ISupportFrameImage<'TTypeIdentifier>> = 
    interface
        interface IBinaryImageParser
        interface IProvideStatus
    end

JavaScript does not support generic types or methods.

Type Parameters

TTypeIdentifier: Type of identifier used to distinguish output types.
TOutputType: Type of the interface or class used to represent outputs.

The IFrameImageParserTTypeIdentifier, TOutputType type exposes the following members.

Properties

	Name	Description
	Enabled	Gets or sets a boolean value that indicates whether the data parser is currently enabled. (Inherited from IBinaryImageParser)
	Name	Gets the name of the object providing status information. (Inherited from IProvideStatus)
	Status	Gets the current status details about object providing status information. (Inherited from IProvideStatus)
	TotalProcessedBuffers	Gets the total number of buffer images processed so far. (Inherited from IBinaryImageParser)

Top

Methods

	Name	Description
	Start	Start the streaming data parser. (Inherited from IBinaryImageParser)
	Stop	Stops the streaming data parser. (Inherited from IBinaryImageParser)
	Write	Writes a sequence of bytes onto the IBinaryImageParser stream for parsing. (Inherited from IBinaryImageParser)

Top

Events

	Name	Description
	DataDiscarded	Occurs when data image fails deserialization due to an exception. (Inherited from IBinaryImageParser)
	DataParsed	Occurs when a data image is deserialized successfully to one of the output types that the data image represents.
	OutputTypeNotFound	Occurs when matching a output type for deserializing the data image cound not be found.
	ParsingException	Occurs when an Exception is encountered while attempting to parse data. (Inherited from IBinaryImageParser)

Top

Reference

GSF.Parsing Namespace