QgsStacConnection Class Reference

Represents connections to STAC catalogs. More...

#include <qgsstacconnection.h>

Inheritance diagram for QgsStacConnection:

Classes
struct	Data
	Represents decoded data of a connection. More...

Public Member Functions
PRIVATE	QgsStacConnection (const QString &name)
	Constructor for QgsStacConnection, using the stored settings with the specified connection name.
	QgsStacConnection (const QString &uri, const QVariantMap &configuration)
	Constructor for QgsStacConnection, using the a specific connection details.
void	remove (const QString &name) const override
	Deletes the connection from the settings.
void	store (const QString &name) const override
	Stores the connection in the settings.
Public Member Functions inherited from QgsAbstractProviderConnection
	QgsAbstractProviderConnection (const QString &name)
	Creates a new connection with name by reading its configuration from the settings.
	QgsAbstractProviderConnection (const QString &uri, const QVariantMap &configuration)
	Creates a new connection from the given uri and configuration.
virtual	~QgsAbstractProviderConnection ()=default
QVariantMap	configuration () const
	Returns the connection configuration parameters.
virtual QIcon	icon () const
	Returns an icon representing the connection.
void	setConfiguration (const QVariantMap &configuration)
	Sets the connection configuration.
void	setUri (const QString &uri)
	Sets the connection data source URI to uri.
QString	uri () const
	Returns the connection data source URI string representation.

Static Public Member Functions
static void	addConnection (const QString &name, const Data &conn)
	Adds a new connection to the list.
static Data	connection (const QString &name)
	Returns connection details.
static QStringList	connectionList ()
	Returns list of existing connections, unless the hidden ones.
static Data	decodedUri (const QString &uri)
	Decodes connection string to a data structure.
static void	deleteConnection (const QString &name)
	Removes a connection from the list.
static QString	encodedUri (const Data &conn)
	Returns connection data encoded as a string.
static QString	selectedConnection ()
	Returns last used connection.
static void	setSelectedConnection (const QString &connName)
	Saves name of the last used connection.

Detailed Description

Represents connections to STAC catalogs.

Since

QGIS 3.40

Definition at line 41 of file qgsstacconnection.h.

Constructor & Destructor Documentation

QgsStacConnection() [1/2]

PRIVATE QgsStacConnection::QgsStacConnection

(

const QString &

name

)

Constructor for QgsStacConnection, using the stored settings with the specified connection name.

QgsStacConnection() [2/2]

QgsStacConnection::QgsStacConnection	(	const QString &	uri,
		const QVariantMap &	configuration )

Constructor for QgsStacConnection, using the a specific connection details.

Member Function Documentation

addConnection()

void QgsStacConnection::addConnection ( const QString & name, const Data & conn )

static

Adds a new connection to the list.

connection()

Data QgsStacConnection::connection ( const QString & name )

static

Returns connection details.

connectionList()

QStringList QgsStacConnection::connectionList ( )

static

Returns list of existing connections, unless the hidden ones.

decodedUri()

Data QgsStacConnection::decodedUri ( const QString & uri )

static

Decodes connection string to a data structure.

deleteConnection()

void QgsStacConnection::deleteConnection ( const QString & name )

static

Removes a connection from the list.

encodedUri()

QString QgsStacConnection::encodedUri ( const Data & conn )

static

Returns connection data encoded as a string.

remove()

void QgsStacConnection::remove ( const QString & name ) const

overridevirtual

Deletes the connection from the settings.

Implements QgsAbstractProviderConnection.

selectedConnection()

QString QgsStacConnection::selectedConnection ( )

static

Returns last used connection.

setSelectedConnection()

void QgsStacConnection::setSelectedConnection ( const QString & connName )

static

Saves name of the last used connection.

store()

void QgsStacConnection::store ( const QString & name ) const

overridevirtual

Stores the connection in the settings.

Parameters

name	the name under which the connection will be stored

Implements QgsAbstractProviderConnection.

---

The documentation for this class was generated from the following file:

• /build/qgis-4.3.0+git20260913+389d690bb77+99sid/src/core/stac/qgsstacconnection.h