Protocol independent frame parser.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public sealed class MultiProtocolFrameParser : IFrameParser, IProvideStatus, IDisposable
Public NotInheritable Class MultiProtocolFrameParser _ Implements IFrameParser, IProvideStatus, IDisposable
public ref class MultiProtocolFrameParser sealed : IFrameParser, IProvideStatus, IDisposable
Members| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
 | MultiProtocolFrameParser()()()() |
Creates a new MultiProtocolFrameParser using the default settings.
|
 | AllowedParsingExceptions |
Gets or sets number of parsing exceptions allowed during ParsingExceptionWindow before connection is reset.
|
| AutoRepeatCapturedPlayback |
Gets or sets a flag that determines if a file used for replaying data should be restarted at the beginning once it has been completed.
|
| AutoStartDataParsingSequence |
Gets or sets flag to automatically send the ConfigFrame2 and EnableRealTimeData command frames used to start a typical data parsing sequence.
|
| BitRate |
Gets the calculated bit rate (i.e., bits per second (bps)) based on data received from device connection.
|
| BufferSize |
Gets or sets the size of the buffer used by the MultiProtocolFrameParser for sending and receiving data from a device.
|
| ByteRate |
Gets the calculated byte rate (i.e., bytes per second) based on data received from device connection.
|
| CalculatedFrameRate |
Gets the calculated frame rate (i.e., frames per second) based on data received from device connection.
|
 | ConfigurationChanged |
Occurs when a device sends a notification that its configuration has changed.
|
| ConfigurationFrame |
Gets or sets current IConfigurationFrame used for parsing IDataFrame's encountered in the data stream from a device.
|
| ConfiguredFrameRate |
Gets the configured frame rate as reported by the connected device.
|
| ConnectionAttempt |
Occurs when MultiProtocolFrameParser is attempting connection to a device.
|
| ConnectionEstablished |
Occurs when MultiProtocolFrameParser has established a connection to a device.
|
| ConnectionException |
Occurs when an Exception is encountered during connection attempt to a device.
|
| ConnectionParameters |
Gets or sets any connection specific IConnectionParameters that may be applicable for the current PhasorProtocol.
|
| ConnectionString |
Gets or sets the key/value pair based connection information required by the MultiProtocolFrameParser to connect to a device.
|
| ConnectionTerminated |
Occurs when device connection has been terminated.
|
| ConnectionTime |
Gets total time connection has been active.
|
| ConnectionType |
Gets the connection type (Active, Passive or Hybrid) based on defined channels and transport selections.
|
| DataChannelIsServerBased |
Gets a boolean value that determines if data channel is defined as a server based connection.
|
  | DefaultAllowedParsingExceptions |
Specfies the default value for the AllowedParsingExceptions property.
|
| DefaultAutoStartDataParsingSequence |
Specifies the default value for the AutoStartDataParsingSequence property.
|
| DefaultBufferSize |
Specifies the default value for the BufferSize property.
|
| DefaultDefinedFrameRate |
Specifies the default value for the DefinedFrameRate property.
|
| DefaultMaximumConnectionAttempts |
Specifies the default value for the MaximumConnectionAttempts property.
|
| DefaultParsingExceptionWindow |
Specifies the default value for the ParsingExceptionWindow property.
|
| DefinedFrameRate |
Gets or sets desired frame rate to use for maintaining captured frame replay timing.
|
| DeviceID |
Gets or sets the device identification code often needed to establish a connection.
|
| DeviceSupportsCommands |
Gets or sets flag that determines if a device supports commands.
|
| Dispose()()()() |
Releases all the resources used by the MultiProtocolFrameParser object.
|
| Enabled |
Gets or sets a boolean value that indicates whether the MultiProtocolFrameParser is currently enabled.
|
| Equals(Object) | (Inherited from Object.) |
| ExceededParsingExceptionThreshold |
Occurs when number of parsing exceptions exceed AllowedParsingExceptions during ParsingExceptionWindow.
|
| ExecuteParseOnSeparateThread |
Gets or sets a flag that allows frame parsing to be executed on a separate thread (i.e., other than communications thread).
|
 | Finalize()()()() |
Releases the unmanaged resources before the MultiProtocolFrameParser object is reclaimed by GC.
(Overrides Object.Finalize()()()().) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| InjectSimulatedTimestamp |
Gets or sets flag indicating whether or not to inject local system time into parsed data frames.
|
| IsConnected |
Gets a flag that determines if the currently selected TransportProtocol is connected.
|
| IsIEEEProtocol |
Gets a flag that determines if the currently selected PhasorProtocol is an IEEE standard protocol.
|
| MaximumConnectionAttempts |
Gets or sets the maximum number of times the MultiProtocolFrameParser will attempt to connect to a device.
|
| MegaBitRate |
Gets the calculated megabits per second (Mbps) rate based on data received from device connection.
|
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| Name |
Gets a descriptive name for a device connection that includes SourceName, if provided.
|
| ParsingException |
Occurs when an Exception is encountered while parsing the data stream.
|
| ParsingExceptionWindow |
Gets or sets time duration, in Ticks, to monitor parsing exceptions.
|
| PhasorProtocol |
Gets or sets PhasorProtocol to use with this MultiProtocolFrameParser.
|
| QueuedBuffers |
Gets the total number of buffers that are currently queued for processing, if any.
|
| ReceivedCommandFrame |
Occurs when a ICommandFrame has been received.
|
| ReceivedConfigurationFrame |
Occurs when a IConfigurationFrame has been received.
|
| ReceivedDataFrame |
Occurs when a IDataFrame has been received.
|
| ReceivedFrameBufferImage |
Occurs when a frame buffer image has been received.
|
| ReceivedHeaderFrame |
Occurs when a IHeaderFrame has been received.
|
| ReceivedUndeterminedFrame |
Occurs when an undetermined IChannelFrame has been received.
|
| SendDeviceCommand(DeviceCommand) |
Sends the specified DeviceCommand to the remote device.
|
| SentCommandFrame |
Occurs when a ICommandFrame is sent to a device.
|
| ServerStarted |
Occurs when the MultiProtocolFrameParser is setup as a listening connection and server connection has been started.
|
| ServerStopped |
Occurs when the MultiProtocolFrameParser is setup as a listening connection and server connection has been stopped.
|
| SkipDisableRealTimeData |
Gets or sets flag to skip automatic disabling of the real-time data stream on shutdown or startup.
|
| SourceName |
Gets or sets a descriptive name for a device connection.
|
| Start()()()() |
Starts the MultiProtocolFrameParser.
|
| Status |
Gets current descriptive status of the MultiProtocolFrameParser.
|
| Stop()()()() |
Stops the MultiProtocolFrameParser.
|
| ToString()()()() | (Inherited from Object.) |
| TotalBytesReceived |
Gets total number of bytes that have been received from a device so far.
|
| TotalCrcExceptions |
Gets total number of CRC exceptions encountered from device so far.
|
| TotalFramesReceived |
Gets total number of frames that have been received from a device so far.
|
| TotalMissingFrames |
Gets total number of frames that were missing from device so far.
|
| TransportProtocol |
Gets or sets TransportProtocol to use with this MultiProtocolFrameParser.
|
| UseHighResolutionInputTimer |
Gets or sets flag that determines if a high-resolution precision timer should be used for file based input.
|
| Write(array<Byte>[]()[][], Int32, Int32) |
Writes data directly to the frame parsing engine buffer.
|
Remarks
This class takes all protocol frame parsing implementations and reduces them to a single simple-to-use class exposing all
data through abstract interfaces (e.g., IConfigurationFrame, IDataFrame, etc.) - this way new protocol implementations can
be added without adversely affecting consuming code. Additionally, this class implements a variety of transport options
(e.g., TCP, UDP, Serial, etc.) and hides the complexities of this connectivity and internally pushes all data received from
the selected transport protocol to the selected phasor parsing protocol.
Inheritance Hierarchy| Object | |
 | MultiProtocolFrameParser |