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

#include <qgsstacasset.h>

Public Member Functions
	QgsStacAsset (const QString &href, const QString &title, const QString &description, const QString &mediaType, const QStringList &roles)
	Constructor.
QString	description () const
	Returns a description of the Asset providing additional details, such as how it was processed or created.
QString	formatName () const
	Returns the format name for cloud optimized formats.
QString	href () const
	Returns the URI to the asset object.
bool	isCloudOptimized () const
	Returns whether the asset is in a cloud optimized format like COG or COPC.
bool	isDownloadable () const
	Returns whether the asset can be downloaded.
QString	mediaType () const
	Returns the media type of the asset.
QStringList	roles () const
	Returns the roles assigned to the asset.
QString	title () const
	Returns the displayed title for clients and users.
QString	toHtml (const QString &assetId) const
	Returns an HTML representation of the STAC Asset including its ID within its container.
QgsMimeDataUtils::Uri	uri (const QString &authcfg=QString()) const
	Returns a uri for the asset if it is a cloud optimized file like COG or COPC.

Detailed Description

Stores data associated with a STAC asset.

Since: QGIS 3.44

Definition at line 32 of file qgsstacasset.h.

Constructor & Destructor Documentation

◆ QgsStacAsset()

QgsStacAsset::QgsStacAsset	(	const QString &	href,
		const QString &	title,
		const QString &	description,
		const QString &	mediaType,
		const QStringList &	roles )

Constructor.

Definition at line 23 of file qgsstacasset.cpp.

Member Function Documentation

◆ description()

QString QgsStacAsset::description ( ) const

Returns a description of the Asset providing additional details, such as how it was processed or created.

CommonMark 0.29 syntax MAY be used for rich text representation.

Definition at line 41 of file qgsstacasset.cpp.

◆ formatName()

QString QgsStacAsset::formatName ( ) const

Returns the format name for cloud optimized formats.

Since: QGIS 3.42

Definition at line 62 of file qgsstacasset.cpp.

◆ href()

QString QgsStacAsset::href ( ) const

Returns the URI to the asset object.

Definition at line 31 of file qgsstacasset.cpp.

◆ isCloudOptimized()

bool QgsStacAsset::isCloudOptimized ( ) const

Returns whether the asset is in a cloud optimized format like COG or COPC.

Since: QGIS 3.42

Definition at line 56 of file qgsstacasset.cpp.

◆ isDownloadable()

bool QgsStacAsset::isDownloadable ( ) const

Returns whether the asset can be downloaded.

Since: QGIS 4.0

Definition at line 169 of file qgsstacasset.cpp.

◆ mediaType()

QString QgsStacAsset::mediaType ( ) const

Returns the media type of the asset.

Definition at line 46 of file qgsstacasset.cpp.

◆ roles()

QStringList QgsStacAsset::roles ( ) const

Returns the roles assigned to the asset.

Roles are used to describe the purpose of the asset (eg. thumbnail, data etc).

Definition at line 51 of file qgsstacasset.cpp.

◆ title()

QString QgsStacAsset::title ( ) const

Returns the displayed title for clients and users.

Definition at line 36 of file qgsstacasset.cpp.

◆ toHtml()

QString QgsStacAsset::toHtml ( const QString & assetId ) const

Returns an HTML representation of the STAC Asset including its ID within its container.

Since: QGIS 4.0

Definition at line 155 of file qgsstacasset.cpp.

◆ uri()

QgsMimeDataUtils::Uri QgsStacAsset::uri ( const QString & authcfg = QString() ) const

Returns a uri for the asset if it is a cloud optimized file like COG or COPC.

Parameters

authcfg Optional authentication configuration ID (since QGIS 4.0).

If the optional authcfg parameter is set the authentication configuration ID will be encoded in the returned URI.

Since: QGIS 3.42

Definition at line 80 of file qgsstacasset.cpp.

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

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

Public Member Functions