Skip to content

Class NtripSocket

ClassList > NtripSocket

A simple NTRIP socket.

  • #include <ntripclient.h>

Inherits the following classes: QObject

Public Signals

Type Name
signal void correctionDataReceived (const QByteArray & data)
Emmitted when the socket has received data from an NTRIP server.
signal void errorOccurred (const QString & message, bool isPermanent)
Emmitted when an error occured while the socket communicates with an NTRIP server.
signal void streamConnected
Emitted when the socket has successfully connected to an NTRIP server.
signal void streamDisconnected
Emitted when the socket has disconnected from an NTRIP server.

Public Functions

Type Name
NtripSocket (QObject * parent=nullptr)
The NTRIP socket constructor.
void abort ()
Abort any socket connection to an NTRIP server.
qint64 connectToHost (const NtripSettings & ntripSettings)
qint64 writeNmeaSentence (const QByteArray & sentence)
Write an NMEA sentence to the NTRIP server.
~NtripSocket () noexcept override
The NTRIP socket destructor.

Public Signals Documentation

signal correctionDataReceived

Emmitted when the socket has received data from an NTRIP server.

void NtripSocket::correctionDataReceived;

signal errorOccurred

Emmitted when an error occured while the socket communicates with an NTRIP server.

void NtripSocket::errorOccurred;

signal streamConnected

Emitted when the socket has successfully connected to an NTRIP server.

void NtripSocket::streamConnected;

signal streamDisconnected

Emitted when the socket has disconnected from an NTRIP server.

void NtripSocket::streamDisconnected;

Public Functions Documentation

function NtripSocket

The NTRIP socket constructor.

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

function abort

Abort any socket connection to an NTRIP server.

void NtripSocket::abort () 

function connectToHost

qint64 NtripSocket::connectToHost (
    const NtripSettings & ntripSettings
) 

Connects the socket to an NTRIP server

Parameters:

  • ntripSettings the NTRIP settings object

function writeNmeaSentence

Write an NMEA sentence to the NTRIP server.

qint64 NtripSocket::writeNmeaSentence (
    const QByteArray & sentence
) 

function ~NtripSocket

The NTRIP socket destructor.

NtripSocket::~NtripSocket () noexcept override


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