Class QfNtripSettings

ClassList > QfNtripSettings

A class containing NTRIP server settings.

• #include <qfntripsettings.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
	QfNtripSettings () 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 QfNtripSettings & other) const
bool	operator== (const QfNtripSettings & 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
QfNtripSettings	fromMap (const QVariantMap & settings) Creates an QfNtripSettings object from a map of settings.

Public Types Documentation

enum Protocol

NTRIP server protocol.

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

---

Public Properties Documentation

property forwardNmeaSentences [1/2]

bool QfNtripSettings::forwardNmeaSentences;

---

property host [1/2]

QString QfNtripSettings::host;

---

property isValid [1/2]

bool QfNtripSettings::isValid;

---

property mountPoint [1/2]

QString QfNtripSettings::mountPoint;

---

property password [1/2]

QString QfNtripSettings::password;

---

property port [1/2]

int QfNtripSettings::port;

---

property protocol [1/2]

Protocol QfNtripSettings::protocol;

---

property username [1/2]

QString QfNtripSettings::username;

---

Public Functions Documentation

function QfNtripSettings

The NTRIP settings constructor.

QfNtripSettings::QfNtripSettings () 

---

function forwardNmeaSentences [2/2]

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

inline bool QfNtripSettings::forwardNmeaSentences () const

---

function host [2/2]

Returns the NTRIP server host.

inline QString QfNtripSettings::host () const

---

function isValid [2/2]

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

bool QfNtripSettings::isValid () const

---

function mountPoint [2/2]

Returns the NTRIP server mount point.

inline QString QfNtripSettings::mountPoint () const

---

function operator!=

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

---

function operator==

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

---

function password [2/2]

Returns the password to connect ot he NTRIP server.

inline QString QfNtripSettings::password () const

---

function port [2/2]

Returns the NTRIP server port.

inline int QfNtripSettings::port () const

---

function protocol [2/2]

Returns the NTRIP server protocol.

inline Protocol QfNtripSettings::protocol () const

---

function setForwardNmeaSentences

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

void QfNtripSettings::setForwardNmeaSentences (
    bool forwardNmeaSentences
) 

---

function setHost

Sets the NTRIP server host.

void QfNtripSettings::setHost (
    const QString & host
) 

---

function setMountPoint

Sets the NTRIP server mount point.

void QfNtripSettings::setMountPoint (
    const QString & mountPoint
) 

---

function setPassword

Sets the password to connect ot he NTRIP server.

void QfNtripSettings::setPassword (
    const QString & password
) 

---

function setPort

Sets the NTRIP server port.

void QfNtripSettings::setPort (
    int port
) 

---

function setProtocol

Sets the NTRIP server protocol.

void QfNtripSettings::setProtocol (
    Protocol protocol
) 

---

function setUsername

Sets the username to connect ot he NTRIP server.

void QfNtripSettings::setUsername (
    const QString & username
) 

---

function toMap

Return a map of settings.

Q_INVOKABLE QVariantMap QfNtripSettings::toMap () const

---

function username [2/2]

Returns the username to connect ot he NTRIP server.

inline QString QfNtripSettings::username () const

---

Public Static Functions Documentation

function fromMap

Creates an QfNtripSettings object from a map of settings.

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

---

---

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