Handles STAC requests. More...

#include <qgsstaccontroller.h>

Inheritance diagram for QgsStacController:

Signals
void	finishedCollectionsRequest (int id, QString errorMessage)
	This signal is fired when an async request initiated with fetchCollectionsAsync is finished.
void	finishedItemCollectionRequest (int id, QString errorMessage)
	This signal is fired when an async request initiated with fetchItemCollectionAsync is finished.
void	finishedStacObjectRequest (int id, QString errorMessage)
	This signal is fired when an async request initiated with fetchStacObjectAsync is finished.

Public Member Functions
	QgsStacController ()=default
	Default constructor.
	~QgsStacController () override
	Default destructor.
QString	authCfg () const
	Returns the authentication config id which will be used during the request.
void	cancelPendingAsyncRequests ()
	Cancels all pending async requests.
std::unique_ptr< QgsStacCollectionList >	fetchCollections (const QUrl &url, QString *error=nullptr)
	Fetches collections from url using a blocking network request.
int	fetchCollectionsAsync (const QUrl &url)
	Initiates an asynchronous request for a Collections collection using the url and returns an associated request id.
std::unique_ptr< QgsStacItemCollection >	fetchItemCollection (const QUrl &url, QString *error=nullptr)
	Fetches a feature collection from url using a blocking network request.
int	fetchItemCollectionAsync (const QUrl &url)
	Initiates an asynchronous request for a feature collection using the url and returns an associated request id.
template<class T>
std::unique_ptr< T >	fetchStacObject (const QUrl &url, QString *error=nullptr)
	Fetches a STAC object from url using a blocking network request.
int	fetchStacObjectAsync (const QUrl &url)
	Initiates an asynchronous request for a STAC object using the url and returns an associated request id.
std::unique_ptr< QgsStacCatalog >	openLocalCatalog (const QString &fileName) const
	Returns a STAC Catalog by parsing a local file The caller takes ownership of the returned catalog.
std::unique_ptr< QgsStacCollection >	openLocalCollection (const QString &fileName) const
	Returns a STAC Collection by parsing a local file The caller takes ownership of the returned collection.
std::unique_ptr< QgsStacItem >	openLocalItem (const QString &fileName) const
	Returns a STAC Item by parsing a local file The caller takes ownership of the returned item.
void	setAuthCfg (const QString &authCfg)
	Sets the authentication config id which should be used during the request.
std::unique_ptr< QgsStacCollectionList >	takeCollections (int requestId)
	Returns the collections collection fetched with the specified requestId It should be used after the finishedCollectionsRequest signal is fired to get the fetched STAC collections.
std::unique_ptr< QgsStacItemCollection >	takeItemCollection (int requestId)
	Returns the feature collection fetched with the specified requestId It should be used after the finishedItemCollectionRequest signal is fired to get the fetched STAC item collection.
template<class T>
std::unique_ptr< T >	takeStacObject (int requestId)
	Returns the STAC object fetched with the specified requestId.

Detailed Description

Handles STAC requests.

Contains methods to generate STAC objects from local and remote urls.

Since: QGIS 3.44

Definition at line 45 of file qgsstaccontroller.h.

Constructor & Destructor Documentation

◆ QgsStacController()

QgsStacController::QgsStacController ( )

explicitdefault

Default constructor.

◆ ~QgsStacController()

QgsStacController::~QgsStacController ( )

override

Default destructor.

Definition at line 37 of file qgsstaccontroller.cpp.

Member Function Documentation

◆ authCfg()

QString QgsStacController::authCfg ( ) const

Returns the authentication config id which will be used during the request.

See also: setAuthCfg()

Definition at line 311 of file qgsstaccontroller.cpp.

◆ cancelPendingAsyncRequests()

void QgsStacController::cancelPendingAsyncRequests ( )

Cancels all pending async requests.

Since: QGIS 3.42

Definition at line 69 of file qgsstaccontroller.cpp.

◆ fetchCollections()

std::unique_ptr< QgsStacCollectionList > QgsStacController::fetchCollections	(	const QUrl &	url,
		QString *	error = nullptr )

Fetches collections from url using a blocking network request.

An optional error parameter will be populated with any network error information. The caller takes ownership of the returned feature collection

Definition at line 274 of file qgsstaccontroller.cpp.

◆ fetchCollectionsAsync()

int QgsStacController::fetchCollectionsAsync ( const QUrl & url )

Initiates an asynchronous request for a Collections collection using the url and returns an associated request id.

When the request is completed, the finishedCollectionsRequest() signal is fired and the collections can be accessed with takeCollections()

Since: QGIS 3.42

Definition at line 61 of file qgsstaccontroller.cpp.

◆ fetchItemCollection()

std::unique_ptr< QgsStacItemCollection > QgsStacController::fetchItemCollection	(	const QUrl &	url,
		QString *	error = nullptr )

Fetches a feature collection from url using a blocking network request.

An optional error parameter will be populated with any network error information. The caller takes ownership of the returned feature collection

Definition at line 249 of file qgsstaccontroller.cpp.

◆ fetchItemCollectionAsync()

int QgsStacController::fetchItemCollectionAsync ( const QUrl & url )

Initiates an asynchronous request for a feature collection using the url and returns an associated request id.

When the request is completed, the finishedItemCollectionRequest() signal is fired and the feature collection can be accessed with takeItemCollection()

Definition at line 53 of file qgsstaccontroller.cpp.

◆ fetchStacObject()

template<class T>

template CORE_EXPORT std::unique_ptr< QgsStacCatalog > QgsStacController::fetchStacObject< QgsStacCatalog >	(	const QUrl &	url,
		QString *	error = nullptr )

Fetches a STAC object from url using a blocking network request.

An optional error parameter will be populated with any network error information. The caller takes ownership of the returned object

Definition at line 370 of file qgsstaccontroller.cpp.

◆ fetchStacObjectAsync()

int QgsStacController::fetchStacObjectAsync ( const QUrl & url )

Initiates an asynchronous request for a STAC object using the url and returns an associated request id.

When the request is completed, the finishedStacObjectRequest() signal is fired and the stac object can be accessed with takeStacObject()

Definition at line 45 of file qgsstaccontroller.cpp.

◆ finishedCollectionsRequest

void QgsStacController::finishedCollectionsRequest	(	int	id,
		QString	errorMessage )

signal

This signal is fired when an async request initiated with fetchCollectionsAsync is finished.

The parsed STAC collections collection can be retrieved using takeCollections

Parameters

id	The requestId attribute of the finished request
errorMessage	Reason the request or parsing of the STAC collections may have failed

See also: fetchCollectionsAsync; takeCollections

Since: QGIS 3.42

◆ finishedItemCollectionRequest

void QgsStacController::finishedItemCollectionRequest	(	int	id,
		QString	errorMessage )

signal

This signal is fired when an async request initiated with fetchItemCollectionAsync is finished.

The parsed STAC item collection can be retrieved using takeItemCollection

Parameters

id	The requestId attribute of the finished request
errorMessage	Reason the request or parsing of the STAC item collection may have failed

See also: fetchItemCollectionAsync; takeItemCollection

◆ finishedStacObjectRequest

void QgsStacController::finishedStacObjectRequest	(	int	id,
		QString	errorMessage )

signal

This signal is fired when an async request initiated with fetchStacObjectAsync is finished.

The parsed STAC object can be retrieved using takeStacObject

Parameters

id	The requestId attribute of the finished request
errorMessage	Reason the request or parsing of the STAC object may have failed

See also: fetchStacObjectAsync; takeStacObject

◆ openLocalCatalog()

std::unique_ptr< QgsStacCatalog > QgsStacController::openLocalCatalog ( const QString & fileName ) const

Returns a STAC Catalog by parsing a local file The caller takes ownership of the returned catalog.

Definition at line 321 of file qgsstaccontroller.cpp.

◆ openLocalCollection()

std::unique_ptr< QgsStacCollection > QgsStacController::openLocalCollection ( const QString & fileName ) const

Returns a STAC Collection by parsing a local file The caller takes ownership of the returned collection.

Definition at line 338 of file qgsstaccontroller.cpp.

◆ openLocalItem()

std::unique_ptr< QgsStacItem > QgsStacController::openLocalItem ( const QString & fileName ) const

Returns a STAC Item by parsing a local file The caller takes ownership of the returned item.

Definition at line 354 of file qgsstaccontroller.cpp.

◆ setAuthCfg()

void QgsStacController::setAuthCfg ( const QString & authCfg )

Sets the authentication config id which should be used during the request.

See also: authCfg()

Definition at line 316 of file qgsstaccontroller.cpp.

◆ takeCollections()

std::unique_ptr< QgsStacCollectionList > QgsStacController::takeCollections ( int requestId )

Returns the collections collection fetched with the specified requestId It should be used after the finishedCollectionsRequest signal is fired to get the fetched STAC collections.

Returns nullptr if the requestId was not found, request was canceled, request failed or parsing the STAC object failed. The caller takes ownership of the returned collections

See also: fetchCollectionsAsync; finishedCollectionsRequest

Since: QGIS 3.42

Definition at line 243 of file qgsstaccontroller.cpp.

◆ takeItemCollection()

std::unique_ptr< QgsStacItemCollection > QgsStacController::takeItemCollection ( int requestId )

Returns the feature collection fetched with the specified requestId It should be used after the finishedItemCollectionRequest signal is fired to get the fetched STAC item collection.

Returns nullptr if the requestId was not found, request was canceled, request failed or parsing the STAC object failed. The caller takes ownership of the returned feature collection

See also: fetchItemCollectionAsync; finishedItemCollectionRequest

Definition at line 237 of file qgsstaccontroller.cpp.

◆ takeStacObject()

template<class T>

template CORE_EXPORT std::unique_ptr< QgsStacObject > QgsStacController::takeStacObject< QgsStacObject > ( int requestId )

Returns the STAC object fetched with the specified requestId.

It should be used after the finishedStacObjectRequest signal is fired to get the fetched STAC object. Returns nullptr if the requestId was not found, request was canceled, request failed or parsing the STAC object failed. The caller takes ownership of the returned object

See also: fetchStacObjectAsync; finishedStacObjectRequest

Definition at line 221 of file qgsstaccontroller.cpp.

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

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

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsStacController()

◆ ~QgsStacController()

Member Function Documentation

◆ authCfg()

◆ cancelPendingAsyncRequests()

◆ fetchCollections()

◆ fetchCollectionsAsync()

◆ fetchItemCollection()

◆ fetchItemCollectionAsync()

◆ fetchStacObject()

◆ fetchStacObjectAsync()

◆ finishedCollectionsRequest

◆ finishedItemCollectionRequest

◆ finishedStacObjectRequest

◆ openLocalCatalog()

◆ openLocalCollection()

◆ openLocalItem()

◆ setAuthCfg()

◆ takeCollections()

◆ takeItemCollection()

◆ takeStacObject()