QgsStacCollectionList Class Reference

Stores a list of STAC Collections, which is typically used to store the data returned by STAC API /collections endpoint. More...

#include <qgsstaccollectionlist.h>

Public Member Functions
	QgsStacCollectionList ()=delete
	Default constructor deleted, use the variant with required parameters.
	QgsStacCollectionList (const QVector< QgsStacCollection * > collections, const QVector< QgsStacLink > links, int numberMatched=-1)
	Constructs a valid list of collections,.
	~QgsStacCollectionList ()
	Destructor.
QVector< QgsStacCollection * >	collections () const
	Returns the collections Ownership is not transferred.
QUrl	nextUrl () const
	Returns the url of the collections' "next" link.
int	numberMatched () const
	Returns the total number of available collections If this information was not available by the STAC server, -1 is returned.
int	numberReturned () const
	Returns the number of returned collections.
QUrl	prevUrl () const
	Returns the url of the collections' "prev" link.
QUrl	rootUrl () const
	Returns the url of the collections' "root" link.
QVector< QgsStacCollection * >	takeCollections ()
	Returns the collections Caller takes ownership of the returned collections.
QUrl	url () const
	Returns the url of the collections' "self" link.

Detailed Description

Stores a list of STAC Collections, which is typically used to store the data returned by STAC API /collections endpoint.

Since

QGIS 3.44

Definition at line 33 of file qgsstaccollectionlist.h.

Constructor & Destructor Documentation

QgsStacCollectionList() [1/2]

QgsStacCollectionList::QgsStacCollectionList ( )

delete

Default constructor deleted, use the variant with required parameters.

QgsStacCollectionList() [2/2]

QgsStacCollectionList::QgsStacCollectionList	(	const QVector< QgsStacCollection * >	collections,
		const QVector< QgsStacLink >	links,
		int	numberMatched = -1 )

Constructs a valid list of collections,.

Parameters

collections	The STAC Collections to be stored, ownership is transferred
links	A list of references to other documents.
numberMatched	The total number of collections in the parent catalog, collection or total matching results from a STAC API endpoint

Note

ownership of collections is transferred. Collections will be deleted when object is destroyed.

Definition at line 24 of file qgsstaccollectionlist.cpp.

~QgsStacCollectionList()

QgsStacCollectionList::~QgsStacCollectionList

(

)

Destructor.

Definition at line 36 of file qgsstaccollectionlist.cpp.

Member Function Documentation

collections()

QVector< QgsStacCollection * > QgsStacCollectionList::collections

(

)

const

Returns the collections Ownership is not transferred.

Definition at line 41 of file qgsstaccollectionlist.cpp.

nextUrl()

QUrl QgsStacCollectionList::nextUrl

(

)

const

Returns the url of the collections' "next" link.

Definition at line 73 of file qgsstaccollectionlist.cpp.

numberMatched()

int QgsStacCollectionList::numberMatched

(

)

const

Returns the total number of available collections If this information was not available by the STAC server, -1 is returned.

Definition at line 58 of file qgsstaccollectionlist.cpp.

numberReturned()

int QgsStacCollectionList::numberReturned

(

)

const

Returns the number of returned collections.

Definition at line 53 of file qgsstaccollectionlist.cpp.

prevUrl()

QUrl QgsStacCollectionList::prevUrl

(

)

const

Returns the url of the collections' "prev" link.

Definition at line 78 of file qgsstaccollectionlist.cpp.

rootUrl()

QUrl QgsStacCollectionList::rootUrl

(

)

const

Returns the url of the collections' "root" link.

Definition at line 68 of file qgsstaccollectionlist.cpp.

takeCollections()

QVector< QgsStacCollection * > QgsStacCollectionList::takeCollections

(

)

Returns the collections Caller takes ownership of the returned collections.

Definition at line 46 of file qgsstaccollectionlist.cpp.

url()

QUrl QgsStacCollectionList::url

(

)

const

Returns the url of the collections' "self" link.

Definition at line 63 of file qgsstaccollectionlist.cpp.

---

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

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