Grid Solutions Framework Documentation
GSF Namespaces
GSF.PhasorProtocols
MultiProtocolFrameParser Class
MultiProtocolFrameParser Properties
AllowedParsingExceptions Property
AutoRepeatCapturedPlayback Property
AutoStartDataParsingSequence Property
BitRate Property
BufferSize Property
ByteRate Property
CalculatedFrameRate Property
CheckSumValidationFrameTypes Property
CommandChannelServerUri Property
ConfigurationFrame Property
ConfigurationFrameVersion Property
ConfiguredFrameRate Property
ConnectionInfo Property
ConnectionIsListener Property
ConnectionIsMulticast Property
ConnectionParameters Property
ConnectionString Property
ConnectionTime Property
ConnectionType Property
DataChannelIsServerBased Property
DataChannelServerUri Property
DefinedFrameRate Property
DeviceID Property
DeviceSupportsCommands Property
DisableRealTimeDataOnStop Property
DisconnectAtEOF Property
Enabled Property
InjectSimulatedTimestamp Property
IsConnected Property
IsIEEEProtocol Property
KeepCommandChannelOpen Property
MaximumConnectionAttempts Property
MegaBitRate Property
Name Property
ParsingExceptionWindow Property
PhasorProtocol Property
QueuedBuffers Property
QueuedOutputs Property
RedundantFramesPerPacket Property
ReplayStartTime Property
ReplayStopTime Property
ServerIndex Property
SkipDisableRealTimeData Property
SourceName Property
Status Property
TotalBytesReceived Property
TotalCrcExceptions Property
TotalFramesReceived Property
TotalMissingFrames Property
TransportProtocol Property
TrustHeaderLength Property
UseHighResolutionInputTimer Property
Click or drag to resize

MultiProtocolFrameParser Properties

The MultiProtocolFrameParser type exposes the following members.

Properties
  Name Description
Public property AllowedParsingExceptions Gets or sets number of parsing exceptions allowed during ParsingExceptionWindow before connection is reset. Defaults to DefaultAllowedParsingExceptions.
Public property 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.
Public property AutoStartDataParsingSequence Gets or sets flag to automatically send the ConfigFrame2 and EnableRealTimeData command frames used to start a typical data parsing sequence. Defaults to DefaultAutoStartDataParsingSequence.
Public property BitRate Gets the calculated bit rate (i.e., bits per second (bps)) based on data received from device connection.
Public property BufferSize Gets or sets the size of the buffer used by the MultiProtocolFrameParser for sending and receiving data from a device.
Public property ByteRate Gets the calculated byte rate (i.e., bytes per second) based on data received from device connection.
Public property CalculatedFrameRate Gets the calculated frame rate (i.e., frames per second) based on data received from device connection.
Public property CheckSumValidationFrameTypes Gets or sets flags that determine if check-sums for specified frames should be validated.
Public property CommandChannelServerUri Gets the server URI of the command channel connection, or null if not connected.
Public property ConfigurationFrame Gets or sets current IConfigurationFrame used for parsing IDataFrame's encountered in the data stream from a device.
Public property ConfigurationFrameVersion Gets or sets specific configuration frame version to request from device which overrides default that otherwise requests latest configuration frame version for current protocol.
Public property ConfiguredFrameRate Gets the configured frame rate as reported by the connected device.
Public property ConnectionInfo Gets a string representing connectivity information.
Public property ConnectionIsListener Gets flag that determines if the connection type is a TCP server.
Public property ConnectionIsMulticast Gets flag that determines if the connection type is multicast.
Public property ConnectionParameters Gets or sets any connection specific IConnectionParameters that may be applicable for the current PhasorProtocol.
Public property ConnectionString Gets or sets the key/value pair based connection information required by the MultiProtocolFrameParser to connect to a device.
Public property ConnectionTime Gets total time connection has been active.
Public property ConnectionType Gets the connection type (Active, Passive or Hybrid) based on defined channels and transport selections.
Public property DataChannelIsServerBased Gets a boolean value that determines if data channel is defined as a server based connection.
Public property DataChannelServerUri Gets the server URI of the data channel connection, or null if not connected.
Public property DefinedFrameRate Gets or sets desired frame rate to use for maintaining captured frame replay timing. Defaults to DefaultDefinedFrameRate.
Public property DeviceID Gets or sets the device identification code often needed to establish a connection.
Public property DeviceSupportsCommands Gets or sets flag that determines if a device supports commands.
Public property DisableRealTimeDataOnStop Gets or sets flag to disable real-time data on stop. Defaults to DefaultDisableRealTimeDataOnStop.
Public property DisconnectAtEOF Gets or sets flag that determines if client should disconnect when end of file has been reached.
Public property Enabled Gets or sets a boolean value that indicates whether the MultiProtocolFrameParser is currently enabled.
Public property InjectSimulatedTimestamp Gets or sets flag indicating whether or not to inject local system time into parsed data frames.
Public property IsConnected Gets a flag that determines if the currently selected TransportProtocol is connected.
Public property IsIEEEProtocol Gets a flag that determines if the currently selected PhasorProtocol is an IEEE standard protocol.
Public property KeepCommandChannelOpen Gets or sets flag that determines whether to keep the command channel open after the initial startup sequence. Defaults to DefaultKeepCommandChannelOpen.
Public property MaximumConnectionAttempts Gets or sets the maximum number of times the MultiProtocolFrameParser will attempt to connect to a device. Defaults to DefaultMaximumConnectionAttempts.
Public property MegaBitRate Gets the calculated megabits per second (Mbps) rate based on data received from device connection.
Public property Name Gets a descriptive name for a device connection that includes SourceName, if provided.
Public property ParsingExceptionWindow Gets or sets time duration, in Ticks, to monitor parsing exceptions. Defaults to DefaultParsingExceptionWindow.
Public property PhasorProtocol Gets or sets PhasorProtocol to use with this MultiProtocolFrameParser.
Public property QueuedBuffers Gets the total number of buffers that are currently queued for processing, if any.
Public property QueuedOutputs Gets the total number of frames that are currently queued for publication, if any.
Public property RedundantFramesPerPacket Gets the number of redundant frames in each packet.
Public property ReplayStartTime Gets or sets the replay start time to use for file based input. File read will begin when encountered frame timestamps are greater than or equal to specified ReplayStartTime.
Public property ReplayStopTime Gets or sets the replay stop time to use for file based input. File read will end when encountered frame timestamps are greater than or equal to specified ReplayStopTime.
Public property ServerIndex Gets the current server index, when multiple server end points are defined.
Public property SkipDisableRealTimeData Gets or sets flag to skip automatic disabling of the real-time data stream on shutdown or startup. Defaults to DefaultSkipDisableRealTimeData.
Public property SourceName Gets or sets a descriptive name for a device connection.
Public property Status Gets current descriptive status of the MultiProtocolFrameParser.
Public property TotalBytesReceived Gets total number of bytes that have been received from a device so far.
Public property TotalCrcExceptions Gets total number of CRC exceptions encountered from device so far.
Public property TotalFramesReceived Gets total number of frames that have been received from a device so far.
Public property TotalMissingFrames Gets total number of frames that were missing from device so far.
Public property TransportProtocol Gets or sets TransportProtocol to use with this MultiProtocolFrameParser.
Public property TrustHeaderLength Gets or sets flag that determines if header lengths should be trusted over parsed byte count. Defaults to DefaultTrustHeaderLength.
Public property UseHighResolutionInputTimer Gets or sets flag that determines if a high-resolution precision timer should be used for file based input.
Top
See Also