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

#include <qgsstaccollection.h>

Inheritance diagram for QgsStacCollection:

[legend]

Public Member Functions
	QgsStacCollection ()=delete
	Default constructor deleted, use the variant with required parameters.
	QgsStacCollection (const QString &id, const QString &version, const QString &description, const QVector< QgsStacLink > &links, const QString &license, const QgsStacExtent &extent)
	Constructs a valid QgsStacCollection.
QMap< QString, QgsStacAsset >	assets () const
	Returns a dictionary of asset objects in the catalog, each with a unique id key.
QgsStacExtent	extent () const
	Returns the collection's spatial and temporal extent.
QStringList	keywords () const
	Returns the list of keywords describing the Collection.
QString	license () const
	Returns the Collection's license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.
QVector< QgsStacProvider >	providers () const
	Returns a list of providers, which may include all organizations capturing or processing the data or the hosting provider.
void	setAssets (const QMap< QString, QgsStacAsset > &assets)
	Sets the asset objects in the catalog, each with a unique id key.
void	setExtent (const QgsStacExtent &extent)
	Sets the collection's spatial and temporal extent.
void	setKeywords (const QStringList &keywords)
	Sets the list of keywords describing the Collection.
void	setLicense (const QString &license)
	Sets the Collection's license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.
void	setProviders (const QVector< QgsStacProvider > &providers)
	Sets a list of providers, which may include all organizations capturing or processing the data or the hosting provider.
void	setSummaries (const QVariantMap &summaries)
	Sets the map of property summaries to the collection.
QVariantMap	summaries () const
	Returns a map of property summaries from the collection.
QString	toHtml () const override
	Returns an HTML representation of the STAC object.
Qgis::StacObjectType	type () const override
	Returns the Type of the STAC object.
Public Member Functions inherited from QgsStacCatalog
	QgsStacCatalog ()=delete
	Default constructor deleted, use the variant with required parameters.
	QgsStacCatalog (const QString &id, const QString &version, const QString &description, const QVector< QgsStacLink > &links)
	Constructs a valid QgsStacCatalog.
void	addConformanceClass (const QString &conformanceClass)
	Adds conformanceClass to the list of catalog's conformance classes.
bool	conformsTo (const QString &conformanceClass) const
	Checks if the catalog is a STAC API conforming to the specified conformanceClass.
QString	description () const
	Returns a Detailed multi-line description to fully explain the Catalog.
void	setConformanceClasses (const QStringList &conformanceClasses)
	Sets the list of conformanceClasses this catalog conforms to.
void	setDescription (const QString &description)
	Sets a detailed multi-line description to fully explain the Catalog.
void	setTitle (const QString &title)
	Sets a short descriptive one-line title for the Catalog.
QString	title () const
	Returns a short descriptive one-line title for the Catalog.
Public Member Functions inherited from QgsStacObject
	QgsStacObject ()=delete
	Default constructor is used for creating invalid objects.
	QgsStacObject (const QString &id, const QString &version, const QVector< QgsStacLink > &links)
	Constructor for valid objects.
virtual	~QgsStacObject ()=default
	Destructor.
QString	id () const
	Id of the STAC object.
QVector< QgsStacLink >	links () const
	Returns the STAC links included in the object.
QString	parentUrl () const
	Returns the url stored in the object's "parent" link.
QString	rootUrl () const
	Returns the url stored in the object's "root" link.
void	setId (const QString &id)
	Sets the id for the STAC object.
void	setLinks (const QVector< QgsStacLink > &links)
	Sets the STAC links included in the object.
void	setStacExtensions (const QStringList &stacExtensions)
	Sets the list of stacExtensions the object implements.
void	setStacVersion (const QString &stacVersion)
	Sets the STAC version the object implements.
QStringList	stacExtensions () const
	Returns the list of extensions the STAC object implements.
QString	stacVersion () const
	Returns the STAC version the object implements.
QString	url () const
	Returns the url stored in the object's "self" link.

Additional Inherited Members
Protected Attributes inherited from QgsStacCatalog
QSet< QString >	mConformanceClasses
QString	mDescription
QString	mTitle
Protected Attributes inherited from QgsStacObject
QString	mId
QVector< QgsStacLink >	mLinks
QStringList	mStacExtensions
QString	mStacVersion
Qgis::StacObjectType	mType = Qgis::StacObjectType::Unknown

Detailed Description

Stores data associated with a STAC Collection.

Since: QGIS 3.44

Definition at line 32 of file qgsstaccollection.h.

Constructor & Destructor Documentation

◆ QgsStacCollection() [1/2]

QgsStacCollection::QgsStacCollection ( )

delete

Default constructor deleted, use the variant with required parameters.

◆ QgsStacCollection() [2/2]

QgsStacCollection::QgsStacCollection	(	const QString &	id,
		const QString &	version,
		const QString &	description,
		const QVector< QgsStacLink > &	links,
		const QString &	license,
		const QgsStacExtent &	extent )

Constructs a valid QgsStacCollection.

Parameters

id	Identifier for the Collection that is unique across the provider.
version	The STAC version the Collection implements.
description	Detailed multi-line description to fully explain the Collection. CommonMark 0.29 syntax MAY be used for rich text representation.
links	A list of references to other documents.
license	Collection's license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.
extent	Spatial and temporal extents of the collection.

Definition at line 23 of file qgsstaccollection.cpp.

Member Function Documentation

◆ assets()

QMap< QString, QgsStacAsset > QgsStacCollection::assets ( ) const

Returns a dictionary of asset objects in the catalog, each with a unique id key.

Definition at line 228 of file qgsstaccollection.cpp.

◆ extent()

QgsStacExtent QgsStacCollection::extent ( ) const

Returns the collection's spatial and temporal extent.

Definition at line 208 of file qgsstaccollection.cpp.

◆ keywords()

QStringList QgsStacCollection::keywords ( ) const

Returns the list of keywords describing the Collection.

Definition at line 178 of file qgsstaccollection.cpp.

◆ license()

QString QgsStacCollection::license ( ) const

Returns the Collection's license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.

Definition at line 188 of file qgsstaccollection.cpp.

◆ providers()

QVector< QgsStacProvider > QgsStacCollection::providers ( ) const

Returns a list of providers, which may include all organizations capturing or processing the data or the hosting provider.

Providers should be listed in chronological order with the most recent provider being the last element of the list.

Definition at line 198 of file qgsstaccollection.cpp.

◆ setAssets()

void QgsStacCollection::setAssets ( const QMap< QString, QgsStacAsset > & assets )

Sets the asset objects in the catalog, each with a unique id key.

Definition at line 233 of file qgsstaccollection.cpp.

◆ setExtent()

void QgsStacCollection::setExtent ( const QgsStacExtent & extent )

Sets the collection's spatial and temporal extent.

Definition at line 213 of file qgsstaccollection.cpp.

◆ setKeywords()

void QgsStacCollection::setKeywords ( const QStringList & keywords )

Sets the list of keywords describing the Collection.

Definition at line 183 of file qgsstaccollection.cpp.

◆ setLicense()

void QgsStacCollection::setLicense ( const QString & license )

Sets the Collection's license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.

Definition at line 193 of file qgsstaccollection.cpp.

◆ setProviders()

void QgsStacCollection::setProviders ( const QVector< QgsStacProvider > & providers )

Sets a list of providers, which may include all organizations capturing or processing the data or the hosting provider.

Providers should be listed in chronological order with the most recent provider being the last element of the list.

Definition at line 203 of file qgsstaccollection.cpp.

◆ setSummaries()

void QgsStacCollection::setSummaries ( const QVariantMap & summaries )

Sets the map of property summaries to the collection.

Definition at line 223 of file qgsstaccollection.cpp.

◆ summaries()

QVariantMap QgsStacCollection::summaries ( ) const

Returns a map of property summaries from the collection.

Definition at line 218 of file qgsstaccollection.cpp.

◆ toHtml()

QString QgsStacCollection::toHtml ( ) const

overridevirtual

Returns an HTML representation of the STAC object.

Reimplemented from QgsStacCatalog.

Definition at line 34 of file qgsstaccollection.cpp.

◆ type()

Qgis::StacObjectType QgsStacCollection::type ( ) const