Class NtripSettings

ClassList > NtripSettings

A class containing NTRIP server settings.

• #include <ntripsettings.h>

Public Types

Type	Name
enum	Protocol NTRIP server protocol.

Public Properties

Type	Name
property bool	forwardNmeaSentences
property QString	host
property bool	isValid
property QString	mountPoint
property QString	password
property int	port
property Protocol	protocol
property QString	username

Public Functions

Type	Name
	NtripSettings () The NTRIP settings constructor.
bool	forwardNmeaSentences () const Returns TRUE if NMEA sentences will be forwarded to the NTRIP server.
QString	host () const Returns the NTRIP server host.
bool	isValid () const Returns TRUE if the settings are complete enough to connect to an NTRIP server.
QString	mountPoint () const Returns the NTRIP server mount point.
bool	operator!= (const NtripSettings & other) const
bool	operator== (const NtripSettings & other) const
QString	password () const Returns the password to connect ot he NTRIP server.
int	port () const Returns the NTRIP server port.
Protocol	protocol () const Returns the NTRIP server protocol.
void	setForwardNmeaSentences (bool forwardNmeaSentences) Sets whether NMEA sentences will be forwarded to the NTRIP server.
void	setHost (const QString & host) Sets the NTRIP server host.
void	setMountPoint (const QString & mountPoint) Sets the NTRIP server mount point.
void	setPassword (const QString & password) Sets the password to connect ot he NTRIP server.
void	setPort (int port) Sets the NTRIP server port.
void	setProtocol (Protocol protocol) Sets the NTRIP server protocol.
void	setUsername (const QString & username) Sets the username to connect ot he NTRIP server.
Q_INVOKABLE QVariantMap	toMap () const Return a map of settings.
QString	username () const Returns the username to connect ot he NTRIP server.

Public Static Functions

Type	Name
NtripSettings	fromMap (const QVariantMap & settings) Creates an NtripSettings object from a map of settings.

Public Types Documentation

enum Protocol

NTRIP server protocol.

enum NtripSettings::Protocol {
    NtripVersion1,
    NtripVersion2,
    NtripSsl
};

---

Public Properties Documentation

property forwardNmeaSentences [1/2]

bool NtripSettings::forwardNmeaSentences;

---

property host [1/2]

QString NtripSettings::host;

---

property isValid [1/2]

bool NtripSettings::isValid;

---

property mountPoint [1/2]

QString NtripSettings::mountPoint;

---

property password [1/2]

QString NtripSettings::password;

---

property port [1/2]

int NtripSettings::port;

---

property protocol [1/2]

Protocol NtripSettings::protocol;

---

property username [1/2]

QString NtripSettings::username;

---

Public Functions Documentation

function NtripSettings

The NTRIP settings constructor.

NtripSettings::NtripSettings () 

---

function forwardNmeaSentences [2/2]

Returns TRUE if NMEA sentences will be forwarded to the NTRIP server.

inline bool NtripSettings::forwardNmeaSentences () const

---

function host [2/2]

Returns the NTRIP server host.

inline QString NtripSettings::host () const

---

function isValid [2/2]

Returns TRUE if the settings are complete enough to connect to an NTRIP server.

bool NtripSettings::isValid () const

---

function mountPoint [2/2]

Returns the NTRIP server mount point.

inline QString NtripSettings::mountPoint () const

---

function operator!=

inline bool NtripSettings::operator!= (
    const NtripSettings & other
) const

---

function operator==

bool NtripSettings::operator== (
    const NtripSettings & other
) const

---

function password [2/2]

Returns the password to connect ot he NTRIP server.

inline QString NtripSettings::password () const

---

function port [2/2]

Returns the NTRIP server port.

inline int NtripSettings::port () const

---

function protocol [2/2]

Returns the NTRIP server protocol.

inline Protocol NtripSettings::protocol () const

---

function setForwardNmeaSentences

Sets whether NMEA sentences will be forwarded to the NTRIP server.

void NtripSettings::setForwardNmeaSentences (
    bool forwardNmeaSentences
) 

---

function setHost

Sets the NTRIP server host.

void NtripSettings::setHost (
    const QString & host
) 

---

function setMountPoint

Sets the NTRIP server mount point.

void NtripSettings::setMountPoint (
    const QString & mountPoint
) 

---

function setPassword

Sets the password to connect ot he NTRIP server.

void NtripSettings::setPassword (
    const QString & password
) 

---

function setPort

Sets the NTRIP server port.

void NtripSettings::setPort (
    int port
) 

---

function setProtocol

Sets the NTRIP server protocol.

void NtripSettings::setProtocol (
    Protocol protocol
) 

---

function setUsername

Sets the username to connect ot he NTRIP server.

void NtripSettings::setUsername (
    const QString & username
) 

---

function toMap

Return a map of settings.

Q_INVOKABLE QVariantMap NtripSettings::toMap () const

---

function username [2/2]

Returns the username to connect ot he NTRIP server.

inline QString NtripSettings::username () const

---

Public Static Functions Documentation

function fromMap

Creates an NtripSettings object from a map of settings.

static NtripSettings NtripSettings::fromMap (
    const QVariantMap & settings
) 

---

---

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