Click or drag to resize

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.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
public interface IFrameImageParser<TTypeIdentifier, TOutputType> : IBinaryImageParser, 
	IProvideStatus
where TOutputType : Object, ISupportFrameImage<TTypeIdentifier>

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
 NameDescription
Public propertyEnabled Gets or sets a boolean value that indicates whether the data parser is currently enabled.
(Inherited from IBinaryImageParser)
Public propertyName Gets the name of the object providing status information.
(Inherited from IProvideStatus)
Public propertyStatus Gets the current status details about object providing status information.
(Inherited from IProvideStatus)
Public propertyTotalProcessedBuffers Gets the total number of buffer images processed so far.
(Inherited from IBinaryImageParser)
Top
Methods
 NameDescription
Public methodStart Start the streaming data parser.
(Inherited from IBinaryImageParser)
Public methodStop Stops the streaming data parser.
(Inherited from IBinaryImageParser)
Public methodWrite Writes a sequence of bytes onto the IBinaryImageParser stream for parsing.
(Inherited from IBinaryImageParser)
Top
Events
 NameDescription
Public eventDataDiscarded Occurs when data image fails deserialization due to an exception.
(Inherited from IBinaryImageParser)
Public eventDataParsed Occurs when a data image is deserialized successfully to one of the output types that the data image represents.
Public eventOutputTypeNotFound Occurs when matching a output type for deserializing the data image cound not be found.
Public eventParsingException Occurs when an Exception is encountered while attempting to parse data.
(Inherited from IBinaryImageParser)
Top
See Also