Class NtripClient

ClassList > NtripClient

A simple NTRIP client.

• #include <ntripclient.h>

Inherits the following classes: QObject

Public Signals

Type	Name
signal void	bytesReceivedChanged Emitted when the received bytes counts have changed.
signal void	bytesSentChanged Emitted when the sent bytes counts have changed.
signal void	correctionDataReceived (const QByteArray & data) Emmitted when correction data has been received from an NTRIP server.
signal void	errorOccurred (const QString & message, bool isPermanent) Emmitted when an error occured while communicating with an NTRIP server.
signal void	streamConnected Emitted when successfully connected to an NTRIP server.
signal void	streamDisconnected Emitted when successfully disconnected from an NTRIP server.

Public Functions

Type	Name
	NtripClient (QObject * parent=nullptr) The NTRIP client constructor.
qint64	bytesReceived () const
qint64	bytesSent () const
void	sendNmeaSentence (const QString & sentence) Sends an NMEA sentence to the NTRIP server.
void	start (const NtripSettings & ntripSettings, AbstractGnssReceiver * receiver)
void	startLogging (const QString & path)
void	stop () Stops any ongoing connection to an NTRIP server.
void	stopLogging () Stops logging received corrections.
	~NtripClient () noexcept override The NTRIP client destructor.

Public Signals Documentation

signal bytesReceivedChanged

Emitted when the received bytes counts have changed.

void NtripClient::bytesReceivedChanged;

---

signal bytesSentChanged

Emitted when the sent bytes counts have changed.

void NtripClient::bytesSentChanged;

---

signal correctionDataReceived

Emmitted when correction data has been received from an NTRIP server.

void NtripClient::correctionDataReceived;

---

signal errorOccurred

Emmitted when an error occured while communicating with an NTRIP server.

void NtripClient::errorOccurred;

---

signal streamConnected

Emitted when successfully connected to an NTRIP server.

void NtripClient::streamConnected;

---

signal streamDisconnected

Emitted when successfully disconnected from an NTRIP server.

void NtripClient::streamDisconnected;

---

Public Functions Documentation

function NtripClient

The NTRIP client constructor.

explicit NtripClient::NtripClient (
    QObject * parent=nullptr
) 

---

function bytesReceived

inline qint64 NtripClient::bytesReceived () const

Returns the number of bytes received since a connection to an NTRIP server has been started.

---

function bytesSent

inline qint64 NtripClient::bytesSent () const

Returns the number of bytes sent since a connection to an NTRIP server has been started.

---

function sendNmeaSentence

Sends an NMEA sentence to the NTRIP server.

void NtripClient::sendNmeaSentence (
    const QString & sentence
) 

---

function start

void NtripClient::start (
    const NtripSettings & ntripSettings,
    AbstractGnssReceiver * receiver
) 

Starts a connection to an NTRIP server

Parameters:

• ntripSettings the NTRIP settings object
• receiver the GNSS receiver that will receive corrections and, optionally, forward NMEA sentence from

---

function startLogging

void NtripClient::startLogging (
    const QString & path
) 

Start logging received correction to a given folder path

Note:

the actual log file name will be generated to include the current date and time

---

function stop

Stops any ongoing connection to an NTRIP server.

void NtripClient::stop () 

---

function stopLogging

Stops logging received corrections.

void NtripClient::stopLogging () 

---

function ~NtripClient

The NTRIP client destructor.

NtripClient::~NtripClient () noexcept override

---

---

The documentation for this class was generated from the following file src/core/positioning/ntripclient.h