Edit

Share via

NmeaSinkAndSource Class

  • Reference

Definition

Namespace:
Iot.Device.Nmea0183
Assembly:
Iot.Device.Bindings.dll
Package:
Iot.Device.Bindings v2.1.0
Package:
Iot.Device.Bindings v3.0.0

This abstract class describes an NMEA data source or data sink. It can be a connection, a data processor or an output device.

public abstract class NmeaSinkAndSource : IDisposable
type NmeaSinkAndSource = class
    interface IDisposable
Public MustInherit Class NmeaSinkAndSource
Implements IDisposable
Inheritance
Object
NmeaSinkAndSource
Derived
Implements
IDisposable

Constructors

NmeaSinkAndSource(String)

Constructs a message sink

Properties

InterfaceName

Name of the interface

Methods

DispatchSentenceEvents(NmeaSentence)

Forwards the given sentence to listeners, as needed. Use the current instance as source.
DispatchSentenceEvents(NmeaSinkAndSource, NmeaSentence)

Forwards the given sentence to listeners, as needed.
Dispose()

Standard dispose method
Dispose(Boolean)

Dispose this instance
FireOnParserError(String, NmeaError)

Fire an event informing about parser errors
SendSentence(NmeaSentence)

Send the given sentence to the interface.
SendSentence(NmeaSinkAndSource, NmeaSentence)

Send the message to the device. From the implementation side, this is where the input data comes in (e.g. from the message dispatcher)
SendSentences(IEnumerable<NmeaSentence>)

Sends a list of messages at once
StartDecode()

Start receiving messages from this interface. An implementation should open streams, connect to sockets or create receiver threads, as appropriate.
StopDecode()

Stops sending or receiving messages from and to this interface. Any pending messages are discarded.

Events

OnNewPosition

This is fired when a new position is available
OnNewSequence

This is fired on every new sentence
OnNewTime

This is fired when the time is updated
OnParserError

This is fired when a message couldn't be parsed

Applies to