QgsStacCatalog Class Reference

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

#include <qgsstaccatalog.h>

Inheritance diagram for QgsStacCatalog:

Public Member Functions
	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.
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 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.

Protected Attributes
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 Catalog.

Since

QGIS 3.44

Definition at line 32 of file qgsstaccatalog.h.

Constructor & Destructor Documentation

QgsStacCatalog() [1/2]

QgsStacCatalog::QgsStacCatalog ( )

delete

Default constructor deleted, use the variant with required parameters.

QgsStacCatalog() [2/2]

QgsStacCatalog::QgsStacCatalog	(	const QString &	id,
		const QString &	version,
		const QString &	description,
		const QVector< QgsStacLink > &	links )

Constructs a valid QgsStacCatalog.

Parameters

id	A unique identifier for the catalog
version	The STAC version the Catalog implements.
description	Detailed multi-line description to fully explain the Catalog. CommonMark 0.29 syntax may be used for rich text representation.
links	A list of references to other documents.

Definition at line 22 of file qgsstaccatalog.cpp.

Member Function Documentation

addConformanceClass()

void QgsStacCatalog::addConformanceClass

(

const QString &

conformanceClass

)

Adds conformanceClass to the list of catalog's conformance classes.

Definition at line 111 of file qgsstaccatalog.cpp.

conformsTo()

bool QgsStacCatalog::conformsTo

(

const QString &

conformanceClass

)

const

Checks if the catalog is a STAC API conforming to the specified conformanceClass.

Definition at line 101 of file qgsstaccatalog.cpp.

description()

QString QgsStacCatalog::description

(

)

const

Returns a Detailed multi-line description to fully explain the Catalog.

CommonMark 0.29 syntax may be used for rich text representation.

Definition at line 91 of file qgsstaccatalog.cpp.

setConformanceClasses()

void QgsStacCatalog::setConformanceClasses

(

const QStringList &

conformanceClasses

)

Sets the list of conformanceClasses this catalog conforms to.

Definition at line 106 of file qgsstaccatalog.cpp.

setDescription()

void QgsStacCatalog::setDescription

(

const QString &

description

)

Sets a detailed multi-line description to fully explain the Catalog.

CommonMark 0.29 syntax may be used for rich text representation.

Definition at line 96 of file qgsstaccatalog.cpp.

setTitle()

void QgsStacCatalog::setTitle

(

const QString &

title

)

Sets a short descriptive one-line title for the Catalog.

Definition at line 86 of file qgsstaccatalog.cpp.

title()

QString QgsStacCatalog::title

(

)

const

Returns a short descriptive one-line title for the Catalog.

Definition at line 81 of file qgsstaccatalog.cpp.

toHtml()

QString QgsStacCatalog::toHtml ( ) const

overridevirtual

Returns an HTML representation of the STAC object.

Implements QgsStacObject.

Reimplemented in QgsStacCollection.

Definition at line 32 of file qgsstaccatalog.cpp.

type()

Qgis::StacObjectType QgsStacCatalog::type ( ) const

overridevirtual

Returns the Type of the STAC object.

Implements QgsStacObject.

Reimplemented in QgsStacCollection.

Definition at line 27 of file qgsstaccatalog.cpp.

Member Data Documentation

mConformanceClasses

QSet< QString > QgsStacCatalog::mConformanceClasses

protected

Definition at line 80 of file qgsstaccatalog.h.

mDescription

QString QgsStacCatalog::mDescription

protected

Definition at line 79 of file qgsstaccatalog.h.

mTitle

QString QgsStacCatalog::mTitle

protected

Definition at line 78 of file qgsstaccatalog.h.

---

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

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