QgsStacItemCollection Class Reference

Stores data associated with a STAC Item Collection. More...

#include <qgsstacitemcollection.h>

Public Member Functions
	QgsStacItemCollection ()=delete
	Default constructor deleted, use the variant with required parameters.
	QgsStacItemCollection (const QVector< QgsStacItem * > &items, const QVector< QgsStacLink > &links, int numberMatched=-1)
	Constructs a valid item collection.
	~QgsStacItemCollection ()
	Destructor.
QUrl	collectionUrl () const
	Returns the url of the item collection's "collection" link.
QVector< QgsStacItem * >	items () const
	Returns the items in the collection Ownership is not transferred.
QUrl	nextUrl () const
	Returns the url of the item collection's "next" link.
int	numberMatched () const
	Returns the total number of items in the parent collection If this information was not available by the STAC server, -1 is returned.
int	numberReturned () const
	Returns the number of items in the collection.
QUrl	parentUrl () const
	Returns the url of the item collection's "parent" link.
QUrl	rootUrl () const
	Returns the url of the item collection's "root" link.
QVector< QgsStacItem * >	takeItems ()
	Returns the items in the collection Caller takes ownership of the returned items.
QUrl	url () const
	Returns the url of the item collection's "self" link.

Detailed Description

Stores data associated with a STAC Item Collection.

An Item Collection is typically returned by STAP API endpoints and contains a subset of the STAC Items available in a STAC Catalog or Collection.

Since

QGIS 3.44

Definition at line 36 of file qgsstacitemcollection.h.

Constructor & Destructor Documentation

QgsStacItemCollection() [1/2]

QgsStacItemCollection::QgsStacItemCollection ( )

delete

Default constructor deleted, use the variant with required parameters.

QgsStacItemCollection() [2/2]

QgsStacItemCollection::QgsStacItemCollection	(	const QVector< QgsStacItem * > &	items,
		const QVector< QgsStacLink > &	links,
		int	numberMatched = -1 )

Constructs a valid item collection.

Parameters

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

Note

ownership of items is transferred. Items will be deleted when object is destroyed.

Definition at line 24 of file qgsstacitemcollection.cpp.

~QgsStacItemCollection()

QgsStacItemCollection::~QgsStacItemCollection

(

)

Destructor.

Definition at line 36 of file qgsstacitemcollection.cpp.

Member Function Documentation

collectionUrl()

QUrl QgsStacItemCollection::collectionUrl

(

)

const

Returns the url of the item collection's "collection" link.

Definition at line 68 of file qgsstacitemcollection.cpp.

items()

QVector< QgsStacItem * > QgsStacItemCollection::items

(

)

const

Returns the items in the collection Ownership is not transferred.

Definition at line 41 of file qgsstacitemcollection.cpp.

nextUrl()

QUrl QgsStacItemCollection::nextUrl

(

)

const

Returns the url of the item collection's "next" link.

Definition at line 73 of file qgsstacitemcollection.cpp.

numberMatched()

int QgsStacItemCollection::numberMatched

(

)

const

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

Definition at line 83 of file qgsstacitemcollection.cpp.

numberReturned()

int QgsStacItemCollection::numberReturned

(

)

const

Returns the number of items in the collection.

Definition at line 78 of file qgsstacitemcollection.cpp.

parentUrl()

QUrl QgsStacItemCollection::parentUrl

(

)

const

Returns the url of the item collection's "parent" link.

Definition at line 63 of file qgsstacitemcollection.cpp.

rootUrl()

QUrl QgsStacItemCollection::rootUrl

(

)

const

Returns the url of the item collection's "root" link.

Definition at line 58 of file qgsstacitemcollection.cpp.

takeItems()

QVector< QgsStacItem * > QgsStacItemCollection::takeItems

(

)

Returns the items in the collection Caller takes ownership of the returned items.

Definition at line 46 of file qgsstacitemcollection.cpp.

url()

QUrl QgsStacItemCollection::url

(

)

const

Returns the url of the item collection's "self" link.

Definition at line 53 of file qgsstacitemcollection.cpp.

---

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

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