openPDC Synchrophasor Help
FrameParserBase<(Of <(<'TFrameIdentifier>)>)> Class
NamespacesTVA.PhasorProtocolsFrameParserBase<(Of <(<'TFrameIdentifier>)>)>
Represents a frame parser that defines the basic functionality for a protocol to parse a binary data stream and return the parsed data via events.
Declaration Syntax
C#Visual BasicVisual C++
public abstract class FrameParserBase<TFrameIdentifier> : FrameImageParserBase<TFrameIdentifier, ISupportFrameImage<TFrameIdentifier>>, 
	IFrameParser, IProvideStatus, IDisposable
Public MustInherit Class FrameParserBase(Of TFrameIdentifier) _
	Inherits FrameImageParserBase(Of TFrameIdentifier, ISupportFrameImage(Of TFrameIdentifier)) _
	Implements IFrameParser, IProvideStatus, IDisposable
generic<typename TFrameIdentifier>
public ref class FrameParserBase abstract : public FrameImageParserBase<TFrameIdentifier, ISupportFrameImage<TFrameIdentifier>^>, 
	IFrameParser, IProvideStatus, IDisposable
Generic Template Parameters
TFrameIdentifier
Frame type identifier used to distinguish frames.
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
FrameParserBase<(Of <(<'TFrameIdentifier>)>)>()()()()
Creates a new FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.

BeginRead(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) HostProtectionAttribute.
Begins an asynchronous read operation.
(Inherited from Stream.)
BeginWrite(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) HostProtectionAttribute.
Begins an asynchronous write operation.
(Inherited from Stream.)
CanRead()()()() (Inherited from BinaryImageParserBase.)
CanSeek()()()() (Inherited from BinaryImageParserBase.)
CanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from Stream.)
CanWrite()()()() (Inherited from BinaryImageParserBase.)
Close()()()()
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
(Inherited from Stream.)
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.

ConnectionParameters
Gets or sets any connection specific IConnectionParameters that may be needed for parsing.

CreateBufferQueue()()()()
Creates the internal buffer queue.

CreateObjRef(Type)
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
CreateWaitHandle()()()() Obsolete.
Allocates a WaitHandle object.
(Inherited from Stream.)
DataDiscarded()()()() (Inherited from BinaryImageParserBase.)
DataParsed()()()() (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
Dispose(Boolean)
Releases the unmanaged resources used by the FrameParserBase<(Of <(<'TFrameIdentifier>)>)> object and optionally releases the managed resources.
(Overrides FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.Dispose(Boolean).)
Dispose()()()()
Releases all resources used by the Stream.
(Inherited from Stream.)
DuplicateTypeHandlerEncountered()()()() (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
Enabled()()()() (Inherited from BinaryImageParserBase.)
EndRead(IAsyncResult)
Waits for the pending asynchronous read to complete.
(Inherited from Stream.)
EndWrite(IAsyncResult)
Ends an asynchronous write operation.
(Inherited from Stream.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExecuteParseOnSeparateThread
Gets or sets a flag that allows frame parsing to be executed on a separate thread (i.e., other than communications thread).

Finalize()()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Flush()()()()
Clears all buffers for this stream and causes any buffered data to be parsed immediately.
(Overrides BinaryImageParserBase.Flush()()()().)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetLifetimeService()()()()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
InitializeLifetimeService()()()()
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Length()()()() (Inherited from BinaryImageParserBase.)
MemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name()()()() (Inherited from BinaryImageParserBase.)
OnConfigurationChanged()()()()
Raises the ConfigurationChanged event.

OnDataDiscarded(array<Byte>[]()[][]) (Inherited from BinaryImageParserBase.)
OnDataParsed(UTP) (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
OnDuplicateTypeHandlerEncountered(Type, UTP) (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
OnOutputTypeNotFound(UTP) (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
OnParsingException(Exception) (Inherited from BinaryImageParserBase.)
OnReceivedChannelFrame(IChannelFrame)
Casts the parsed IChannelFrame to its specific implementation (i.e., IDataFrame, IConfigurationFrame, ICommandFrame or IHeaderFrame).

OnReceivedCommandFrame(ICommandFrame)
Raises the ReceivedCommandFrame event.

OnReceivedConfigurationFrame(IConfigurationFrame)
Raises the ReceivedConfigurationFrame event.

OnReceivedDataFrame(IDataFrame)
Raises the ReceivedDataFrame event.

OnReceivedFrameBufferImage(FundamentalFrameType, array<Byte>[]()[][], Int32, Int32)
Raises the ReceivedFrameBufferImage event.

OnReceivedHeaderFrame(IHeaderFrame)
Raises the ReceivedHeaderFrame event.

OnReceivedUndeterminedFrame(IChannelFrame)
Raises the ReceivedUndeterminedFrame event.

OnUnknownFrameTypeEncountered(TFrameIdentifier)
Handles unknown frame types.

OutputTypeNotFound()()()() (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
Parse(ISupportBinaryImage) (Inherited from BinaryImageParserBase.)
ParseCommonHeader(array<Byte>[]()[][], Int32, Int32) (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
ParseFrame(array<Byte>[]()[][], Int32, Int32) (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
ParseQueuedBuffers(array<array<Byte>[]()[][]>[]()[][])
This method is used by the internal ProcessQueue to process all queued data buffers.

ParsingException()()()() (Inherited from BinaryImageParserBase.)
Position()()()() (Inherited from BinaryImageParserBase.)
ProtocolSyncBytes()()()() (Inherited from BinaryImageParserBase.)
ProtocolUsesSyncBytes()()()() (Inherited from BinaryImageParserBase.)
QueuedBuffers
Gets the total number of buffers that are currently queued for processing, if any.

Read(array<Byte>[]()[][], Int32, Int32) (Inherited from BinaryImageParserBase.)
ReadByte()()()()
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
(Inherited from Stream.)
ReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream.)
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.

RunTime()()()() (Inherited from BinaryImageParserBase.)
Seek(Int64, SeekOrigin) (Inherited from BinaryImageParserBase.)
SetLength(Int64) (Inherited from BinaryImageParserBase.)
Start(IEnumerable<(Of <<'(Type>)>>))
Starts the frame parser given the specified type implementations.
(Overrides FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.Start(IEnumerable<(Of <<'(Type>)>>)).)
Start()()()() (Inherited from FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.)
Status
Gets current descriptive status of the FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.
(Overrides FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>.Status()()()().)
Stop()()()()
Stops the frame parser.
(Overrides BinaryImageParserBase.Stop()()()().)
StreamInitialized()()()() (Inherited from BinaryImageParserBase.)
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
TotalProcessedBuffers()()()() (Inherited from BinaryImageParserBase.)
UnparsedBuffer()()()() (Inherited from BinaryImageParserBase.)
Write(array<Byte>[]()[][], Int32, Int32)
Writes a sequence of bytes onto the stream for parsing.
(Overrides BinaryImageParserBase.Write(array<Byte>[]()[][], Int32, Int32).)
WriteByte(Byte)
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream.)
WriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream.)
Remarks
Frame parsers are implemented as a write-only streams so that data can come from any source.
See FrameImageParserBase for more detail.
Inheritance Hierarchy
Object
MarshalByRefObject
 Stream
  BinaryImageParserBase
   FrameImageParserBase<(Of <(<'TFrameIdentifier, ISupportFrameImage<(Of <(<'TFrameIdentifier>)>)>>)>)>
    FrameParserBase<(Of <(<'TFrameIdentifier>)>)>
     FrameParser
     FrameParser
     FrameParser
     FrameParser
     FrameParser
     FrameParser

Assembly: TVA.PhasorProtocols (Module: TVA.PhasorProtocols) Version: 1.4.192.0