QGIS API Documentation 4.3.0-Master (389d690bb77)
Loading...
Searching...
No Matches
QgsStacObject Class Referenceabstract

Abstract base class for storing STAC objects. More...

#include <qgsstacobject.h>

Inheritance diagram for QgsStacObject:

Public Member Functions

 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< QgsStacLinklinks () 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.
virtual QString toHtml () const =0
 Returns an HTML representation of the STAC object.
virtual Qgis::StacObjectType type () const =0
 Returns the Type of the STAC object.
QString url () const
 Returns the url stored in the object's "self" link.

Protected Attributes

QString mId
QVector< QgsStacLinkmLinks
QStringList mStacExtensions
QString mStacVersion
Qgis::StacObjectType mType = Qgis::StacObjectType::Unknown

Detailed Description

Abstract base class for storing STAC objects.

Since
QGIS 3.44

Definition at line 33 of file qgsstacobject.h.

Constructor & Destructor Documentation

◆ QgsStacObject() [1/2]

QgsStacObject::QgsStacObject ( )
delete

Default constructor is used for creating invalid objects.

◆ QgsStacObject() [2/2]

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

Constructor for valid objects.

Definition at line 22 of file qgsstacobject.cpp.

◆ ~QgsStacObject()

virtual QgsStacObject::~QgsStacObject ( )
virtualdefault

Destructor.

Member Function Documentation

◆ id()

QString QgsStacObject::id ( ) const

Id of the STAC object.

Definition at line 48 of file qgsstacobject.cpp.

◆ links()

QVector< QgsStacLink > QgsStacObject::links ( ) const

Returns the STAC links included in the object.

Definition at line 58 of file qgsstacobject.cpp.

◆ parentUrl()

QString QgsStacObject::parentUrl ( ) const

Returns the url stored in the object's "parent" link.

Definition at line 88 of file qgsstacobject.cpp.

◆ rootUrl()

QString QgsStacObject::rootUrl ( ) const

Returns the url stored in the object's "root" link.

Definition at line 78 of file qgsstacobject.cpp.

◆ setId()

void QgsStacObject::setId ( const QString & id)

Sets the id for the STAC object.

Definition at line 53 of file qgsstacobject.cpp.

◆ setLinks()

void QgsStacObject::setLinks ( const QVector< QgsStacLink > & links)

Sets the STAC links included in the object.

Definition at line 63 of file qgsstacobject.cpp.

◆ setStacExtensions()

void QgsStacObject::setStacExtensions ( const QStringList & stacExtensions)

Sets the list of stacExtensions the object implements.

Definition at line 43 of file qgsstacobject.cpp.

◆ setStacVersion()

void QgsStacObject::setStacVersion ( const QString & stacVersion)

Sets the STAC version the object implements.

Definition at line 33 of file qgsstacobject.cpp.

◆ stacExtensions()

QStringList QgsStacObject::stacExtensions ( ) const

Returns the list of extensions the STAC object implements.

Definition at line 38 of file qgsstacobject.cpp.

◆ stacVersion()

QString QgsStacObject::stacVersion ( ) const

Returns the STAC version the object implements.

Definition at line 28 of file qgsstacobject.cpp.

◆ toHtml()

virtual QString QgsStacObject::toHtml ( ) const
pure virtual

Returns an HTML representation of the STAC object.

Implemented in QgsStacCatalog, QgsStacCollection, and QgsStacItem.

◆ type()

virtual Qgis::StacObjectType QgsStacObject::type ( ) const
pure virtual

Returns the Type of the STAC object.

Implemented in QgsStacCatalog, QgsStacCollection, and QgsStacItem.

◆ url()

QString QgsStacObject::url ( ) const

Returns the url stored in the object's "self" link.

Definition at line 68 of file qgsstacobject.cpp.

Member Data Documentation

◆ mId

QString QgsStacObject::mId
protected

Definition at line 113 of file qgsstacobject.h.

◆ mLinks

QVector< QgsStacLink > QgsStacObject::mLinks
protected

Definition at line 116 of file qgsstacobject.h.

◆ mStacExtensions

QStringList QgsStacObject::mStacExtensions
protected

Definition at line 115 of file qgsstacobject.h.

◆ mStacVersion

QString QgsStacObject::mStacVersion
protected

Definition at line 114 of file qgsstacobject.h.

◆ mType

Qgis::StacObjectType QgsStacObject::mType = Qgis::StacObjectType::Unknown
protected

Definition at line 112 of file qgsstacobject.h.


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