sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-10-05 00:09:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add missing sip files

Browse Source
This commit is contained in:
Mathieu Pellerin 2025-06-12 20:04:24 +07:00
parent 64bb655c18
commit 3dea59c37e
28 changed files with 3246 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
python/PyQt6/core/auto_generated/stac/qgsstacasset.sip.in Normal file
View File

@ -0,0 +1,92 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacasset.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacAsset
{
%Docstring(signature="appended")
Class for storing a STAC asset's data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacasset.h"
%End
public:
QgsStacAsset( const QString &href,
const QString &title,
const QString &description,
const QString &mediaType,
const QStringList &roles );
%Docstring
Constructor
%End
QString href() const;
%Docstring
Returns the URI to the asset object
%End
QString title() const;
%Docstring
Returns the displayed title for clients and users.
%End
QString description() const;
%Docstring
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.
%End
QString mediaType() const;
%Docstring
Returns the media type of the asset
%End
QStringList roles() const;
%Docstring
Returns the roles assigned to the asset. Roles are used to describe the
purpose of the asset (eg. thumbnail, data etc).
%End
bool isCloudOptimized() const;
%Docstring
Returns whether the asset is in a cloud optimized format like COG or
COPC
.. versionadded:: 3.42
%End
QString formatName() const;
%Docstring
Returns the format name for cloud optimized formats
.. versionadded:: 3.42
%End
QgsMimeDataUtils::Uri uri() const;
%Docstring
Returns a uri for the asset if it is a cloud optimized file like COG or
COPC
.. versionadded:: 3.42
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacasset.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

92
python/PyQt6/core/auto_generated/stac/qgsstaccatalog.sip.in Normal file
View File

@ -0,0 +1,92 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccatalog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacCatalog : QgsStacObject
{
%Docstring(signature="appended")
Class for storing a STAC Catalog's data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaccatalog.h"
%End
public:
QgsStacCatalog( const QString &id,
const QString &version,
const QString &description,
const QVector< QgsStacLink > &links );
%Docstring
Constructs a valid QgsStacCatalog
:param id: A unique identifier for the catalog
:param version: The STAC version the Catalog implements.
:param description: Detailed multi-line description to fully explain the
Catalog. CommonMark 0.29 syntax may be used for rich
text representation.
:param links: A list of references to other documents.
%End
virtual Qgis::StacObjectType type() const;
virtual QString toHtml() const;
QString title() const;
%Docstring
Returns a short descriptive one-line title for the Catalog.
%End
void setTitle( const QString &title );
%Docstring
Sets a short descriptive one-line ``title`` for the Catalog.
%End
QString description() const;
%Docstring
Returns a Detailed multi-line description to fully explain the Catalog.
CommonMark 0.29 syntax may be used for rich text representation.
%End
void setDescription( const QString &description );
%Docstring
Sets a detailed multi-line ``description`` to fully explain the Catalog.
CommonMark 0.29 syntax may be used for rich text representation.
%End
void setConformanceClasses( const QStringList &conformanceClasses );
%Docstring
Sets the list of ``conformanceClasses`` this catalog conforms to.
%End
void addConformanceClass( const QString &conformanceClass );
%Docstring
Adds ``conformanceClass`` to the list of catalog's conformance classes
%End
bool conformsTo( const QString &conformanceClass ) const;
%Docstring
Checks if the catalog is a STAC API conforming to the specified
``conformanceClass``
%End
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccatalog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

128
python/PyQt6/core/auto_generated/stac/qgsstaccollection.sip.in Normal file
View File

@ -0,0 +1,128 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccollection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacCollection : QgsStacCatalog
{
%Docstring(signature="appended")
Class for storing a STAC Collection's data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaccollection.h"
%End
public:
QgsStacCollection( const QString &id,
const QString &version,
const QString &description,
const QVector< QgsStacLink > &links,
const QString &license,
const QgsStacExtent &extent );
%Docstring
Constructs a valid QgsStacCollection
:param id: Identifier for the Collection that is unique across the
provider.
:param version: The STAC version the Collection implements.
:param description: Detailed multi-line description to fully explain the
Collection. CommonMark 0.29 syntax MAY be used for
rich text representation.
:param links: A list of references to other documents.
:param license: Collection's license(s), either a SPDX License
identifier, various if multiple licenses apply or
proprietary for all other cases.
:param extent: Spatial and temporal extents of the collection.
%End
virtual Qgis::StacObjectType type() const;
virtual QString toHtml() const;
QStringList keywords() const;
%Docstring
Returns the list of keywords describing the Collection
%End
void setKeywords( const QStringList &keywords );
%Docstring
Sets the list of ``keywords`` describing the Collection
%End
QString license() const;
%Docstring
Returns the Collection's license(s), either a SPDX License identifier,
various if multiple licenses apply or proprietary for all other cases.
%End
void setLicense( const QString &license );
%Docstring
Sets the Collection's license(s), either a SPDX License identifier,
various if multiple licenses apply or proprietary for all other cases.
%End
QVector<QgsStacProvider> providers() const;
%Docstring
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.
%End
void setProviders( const QVector<QgsStacProvider> &providers );
%Docstring
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.
%End
QgsStacExtent extent() const;
%Docstring
Returns the collection's spatial and temporal extent
%End
void setExtent( const QgsStacExtent &extent );
%Docstring
Sets the collection's spatial and temporal extent
%End
QVariantMap summaries() const;
%Docstring
Returns a map of property summaries from the collection
%End
void setSummaries( const QVariantMap &summaries );
%Docstring
Sets the map of property summaries to the collection
%End
QMap<QString, QgsStacAsset> assets() const;
%Docstring
Returns a dictionary of asset objects in the catalog, each with a unique
id key.
%End
void setAssets( const QMap<QString, QgsStacAsset> &assets );
%Docstring
Sets the asset objects in the catalog, each with a unique id key.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccollection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

95
python/PyQt6/core/auto_generated/stac/qgsstaccollectionlist.sip.in Normal file
View File

@ -0,0 +1,95 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccollectionlist.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacCollectionList
{
%Docstring(signature="appended")
Class for storing a list of STAC Collections, which is typically used to
store the data returned by STAC API /collections endpoint.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaccollectionlist.h"
%End
public:
QgsStacCollectionList( const QVector< QgsStacCollection * > collections, const QVector< QgsStacLink > links, int numberMatched = -1 );
%Docstring
Constructs a valid list of collections,
:param collections: The STAC Collections to be stored, ownership is
transferred
:param links: A list of references to other documents.
:param numberMatched: The total number of collections in the parent
catalog, collection or total matching results from
a STAC API endpoint
.. note::
ownership of ``collections`` is transferred. Collections will be deleted when object is destroyed.
%End
~QgsStacCollectionList();
QVector< QgsStacCollection * > collections() const;
%Docstring
Returns the collections Ownership is not transferred
%End
QVector< QgsStacCollection * > takeCollections();
%Docstring
Returns the collections Caller takes ownership of the returned
collections
%End
int numberReturned() const;
%Docstring
Returns the number of returned collections
%End
int numberMatched() const;
%Docstring
Returns the total number of available collections If this information
was not available by the STAC server, -1 is returned
%End
QUrl url() const;
%Docstring
Returns the url of the collections' "self" link
%End
QUrl rootUrl() const;
%Docstring
Returns the url of the collections' "root" link
%End
QUrl nextUrl() const;
%Docstring
Returns the url of the collections' "next" link
%End
QUrl prevUrl() const;
%Docstring
Returns the url of the collections' "prev" link
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccollectionlist.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

96
python/PyQt6/core/auto_generated/stac/qgsstacconnection.sip.in Normal file
View File

@ -0,0 +1,96 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacconnection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacConnection : QgsAbstractProviderConnection
{
%Docstring(signature="appended")
Represents connections to STAC catalogs.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacconnection.h"
%End
public:
QgsStacConnection( const QString &name );
%Docstring
Constructor for QgsStacConnection, using the stored settings with the
specified connection ``name``.
%End
QgsStacConnection( const QString &uri, const QVariantMap &configuration );
%Docstring
Constructor for QgsStacConnection, using the a specific connection
details.
%End
virtual void store( const QString &name ) const;
virtual void remove( const QString &name ) const;
struct Data
{
QString url;
QString authCfg;
QString username;
QString password;
QgsHttpHeaders httpHeaders;
};
static QString encodedUri( const Data &conn );
%Docstring
Returns connection data encoded as a string
%End
static Data decodedUri( const QString &uri );
%Docstring
Decodes connection string to a data structure
%End
static QStringList connectionList();
%Docstring
Returns list of existing connections, unless the hidden ones
%End
static Data connection( const QString &name );
%Docstring
Returns connection details
%End
static void deleteConnection( const QString &name );
%Docstring
Removes a connection from the list
%End
static void addConnection( const QString &name, const Data &conn );
%Docstring
Adds a new connection to the list
%End
static QString selectedConnection();
%Docstring
Returns last used connection
%End
static void setSelectedConnection( const QString &connName );
%Docstring
Saves name of the last used connection
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacconnection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

210
python/PyQt6/core/auto_generated/stac/qgsstaccontroller.sip.in Normal file
View File

@ -0,0 +1,210 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccontroller.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacController : QObject
{
%Docstring(signature="appended")
The :py:class:`QgsStacController` class handles STAC requests.
Contains methods to generate STAC objects from local and remote urls.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaccontroller.h"
%End
public:
explicit QgsStacController();
%Docstring
Default constructor
%End
~QgsStacController();
std::unique_ptr< QgsStacCatalog > openLocalCatalog( const QString &fileName ) const;
%Docstring
Returns a STAC Catalog by parsing a local file The caller takes
ownership of the returned catalog
%End
std::unique_ptr< QgsStacCollection > openLocalCollection( const QString &fileName ) const;
%Docstring
Returns a STAC Collection by parsing a local file The caller takes
ownership of the returned collection
%End
std::unique_ptr< QgsStacItem > openLocalItem( const QString &fileName ) const;
%Docstring
Returns a STAC Item by parsing a local file The caller takes ownership
of the returned item
%End
std::unique_ptr< QgsStacItemCollection > fetchItemCollection( const QUrl &url, QString *error = 0 );
%Docstring
Fetches a feature collection from ``url`` using a blocking network
request. An optional ``error`` parameter will be populated with any
network error information. The caller takes ownership of the returned
feature collection
%End
std::unique_ptr< QgsStacCollectionList > fetchCollections( const QUrl &url, QString *error = 0 );
%Docstring
Fetches collections from ``url`` using a blocking network request. An
optional ``error`` parameter will be populated with any network error
information. The caller takes ownership of the returned feature
collection
%End
int fetchStacObjectAsync( const QUrl &url );
%Docstring
Initiates an asynchronous request for a STAC object using the ``url``
and returns an associated request id. When the request is completed, the
:py:func:`~QgsStacController.finishedStacObjectRequest` signal is fired
and the stac object can be accessed with
:py:func:`~QgsStacController.takeStacObject`
%End
int fetchItemCollectionAsync( const QUrl &url );
%Docstring
Initiates an asynchronous request for a feature collection using the
``url`` and returns an associated request id. When the request is
completed, the
:py:func:`~QgsStacController.finishedItemCollectionRequest` signal is
fired and the feature collection can be accessed with
:py:func:`~QgsStacController.takeItemCollection`
%End
int fetchCollectionsAsync( const QUrl &url );
%Docstring
Initiates an asynchronous request for a Collections collection using the
``url`` and returns an associated request id. When the request is
completed, the :py:func:`~QgsStacController.finishedCollectionsRequest`
signal is fired and the collections can be accessed with
:py:func:`~QgsStacController.takeCollections`
.. versionadded:: 3.42
%End
void cancelPendingAsyncRequests();
%Docstring
Cancels all pending async requests
.. versionadded:: 3.42
%End
std::unique_ptr< QgsStacItemCollection > takeItemCollection( int requestId );
%Docstring
Returns the feature collection fetched with the specified ``requestId``
It should be used after the finishedItemCollectionRequest signal is
fired to get the fetched STAC item collection. Returns ``None`` if the
requestId was not found, request was canceled, request failed or parsing
the STAC object failed. The caller takes ownership of the returned
feature collection
.. seealso:: :py:func:`fetchItemCollectionAsync`
.. seealso:: :py:func:`finishedItemCollectionRequest`
%End
std::unique_ptr< QgsStacCollectionList > takeCollections( int requestId );
%Docstring
Returns the collections collection fetched with the specified
``requestId`` It should be used after the finishedCollectionsRequest
signal is fired to get the fetched STAC collections. Returns ``None`` if
the requestId was not found, request was canceled, request failed or
parsing the STAC object failed. The caller takes ownership of the
returned collections
.. seealso:: :py:func:`fetchCollectionsAsync`
.. seealso:: :py:func:`finishedCollectionsRequest`
.. versionadded:: 3.42
%End
QString authCfg() const;
%Docstring
Returns the authentication config id which will be used during the
request.
.. seealso:: :py:func:`setAuthCfg`
%End
void setAuthCfg( const QString &authCfg );
%Docstring
Sets the authentication config id which should be used during the
request.
.. seealso:: :py:func:`authCfg`
%End
signals:
void finishedStacObjectRequest( int id, QString errorMessage );
%Docstring
This signal is fired when an async request initiated with
fetchStacObjectAsync is finished. The parsed STAC object can be
retrieved using takeStacObject
:param id: The requestId attribute of the finished request
:param errorMessage: Reason the request or parsing of the STAC object
may have failed
.. seealso:: :py:func:`fetchStacObjectAsync`
.. seealso:: :py:func:`takeStacObject`
%End
void finishedItemCollectionRequest( int id, QString errorMessage );
%Docstring
This signal is fired when an async request initiated with
fetchItemCollectionAsync is finished. The parsed STAC item collection
can be retrieved using takeItemCollection
:param id: The requestId attribute of the finished request
:param errorMessage: Reason the request or parsing of the STAC item
collection may have failed
.. seealso:: :py:func:`fetchItemCollectionAsync`
.. seealso:: :py:func:`takeItemCollection`
%End
void finishedCollectionsRequest( int id, QString errorMessage );
%Docstring
This signal is fired when an async request initiated with
fetchCollectionsAsync is finished. The parsed STAC collections
collection can be retrieved using takeCollections
:param id: The requestId attribute of the finished request
:param errorMessage: Reason the request or parsing of the STAC
collections may have failed
.. seealso:: :py:func:`fetchCollectionsAsync`
.. seealso:: :py:func:`takeCollections`
.. versionadded:: 3.42
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccontroller.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

197
python/PyQt6/core/auto_generated/stac/qgsstacdataitems.sip.in Normal file
View File

@ -0,0 +1,197 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacdataitems.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacFetchMoreItem : QgsDataItem
{
%Docstring(signature="appended")
Item to display that there are additional STAC items which are not
loaded.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacFetchMoreItem( QgsDataItem *parent, const QString &name );
virtual bool handleDoubleClick();
virtual QVariant sortKey() const;
};
class QgsStacItemItem : QgsDataItem
{
%Docstring(signature="appended")
Item for STAC Items within a catalog or collection.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacItemItem( QgsDataItem *parent, const QString &name, const QString &path );
virtual QVector<QgsDataItem *> createChildren();
virtual bool hasDragEnabled() const;
virtual QgsMimeDataUtils::UriList mimeUris() const;
virtual bool equal( const QgsDataItem *other );
virtual QVariant sortKey() const;
void updateToolTip();
QgsStacController *stacController();
void setStacItem( QgsStacItem *item /Transfer/ );
%MethodCode
sipCpp-> setStacItem( std::unique_ptr< QgsStacItem >( a0 ) );
%End
QgsStacItem *stacItem() const;
%Docstring
does not transfer ownership
%End
public slots:
void itemRequestFinished( int requestId, QString error );
};
class QgsStacCatalogItem : QgsDataCollectionItem
{
%Docstring(signature="appended")
Item for catalogs and collections.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacCatalogItem( QgsDataItem *parent, const QString &name, const QString &path );
virtual QVector<QgsDataItem *> createChildren();
virtual bool equal( const QgsDataItem *other );
virtual QVariant sortKey() const;
void updateToolTip();
void setStacCatalog( QgsStacCatalog *object /Transfer/ ) /HoldGIL/;
%Docstring
takes ownership
%End
%MethodCode
sipCpp->setStacCatalog( std::unique_ptr< QgsStacCatalog>( a0 ) );
%End
QgsStacCatalog *stacCatalog() const;
%Docstring
does not transfer ownership
%End
void fetchMoreChildren();
bool isCatalog() const;
bool isCollection() const;
QgsStacController *stacController() const;
QgsStacCatalog *rootCatalog() const;
QgsStacFetchMoreItem *fetchMoreItem() const;
public slots:
virtual void childrenCreated();
};
class QgsStacConnectionItem : QgsStacCatalogItem
{
%Docstring(signature="appended")
Item for STAC connections, is also a catalog itself.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacConnectionItem( QgsDataItem *parent, const QString &connectionName );
QgsStacController *controller() const;
};
class QgsStacRootItem : QgsConnectionsRootItem
{
%Docstring(signature="appended")
Root item for STAC connections.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacRootItem( QgsDataItem *parent, const QString &name, const QString &path );
virtual QVector<QgsDataItem *> createChildren();
virtual QVariant sortKey() const;
public slots:
void onConnectionsChanged();
};
class QgsStacDataItemProvider : QgsDataItemProvider
{
%Docstring(signature="appended")
Provider for STAC root data item.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
virtual QString name();
virtual QString dataProviderKey() const;
virtual Qgis::DataItemProviderCapabilities capabilities() const;
virtual QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacdataitems.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

103
python/PyQt6/core/auto_generated/stac/qgsstacextent.sip.in Normal file
View File

@ -0,0 +1,103 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacextent.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacExtent
{
%Docstring(signature="appended")
Class for storing a STAC SpatioTemporal extent.
:py:class:`QgsStacExtent` contains one overall spatial extent and one
overall temporal extent It is possible to add further refined sub
extents to better describe clustered data.
All spatial extents are in WGS84 longitude/latitude and elevation in
meters.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacextent.h"
%End
public:
QgsStacExtent();
%Docstring
Default constructor for empty extent
%End
void setSpatialExtent( QgsBox3D extent );
%Docstring
Sets the overall spatial extent to ``extent``
%End
void setSpatialExtent( QgsRectangle extent );
%Docstring
Sets the overall spatial extent to ``extent``
%End
void addDetailedSpatialExtent( QgsBox3D extent );
%Docstring
Adds a more detailed spatial ``extent``
%End
void addDetailedSpatialExtent( QgsRectangle extent );
%Docstring
Adds a more detailed spatial ``extent``
%End
QgsBox3D spatialExtent() const;
%Docstring
Returns the overall spatial extent
%End
void setTemporalExtent( QgsDateTimeRange extent );
%Docstring
Sets the overall temporal extent to ``extent``
%End
void addDetailedTemporalExtent( QgsDateTimeRange extent );
%Docstring
Adds a more detailed temporal ``extent``
%End
QgsDateTimeRange temporalExtent() const;
%Docstring
Returns the overall temporal extent
%End
QVector< QgsBox3D > detailedSpatialExtents() const;
%Docstring
Returns all detailed spatial sub extents defined
%End
QVector< QgsDateTimeRange > detailedTemporalExtents() const;
%Docstring
Returns all detailed temporal sub extents defined
%End
bool hasDetailedSpatialExtents() const;
%Docstring
Returns ``True`` if there are detailed spatial sub extents defined
%End
bool hasDetailedTemporalExtents() const;
%Docstring
Returns ``True`` if there are detailed temporal sub extents defined
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacextent.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

167
python/PyQt6/core/auto_generated/stac/qgsstacitem.sip.in Normal file
View File

@ -0,0 +1,167 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacItem : QgsStacObject
{
%Docstring(signature="appended")
Class for storing a STAC Item's data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacitem.h"
%End
public:
QgsStacItem( const QString &id,
const QString &version,
const QgsGeometry &geometry,
const QVariantMap &properties,
const QVector< QgsStacLink > &links,
const QMap< QString, QgsStacAsset > &assets,
const QgsBox3D &bbox );
%Docstring
Constructs a valid QgsStacItem
:param id: Provider identifier. The ID should be unique within the
Collection that contains the Item.
:param version: The STAC version the Item implements.
:param geometry: The full footprint of the asset represented by this
item, in WGS84
:param properties: A dictionary of additional metadata for the Item.
:param links: List of link objects to resources and related URLs.
:param assets: Dictionary of asset objects that can be downloaded, each
with a unique key.
:param bbox: Bounding Box of the asset represented by this Item.
Required if geometry is not null
%End
virtual Qgis::StacObjectType type() const;
virtual QString toHtml() const;
QgsGeometry geometry() const;
%Docstring
Returns the full footprint of the asset represented by this item, in
WGS84
%End
void setGeometry( const QgsGeometry &geometry );
%Docstring
Sets the full footprint of the asset represented by this item, in WGS84
%End
QgsBox3D boundingBox() const;
%Docstring
Returns the STAC item's spatial extent in WGS84 coordinates
%End
void setBoundingBox( const QgsBox3D &bbox );
%Docstring
Sets the STAC item's spatial extent in WGS84 coordinates to ``bbox``
%End
QVariantMap properties() const;
%Docstring
Returns a dictionary of additional metadata for the Item.
%End
void setProperties( const QVariantMap &properties );
%Docstring
Sets the item's additional metadata to ``properties``
%End
QMap< QString, QgsStacAsset > assets() const;
%Docstring
Returns a dictionary of asset objects that can be downloaded, each with
a unique key.
%End
void setAssets( const QMap< QString, QgsStacAsset > &assets );
%Docstring
Sets the ``asset`` objects that can be downloaded, each with a unique
key.
%End
QString collection() const;
%Docstring
Returns the id of the STAC Collection this Item references to
%End
void setCollection( const QString &collection );
%Docstring
Sets the id of the STAC Collection this Item references to
%End
QDateTime dateTime() const;
%Docstring
Returns the single nominal date/time for the item, stored in the item's
``properties``(). If a temporal interval is more appropriate for this
item then a null QDateTime is returned and the interval may be retrieved
with :py:func:`~QgsStacItem.dateTimeRange`
.. seealso:: :py:func:`hasDateTimeRange`
.. seealso:: :py:func:`dateTimeRange`
%End
bool hasDateTimeRange() const;
%Docstring
Returns ``True`` if a temporal interval is available for this item,
``False`` if a single QDateTime is available.
.. seealso:: :py:func:`hasDateTimeRange`
.. seealso:: :py:func:`dateTime`
%End
QgsDateTimeRange dateTimeRange() const;
%Docstring
Returns the temporal interval stored in the item's ``properties``()
.. seealso:: :py:func:`hasDateTimeRange`
.. seealso:: :py:func:`dateTime`
%End
QString title() const;
%Docstring
Returns an optional human readable title describing the Item.
.. versionadded:: 3.42
%End
QString description() const;
%Docstring
Returns a Detailed multi-line description to fully explain the Item.
CommonMark 0.29 syntax may be used for rich text representation.
.. versionadded:: 3.42
%End
QgsMimeDataUtils::UriList uris() const;
%Docstring
Returns a list of uris of all assets that have a cloud optimized format
like COG or COPC
.. versionadded:: 3.42
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

105
python/PyQt6/core/auto_generated/stac/qgsstacitemcollection.sip.in Normal file
View File

@ -0,0 +1,105 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacitemcollection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacItemCollection
{
%Docstring(signature="appended")
Class for storing a STAC Item Collections.
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.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacitemcollection.h"
%End
public:
QgsStacItemCollection( const QVector< QgsStacItem * > &items, const QVector< QgsStacLink > &links, int numberMatched = -1 );
%Docstring
Constructs a valid item collection
:param items: The STAC Items in the item collection, ownership is
transferred
:param links: A list of references to other documents.
:param 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.
%End
~QgsStacItemCollection();
QVector< QgsStacItem * > items() const;
%Docstring
Returns the items in the collection Ownership is not transferred
%End
QVector< QgsStacItem * > takeItems();
%Docstring
Returns the items in the collection Caller takes ownership of the
returned items
%End
QUrl url() const;
%Docstring
Returns the url of the item collection's "self" link
%End
QUrl rootUrl() const;
%Docstring
Returns the url of the item collection's "root" link
%End
QUrl parentUrl() const;
%Docstring
Returns the url of the item collection's "parent" link
%End
QUrl collectionUrl() const;
%Docstring
Returns the url of the item collection's "collection" link
%End
QUrl nextUrl() const;
%Docstring
Returns the url of the item collection's "next" link
%End
int numberReturned() const;
%Docstring
Returns the number of items in the collection
%End
int numberMatched() const;
%Docstring
Returns the total number of items in the parent collection If this
information was not available by the STAC server, -1 is returned
%End
private:
QgsStacItemCollection( const QgsStacItemCollection &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacitemcollection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

67
python/PyQt6/core/auto_generated/stac/qgsstaclink.sip.in Normal file
View File

@ -0,0 +1,67 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaclink.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacLink
{
%Docstring(signature="appended")
Class for storing data associated with a STAC link.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaclink.h"
%End
public:
QgsStacLink( const QString &href, const QString &relation, const QString &mediaType, const QString &title );
%Docstring
Constructor
:param href: The actual link in the format of an URL.
:param relation: Relationship between the parent document and the linked
document.
:param mediaType: Media type of the referenced entity
:param title: A human readable title to be used in rendered displays of
the link.
%End
QString href() const;
%Docstring
Returns the actual link in the format of an URL.
%End
QString relation() const;
%Docstring
Returns the relationship between the parent document and the linked
document.
%End
QString mediaType() const;
%Docstring
Returns the Media type of the referenced entity
%End
QString title() const;
%Docstring
Returns a human readable title to be used in rendered displays of the
link.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaclink.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

109
python/PyQt6/core/auto_generated/stac/qgsstacobject.sip.in Normal file
View File

@ -0,0 +1,109 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacobject.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacObject
{
%Docstring(signature="appended")
Abstract base class for storing STAC objects.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacobject.h"
%End
public:
QgsStacObject( const QString &id, const QString &version, const QVector< QgsStacLink > &links );
%Docstring
Constructor for valid objects
%End
virtual ~QgsStacObject();
virtual Qgis::StacObjectType type() const = 0;
%Docstring
Returns the ``Type`` of the STAC object
%End
virtual QString toHtml() const = 0;
%Docstring
Returns an HTML representation of the STAC object
%End
QString stacVersion() const;
%Docstring
Returns the STAC version the object implements
%End
void setStacVersion( const QString &stacVersion );
%Docstring
Sets the STAC version the object implements
%End
QStringList stacExtensions() const;
%Docstring
Returns the list of extensions the STAC object implements
%End
void setStacExtensions( const QStringList &stacExtensions );
%Docstring
Sets the list of ``stacExtensions`` the object implements
%End
QString id() const;
%Docstring
Id of the STAC object
%End
void setId( const QString &id );
%Docstring
Sets the ``id`` for the STAC object
%End
QVector< QgsStacLink > links() const;
%Docstring
Returns the STAC links included in the object
%End
void setLinks( const QVector< QgsStacLink > &links );
%Docstring
Sets the STAC links included in the object
%End
QString url() const;
%Docstring
Return the url stored in the object's "self" link
%End
QString rootUrl() const;
%Docstring
Return the url stored in the object's "root" link
%End
QString parentUrl() const;
%Docstring
Return the url stored in the object's "parent" link
%End
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacobject.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

83
python/PyQt6/core/auto_generated/stac/qgsstacparser.sip.in Normal file
View File

@ -0,0 +1,83 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacparser.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacParser
{
%Docstring(signature="appended")
SpatioTemporal Asset Catalog JSON parser.
This class parses json data and creates the appropriate STAC Catalog,
Collection, Item or ItemCollection.
%End
%TypeHeaderCode
#include "qgsstacparser.h"
%End
public:
QgsStacParser();
%Docstring
Default constructor
%End
void setData( const QByteArray &data );
%Docstring
Sets the JSON \data to be parsed
%End
void setBaseUrl( const QUrl &url );
%Docstring
Sets the base ``url`` that will be used to resolve relative links. If
not called, relative links will not be resolved to absolute links.
%End
QgsStacCatalog *catalog() /Factory/;
%Docstring
Returns the parsed STAC Catalog If parsing failed, ``None`` is returned
The caller takes ownership of the returned catalog
%End
%MethodCode
sipRes = sipCpp->catalog().release();
%End
QgsStacCollectionList *collections();
%Docstring
Returns the parsed STAC API Collections If parsing failed, ``None`` is
returned The caller takes ownership of the returned collections
%End
Qgis::StacObjectType type() const;
%Docstring
Returns the type of the parsed object
%End
QString error() const;
%Docstring
Returns the last parsing error
%End
private:
QgsStacParser( const QgsStacParser &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacparser.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

79
python/PyQt6/core/auto_generated/stac/qgsstacprovider.sip.in Normal file
View File

@ -0,0 +1,79 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacProvider
{
%Docstring(signature="appended")
Class for storing a STAC collection's provider data.
The object provides information about a provider. A provider is any of
the organizations that captures or processes the content of the
Collection and therefore influences the data offered by this Collection.
May also include information about the final storage provider hosting
the data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacprovider.h"
%End
public:
QgsStacProvider( const QString &name, const QString &description, const QStringList &roles, const QString &url );
%Docstring
QgsStacProvider constructor
:param name: The name of the organization or the individual.
:param description: Multi-line description to add further provider
information such as processing details for
processors and producers, hosting details for hosts
or basic contact information. CommonMark 0.29 syntax
MAY be used for rich text representation.
:param roles: Roles of the provider. Any of licensor, producer,
processor or host.
:param url: Homepage on which the provider describes the dataset and
publishes contact information.
%End
QString name() const;
%Docstring
Returns the name of the organization or the individual.
%End
QString description() const;
%Docstring
Returns a multi-line description to add further provider information
such as processing details for processors and producers, hosting details
for hosts or basic contact information. CommonMark 0.29 syntax MAY be
used for rich text representation.
%End
QStringList roles() const;
%Docstring
Returns the roles of the provider. Any of licensor, producer, processor
or host.
%End
QString url() const;
%Docstring
Returns the url of a homepage on which the provider describes the
dataset and publishes contact information.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

92
python/core/auto_generated/stac/qgsstacasset.sip.in Normal file
View File

@ -0,0 +1,92 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacasset.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacAsset
{
%Docstring(signature="appended")
Class for storing a STAC asset's data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacasset.h"
%End
public:
QgsStacAsset( const QString &href,
const QString &title,
const QString &description,
const QString &mediaType,
const QStringList &roles );
%Docstring
Constructor
%End
QString href() const;
%Docstring
Returns the URI to the asset object
%End
QString title() const;
%Docstring
Returns the displayed title for clients and users.
%End
QString description() const;
%Docstring
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.
%End
QString mediaType() const;
%Docstring
Returns the media type of the asset
%End
QStringList roles() const;
%Docstring
Returns the roles assigned to the asset. Roles are used to describe the
purpose of the asset (eg. thumbnail, data etc).
%End
bool isCloudOptimized() const;
%Docstring
Returns whether the asset is in a cloud optimized format like COG or
COPC
.. versionadded:: 3.42
%End
QString formatName() const;
%Docstring
Returns the format name for cloud optimized formats
.. versionadded:: 3.42
%End
QgsMimeDataUtils::Uri uri() const;
%Docstring
Returns a uri for the asset if it is a cloud optimized file like COG or
COPC
.. versionadded:: 3.42
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacasset.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

92
python/core/auto_generated/stac/qgsstaccatalog.sip.in Normal file
View File

@ -0,0 +1,92 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccatalog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacCatalog : QgsStacObject
{
%Docstring(signature="appended")
Class for storing a STAC Catalog's data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaccatalog.h"
%End
public:
QgsStacCatalog( const QString &id,
const QString &version,
const QString &description,
const QVector< QgsStacLink > &links );
%Docstring
Constructs a valid QgsStacCatalog
:param id: A unique identifier for the catalog
:param version: The STAC version the Catalog implements.
:param description: Detailed multi-line description to fully explain the
Catalog. CommonMark 0.29 syntax may be used for rich
text representation.
:param links: A list of references to other documents.
%End
virtual Qgis::StacObjectType type() const;
virtual QString toHtml() const;
QString title() const;
%Docstring
Returns a short descriptive one-line title for the Catalog.
%End
void setTitle( const QString &title );
%Docstring
Sets a short descriptive one-line ``title`` for the Catalog.
%End
QString description() const;
%Docstring
Returns a Detailed multi-line description to fully explain the Catalog.
CommonMark 0.29 syntax may be used for rich text representation.
%End
void setDescription( const QString &description );
%Docstring
Sets a detailed multi-line ``description`` to fully explain the Catalog.
CommonMark 0.29 syntax may be used for rich text representation.
%End
void setConformanceClasses( const QStringList &conformanceClasses );
%Docstring
Sets the list of ``conformanceClasses`` this catalog conforms to.
%End
void addConformanceClass( const QString &conformanceClass );
%Docstring
Adds ``conformanceClass`` to the list of catalog's conformance classes
%End
bool conformsTo( const QString &conformanceClass ) const;
%Docstring
Checks if the catalog is a STAC API conforming to the specified
``conformanceClass``
%End
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccatalog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

128
python/core/auto_generated/stac/qgsstaccollection.sip.in Normal file
View File

@ -0,0 +1,128 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccollection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacCollection : QgsStacCatalog
{
%Docstring(signature="appended")
Class for storing a STAC Collection's data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaccollection.h"
%End
public:
QgsStacCollection( const QString &id,
const QString &version,
const QString &description,
const QVector< QgsStacLink > &links,
const QString &license,
const QgsStacExtent &extent );
%Docstring
Constructs a valid QgsStacCollection
:param id: Identifier for the Collection that is unique across the
provider.
:param version: The STAC version the Collection implements.
:param description: Detailed multi-line description to fully explain the
Collection. CommonMark 0.29 syntax MAY be used for
rich text representation.
:param links: A list of references to other documents.
:param license: Collection's license(s), either a SPDX License
identifier, various if multiple licenses apply or
proprietary for all other cases.
:param extent: Spatial and temporal extents of the collection.
%End
virtual Qgis::StacObjectType type() const;
virtual QString toHtml() const;
QStringList keywords() const;
%Docstring
Returns the list of keywords describing the Collection
%End
void setKeywords( const QStringList &keywords );
%Docstring
Sets the list of ``keywords`` describing the Collection
%End
QString license() const;
%Docstring
Returns the Collection's license(s), either a SPDX License identifier,
various if multiple licenses apply or proprietary for all other cases.
%End
void setLicense( const QString &license );
%Docstring
Sets the Collection's license(s), either a SPDX License identifier,
various if multiple licenses apply or proprietary for all other cases.
%End
QVector<QgsStacProvider> providers() const;
%Docstring
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.
%End
void setProviders( const QVector<QgsStacProvider> &providers );
%Docstring
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.
%End
QgsStacExtent extent() const;
%Docstring
Returns the collection's spatial and temporal extent
%End
void setExtent( const QgsStacExtent &extent );
%Docstring
Sets the collection's spatial and temporal extent
%End
QVariantMap summaries() const;
%Docstring
Returns a map of property summaries from the collection
%End
void setSummaries( const QVariantMap &summaries );
%Docstring
Sets the map of property summaries to the collection
%End
QMap<QString, QgsStacAsset> assets() const;
%Docstring
Returns a dictionary of asset objects in the catalog, each with a unique
id key.
%End
void setAssets( const QMap<QString, QgsStacAsset> &assets );
%Docstring
Sets the asset objects in the catalog, each with a unique id key.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccollection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

95
python/core/auto_generated/stac/qgsstaccollectionlist.sip.in Normal file
View File

@ -0,0 +1,95 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccollectionlist.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacCollectionList
{
%Docstring(signature="appended")
Class for storing a list of STAC Collections, which is typically used to
store the data returned by STAC API /collections endpoint.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaccollectionlist.h"
%End
public:
QgsStacCollectionList( const QVector< QgsStacCollection * > collections, const QVector< QgsStacLink > links, int numberMatched = -1 );
%Docstring
Constructs a valid list of collections,
:param collections: The STAC Collections to be stored, ownership is
transferred
:param links: A list of references to other documents.
:param numberMatched: The total number of collections in the parent
catalog, collection or total matching results from
a STAC API endpoint
.. note::
ownership of ``collections`` is transferred. Collections will be deleted when object is destroyed.
%End
~QgsStacCollectionList();
QVector< QgsStacCollection * > collections() const;
%Docstring
Returns the collections Ownership is not transferred
%End
QVector< QgsStacCollection * > takeCollections();
%Docstring
Returns the collections Caller takes ownership of the returned
collections
%End
int numberReturned() const;
%Docstring
Returns the number of returned collections
%End
int numberMatched() const;
%Docstring
Returns the total number of available collections If this information
was not available by the STAC server, -1 is returned
%End
QUrl url() const;
%Docstring
Returns the url of the collections' "self" link
%End
QUrl rootUrl() const;
%Docstring
Returns the url of the collections' "root" link
%End
QUrl nextUrl() const;
%Docstring
Returns the url of the collections' "next" link
%End
QUrl prevUrl() const;
%Docstring
Returns the url of the collections' "prev" link
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccollectionlist.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

96
python/core/auto_generated/stac/qgsstacconnection.sip.in Normal file
View File

@ -0,0 +1,96 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacconnection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacConnection : QgsAbstractProviderConnection
{
%Docstring(signature="appended")
Represents connections to STAC catalogs.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacconnection.h"
%End
public:
QgsStacConnection( const QString &name );
%Docstring
Constructor for QgsStacConnection, using the stored settings with the
specified connection ``name``.
%End
QgsStacConnection( const QString &uri, const QVariantMap &configuration );
%Docstring
Constructor for QgsStacConnection, using the a specific connection
details.
%End
virtual void store( const QString &name ) const;
virtual void remove( const QString &name ) const;
struct Data
{
QString url;
QString authCfg;
QString username;
QString password;
QgsHttpHeaders httpHeaders;
};
static QString encodedUri( const Data &conn );
%Docstring
Returns connection data encoded as a string
%End
static Data decodedUri( const QString &uri );
%Docstring
Decodes connection string to a data structure
%End
static QStringList connectionList();
%Docstring
Returns list of existing connections, unless the hidden ones
%End
static Data connection( const QString &name );
%Docstring
Returns connection details
%End
static void deleteConnection( const QString &name );
%Docstring
Removes a connection from the list
%End
static void addConnection( const QString &name, const Data &conn );
%Docstring
Adds a new connection to the list
%End
static QString selectedConnection();
%Docstring
Returns last used connection
%End
static void setSelectedConnection( const QString &connName );
%Docstring
Saves name of the last used connection
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacconnection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

210
python/core/auto_generated/stac/qgsstaccontroller.sip.in Normal file
View File

@ -0,0 +1,210 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccontroller.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacController : QObject
{
%Docstring(signature="appended")
The :py:class:`QgsStacController` class handles STAC requests.
Contains methods to generate STAC objects from local and remote urls.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaccontroller.h"
%End
public:
explicit QgsStacController();
%Docstring
Default constructor
%End
~QgsStacController();
std::unique_ptr< QgsStacCatalog > openLocalCatalog( const QString &fileName ) const;
%Docstring
Returns a STAC Catalog by parsing a local file The caller takes
ownership of the returned catalog
%End
std::unique_ptr< QgsStacCollection > openLocalCollection( const QString &fileName ) const;
%Docstring
Returns a STAC Collection by parsing a local file The caller takes
ownership of the returned collection
%End
std::unique_ptr< QgsStacItem > openLocalItem( const QString &fileName ) const;
%Docstring
Returns a STAC Item by parsing a local file The caller takes ownership
of the returned item
%End
std::unique_ptr< QgsStacItemCollection > fetchItemCollection( const QUrl &url, QString *error = 0 );
%Docstring
Fetches a feature collection from ``url`` using a blocking network
request. An optional ``error`` parameter will be populated with any
network error information. The caller takes ownership of the returned
feature collection
%End
std::unique_ptr< QgsStacCollectionList > fetchCollections( const QUrl &url, QString *error = 0 );
%Docstring
Fetches collections from ``url`` using a blocking network request. An
optional ``error`` parameter will be populated with any network error
information. The caller takes ownership of the returned feature
collection
%End
int fetchStacObjectAsync( const QUrl &url );
%Docstring
Initiates an asynchronous request for a STAC object using the ``url``
and returns an associated request id. When the request is completed, the
:py:func:`~QgsStacController.finishedStacObjectRequest` signal is fired
and the stac object can be accessed with
:py:func:`~QgsStacController.takeStacObject`
%End
int fetchItemCollectionAsync( const QUrl &url );
%Docstring
Initiates an asynchronous request for a feature collection using the
``url`` and returns an associated request id. When the request is
completed, the
:py:func:`~QgsStacController.finishedItemCollectionRequest` signal is
fired and the feature collection can be accessed with
:py:func:`~QgsStacController.takeItemCollection`
%End
int fetchCollectionsAsync( const QUrl &url );
%Docstring
Initiates an asynchronous request for a Collections collection using the
``url`` and returns an associated request id. When the request is
completed, the :py:func:`~QgsStacController.finishedCollectionsRequest`
signal is fired and the collections can be accessed with
:py:func:`~QgsStacController.takeCollections`
.. versionadded:: 3.42
%End
void cancelPendingAsyncRequests();
%Docstring
Cancels all pending async requests
.. versionadded:: 3.42
%End
std::unique_ptr< QgsStacItemCollection > takeItemCollection( int requestId );
%Docstring
Returns the feature collection fetched with the specified ``requestId``
It should be used after the finishedItemCollectionRequest signal is
fired to get the fetched STAC item collection. Returns ``None`` if the
requestId was not found, request was canceled, request failed or parsing
the STAC object failed. The caller takes ownership of the returned
feature collection
.. seealso:: :py:func:`fetchItemCollectionAsync`
.. seealso:: :py:func:`finishedItemCollectionRequest`
%End
std::unique_ptr< QgsStacCollectionList > takeCollections( int requestId );
%Docstring
Returns the collections collection fetched with the specified
``requestId`` It should be used after the finishedCollectionsRequest
signal is fired to get the fetched STAC collections. Returns ``None`` if
the requestId was not found, request was canceled, request failed or
parsing the STAC object failed. The caller takes ownership of the
returned collections
.. seealso:: :py:func:`fetchCollectionsAsync`
.. seealso:: :py:func:`finishedCollectionsRequest`
.. versionadded:: 3.42
%End
QString authCfg() const;
%Docstring
Returns the authentication config id which will be used during the
request.
.. seealso:: :py:func:`setAuthCfg`
%End
void setAuthCfg( const QString &authCfg );
%Docstring
Sets the authentication config id which should be used during the
request.
.. seealso:: :py:func:`authCfg`
%End
signals:
void finishedStacObjectRequest( int id, QString errorMessage );
%Docstring
This signal is fired when an async request initiated with
fetchStacObjectAsync is finished. The parsed STAC object can be
retrieved using takeStacObject
:param id: The requestId attribute of the finished request
:param errorMessage: Reason the request or parsing of the STAC object
may have failed
.. seealso:: :py:func:`fetchStacObjectAsync`
.. seealso:: :py:func:`takeStacObject`
%End
void finishedItemCollectionRequest( int id, QString errorMessage );
%Docstring
This signal is fired when an async request initiated with
fetchItemCollectionAsync is finished. The parsed STAC item collection
can be retrieved using takeItemCollection
:param id: The requestId attribute of the finished request
:param errorMessage: Reason the request or parsing of the STAC item
collection may have failed
.. seealso:: :py:func:`fetchItemCollectionAsync`
.. seealso:: :py:func:`takeItemCollection`
%End
void finishedCollectionsRequest( int id, QString errorMessage );
%Docstring
This signal is fired when an async request initiated with
fetchCollectionsAsync is finished. The parsed STAC collections
collection can be retrieved using takeCollections
:param id: The requestId attribute of the finished request
:param errorMessage: Reason the request or parsing of the STAC
collections may have failed
.. seealso:: :py:func:`fetchCollectionsAsync`
.. seealso:: :py:func:`takeCollections`
.. versionadded:: 3.42
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaccontroller.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

197
python/core/auto_generated/stac/qgsstacdataitems.sip.in Normal file
View File

@ -0,0 +1,197 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacdataitems.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacFetchMoreItem : QgsDataItem
{
%Docstring(signature="appended")
Item to display that there are additional STAC items which are not
loaded.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacFetchMoreItem( QgsDataItem *parent, const QString &name );
virtual bool handleDoubleClick();
virtual QVariant sortKey() const;
};
class QgsStacItemItem : QgsDataItem
{
%Docstring(signature="appended")
Item for STAC Items within a catalog or collection.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacItemItem( QgsDataItem *parent, const QString &name, const QString &path );
virtual QVector<QgsDataItem *> createChildren();
virtual bool hasDragEnabled() const;
virtual QgsMimeDataUtils::UriList mimeUris() const;
virtual bool equal( const QgsDataItem *other );
virtual QVariant sortKey() const;
void updateToolTip();
QgsStacController *stacController();
void setStacItem( QgsStacItem *item /Transfer/ );
%MethodCode
sipCpp-> setStacItem( std::unique_ptr< QgsStacItem >( a0 ) );
%End
QgsStacItem *stacItem() const;
%Docstring
does not transfer ownership
%End
public slots:
void itemRequestFinished( int requestId, QString error );
};
class QgsStacCatalogItem : QgsDataCollectionItem
{
%Docstring(signature="appended")
Item for catalogs and collections.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacCatalogItem( QgsDataItem *parent, const QString &name, const QString &path );
virtual QVector<QgsDataItem *> createChildren();
virtual bool equal( const QgsDataItem *other );
virtual QVariant sortKey() const;
void updateToolTip();
void setStacCatalog( QgsStacCatalog *object /Transfer/ ) /HoldGIL/;
%Docstring
takes ownership
%End
%MethodCode
sipCpp->setStacCatalog( std::unique_ptr< QgsStacCatalog>( a0 ) );
%End
QgsStacCatalog *stacCatalog() const;
%Docstring
does not transfer ownership
%End
void fetchMoreChildren();
bool isCatalog() const;
bool isCollection() const;
QgsStacController *stacController() const;
QgsStacCatalog *rootCatalog() const;
QgsStacFetchMoreItem *fetchMoreItem() const;
public slots:
virtual void childrenCreated();
};
class QgsStacConnectionItem : QgsStacCatalogItem
{
%Docstring(signature="appended")
Item for STAC connections, is also a catalog itself.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacConnectionItem( QgsDataItem *parent, const QString &connectionName );
QgsStacController *controller() const;
};
class QgsStacRootItem : QgsConnectionsRootItem
{
%Docstring(signature="appended")
Root item for STAC connections.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
QgsStacRootItem( QgsDataItem *parent, const QString &name, const QString &path );
virtual QVector<QgsDataItem *> createChildren();
virtual QVariant sortKey() const;
public slots:
void onConnectionsChanged();
};
class QgsStacDataItemProvider : QgsDataItemProvider
{
%Docstring(signature="appended")
Provider for STAC root data item.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsstacdataitems.h"
%End
public:
virtual QString name();
virtual QString dataProviderKey() const;
virtual Qgis::DataItemProviderCapabilities capabilities() const;
virtual QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacdataitems.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

103
python/core/auto_generated/stac/qgsstacextent.sip.in Normal file
View File

@ -0,0 +1,103 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacextent.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacExtent
{
%Docstring(signature="appended")
Class for storing a STAC SpatioTemporal extent.
:py:class:`QgsStacExtent` contains one overall spatial extent and one
overall temporal extent It is possible to add further refined sub
extents to better describe clustered data.
All spatial extents are in WGS84 longitude/latitude and elevation in
meters.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacextent.h"
%End
public:
QgsStacExtent();
%Docstring
Default constructor for empty extent
%End
void setSpatialExtent( QgsBox3D extent );
%Docstring
Sets the overall spatial extent to ``extent``
%End
void setSpatialExtent( QgsRectangle extent );
%Docstring
Sets the overall spatial extent to ``extent``
%End
void addDetailedSpatialExtent( QgsBox3D extent );
%Docstring
Adds a more detailed spatial ``extent``
%End
void addDetailedSpatialExtent( QgsRectangle extent );
%Docstring
Adds a more detailed spatial ``extent``
%End
QgsBox3D spatialExtent() const;
%Docstring
Returns the overall spatial extent
%End
void setTemporalExtent( QgsDateTimeRange extent );
%Docstring
Sets the overall temporal extent to ``extent``
%End
void addDetailedTemporalExtent( QgsDateTimeRange extent );
%Docstring
Adds a more detailed temporal ``extent``
%End
QgsDateTimeRange temporalExtent() const;
%Docstring
Returns the overall temporal extent
%End
QVector< QgsBox3D > detailedSpatialExtents() const;
%Docstring
Returns all detailed spatial sub extents defined
%End
QVector< QgsDateTimeRange > detailedTemporalExtents() const;
%Docstring
Returns all detailed temporal sub extents defined
%End
bool hasDetailedSpatialExtents() const;
%Docstring
Returns ``True`` if there are detailed spatial sub extents defined
%End
bool hasDetailedTemporalExtents() const;
%Docstring
Returns ``True`` if there are detailed temporal sub extents defined
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacextent.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

167
python/core/auto_generated/stac/qgsstacitem.sip.in Normal file
View File

@ -0,0 +1,167 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacItem : QgsStacObject
{
%Docstring(signature="appended")
Class for storing a STAC Item's data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacitem.h"
%End
public:
QgsStacItem( const QString &id,
const QString &version,
const QgsGeometry &geometry,
const QVariantMap &properties,
const QVector< QgsStacLink > &links,
const QMap< QString, QgsStacAsset > &assets,
const QgsBox3D &bbox );
%Docstring
Constructs a valid QgsStacItem
:param id: Provider identifier. The ID should be unique within the
Collection that contains the Item.
:param version: The STAC version the Item implements.
:param geometry: The full footprint of the asset represented by this
item, in WGS84
:param properties: A dictionary of additional metadata for the Item.
:param links: List of link objects to resources and related URLs.
:param assets: Dictionary of asset objects that can be downloaded, each
with a unique key.
:param bbox: Bounding Box of the asset represented by this Item.
Required if geometry is not null
%End
virtual Qgis::StacObjectType type() const;
virtual QString toHtml() const;
QgsGeometry geometry() const;
%Docstring
Returns the full footprint of the asset represented by this item, in
WGS84
%End
void setGeometry( const QgsGeometry &geometry );
%Docstring
Sets the full footprint of the asset represented by this item, in WGS84
%End
QgsBox3D boundingBox() const;
%Docstring
Returns the STAC item's spatial extent in WGS84 coordinates
%End
void setBoundingBox( const QgsBox3D &bbox );
%Docstring
Sets the STAC item's spatial extent in WGS84 coordinates to ``bbox``
%End
QVariantMap properties() const;
%Docstring
Returns a dictionary of additional metadata for the Item.
%End
void setProperties( const QVariantMap &properties );
%Docstring
Sets the item's additional metadata to ``properties``
%End
QMap< QString, QgsStacAsset > assets() const;
%Docstring
Returns a dictionary of asset objects that can be downloaded, each with
a unique key.
%End
void setAssets( const QMap< QString, QgsStacAsset > &assets );
%Docstring
Sets the ``asset`` objects that can be downloaded, each with a unique
key.
%End
QString collection() const;
%Docstring
Returns the id of the STAC Collection this Item references to
%End
void setCollection( const QString &collection );
%Docstring
Sets the id of the STAC Collection this Item references to
%End
QDateTime dateTime() const;
%Docstring
Returns the single nominal date/time for the item, stored in the item's
``properties``(). If a temporal interval is more appropriate for this
item then a null QDateTime is returned and the interval may be retrieved
with :py:func:`~QgsStacItem.dateTimeRange`
.. seealso:: :py:func:`hasDateTimeRange`
.. seealso:: :py:func:`dateTimeRange`
%End
bool hasDateTimeRange() const;
%Docstring
Returns ``True`` if a temporal interval is available for this item,
``False`` if a single QDateTime is available.
.. seealso:: :py:func:`hasDateTimeRange`
.. seealso:: :py:func:`dateTime`
%End
QgsDateTimeRange dateTimeRange() const;
%Docstring
Returns the temporal interval stored in the item's ``properties``()
.. seealso:: :py:func:`hasDateTimeRange`
.. seealso:: :py:func:`dateTime`
%End
QString title() const;
%Docstring
Returns an optional human readable title describing the Item.
.. versionadded:: 3.42
%End
QString description() const;
%Docstring
Returns a Detailed multi-line description to fully explain the Item.
CommonMark 0.29 syntax may be used for rich text representation.
.. versionadded:: 3.42
%End
QgsMimeDataUtils::UriList uris() const;
%Docstring
Returns a list of uris of all assets that have a cloud optimized format
like COG or COPC
.. versionadded:: 3.42
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

105
python/core/auto_generated/stac/qgsstacitemcollection.sip.in Normal file
View File

@ -0,0 +1,105 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacitemcollection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacItemCollection
{
%Docstring(signature="appended")
Class for storing a STAC Item Collections.
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.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacitemcollection.h"
%End
public:
QgsStacItemCollection( const QVector< QgsStacItem * > &items, const QVector< QgsStacLink > &links, int numberMatched = -1 );
%Docstring
Constructs a valid item collection
:param items: The STAC Items in the item collection, ownership is
transferred
:param links: A list of references to other documents.
:param 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.
%End
~QgsStacItemCollection();
QVector< QgsStacItem * > items() const;
%Docstring
Returns the items in the collection Ownership is not transferred
%End
QVector< QgsStacItem * > takeItems();
%Docstring
Returns the items in the collection Caller takes ownership of the
returned items
%End
QUrl url() const;
%Docstring
Returns the url of the item collection's "self" link
%End
QUrl rootUrl() const;
%Docstring
Returns the url of the item collection's "root" link
%End
QUrl parentUrl() const;
%Docstring
Returns the url of the item collection's "parent" link
%End
QUrl collectionUrl() const;
%Docstring
Returns the url of the item collection's "collection" link
%End
QUrl nextUrl() const;
%Docstring
Returns the url of the item collection's "next" link
%End
int numberReturned() const;
%Docstring
Returns the number of items in the collection
%End
int numberMatched() const;
%Docstring
Returns the total number of items in the parent collection If this
information was not available by the STAC server, -1 is returned
%End
private:
QgsStacItemCollection( const QgsStacItemCollection &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacitemcollection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

67
python/core/auto_generated/stac/qgsstaclink.sip.in Normal file
View File

@ -0,0 +1,67 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaclink.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacLink
{
%Docstring(signature="appended")
Class for storing data associated with a STAC link.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstaclink.h"
%End
public:
QgsStacLink( const QString &href, const QString &relation, const QString &mediaType, const QString &title );
%Docstring
Constructor
:param href: The actual link in the format of an URL.
:param relation: Relationship between the parent document and the linked
document.
:param mediaType: Media type of the referenced entity
:param title: A human readable title to be used in rendered displays of
the link.
%End
QString href() const;
%Docstring
Returns the actual link in the format of an URL.
%End
QString relation() const;
%Docstring
Returns the relationship between the parent document and the linked
document.
%End
QString mediaType() const;
%Docstring
Returns the Media type of the referenced entity
%End
QString title() const;
%Docstring
Returns a human readable title to be used in rendered displays of the
link.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstaclink.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

109
python/core/auto_generated/stac/qgsstacobject.sip.in Normal file
View File

@ -0,0 +1,109 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacobject.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacObject
{
%Docstring(signature="appended")
Abstract base class for storing STAC objects.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacobject.h"
%End
public:
QgsStacObject( const QString &id, const QString &version, const QVector< QgsStacLink > &links );
%Docstring
Constructor for valid objects
%End
virtual ~QgsStacObject();
virtual Qgis::StacObjectType type() const = 0;
%Docstring
Returns the ``Type`` of the STAC object
%End
virtual QString toHtml() const = 0;
%Docstring
Returns an HTML representation of the STAC object
%End
QString stacVersion() const;
%Docstring
Returns the STAC version the object implements
%End
void setStacVersion( const QString &stacVersion );
%Docstring
Sets the STAC version the object implements
%End
QStringList stacExtensions() const;
%Docstring
Returns the list of extensions the STAC object implements
%End
void setStacExtensions( const QStringList &stacExtensions );
%Docstring
Sets the list of ``stacExtensions`` the object implements
%End
QString id() const;
%Docstring
Id of the STAC object
%End
void setId( const QString &id );
%Docstring
Sets the ``id`` for the STAC object
%End
QVector< QgsStacLink > links() const;
%Docstring
Returns the STAC links included in the object
%End
void setLinks( const QVector< QgsStacLink > &links );
%Docstring
Sets the STAC links included in the object
%End
QString url() const;
%Docstring
Return the url stored in the object's "self" link
%End
QString rootUrl() const;
%Docstring
Return the url stored in the object's "root" link
%End
QString parentUrl() const;
%Docstring
Return the url stored in the object's "parent" link
%End
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacobject.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

83
python/core/auto_generated/stac/qgsstacparser.sip.in Normal file
View File

@ -0,0 +1,83 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacparser.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacParser
{
%Docstring(signature="appended")
SpatioTemporal Asset Catalog JSON parser.
This class parses json data and creates the appropriate STAC Catalog,
Collection, Item or ItemCollection.
%End
%TypeHeaderCode
#include "qgsstacparser.h"
%End
public:
QgsStacParser();
%Docstring
Default constructor
%End
void setData( const QByteArray &data );
%Docstring
Sets the JSON \data to be parsed
%End
void setBaseUrl( const QUrl &url );
%Docstring
Sets the base ``url`` that will be used to resolve relative links. If
not called, relative links will not be resolved to absolute links.
%End
QgsStacCatalog *catalog() /Factory/;
%Docstring
Returns the parsed STAC Catalog If parsing failed, ``None`` is returned
The caller takes ownership of the returned catalog
%End
%MethodCode
sipRes = sipCpp->catalog().release();
%End
QgsStacCollectionList *collections();
%Docstring
Returns the parsed STAC API Collections If parsing failed, ``None`` is
returned The caller takes ownership of the returned collections
%End
Qgis::StacObjectType type() const;
%Docstring
Returns the type of the parsed object
%End
QString error() const;
%Docstring
Returns the last parsing error
%End
private:
QgsStacParser( const QgsStacParser &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacparser.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/

79
python/core/auto_generated/stac/qgsstacprovider.sip.in Normal file
View File

@ -0,0 +1,79 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsStacProvider
{
%Docstring(signature="appended")
Class for storing a STAC collection's provider data.
The object provides information about a provider. A provider is any of
the organizations that captures or processes the content of the
Collection and therefore influences the data offered by this Collection.
May also include information about the final storage provider hosting
the data.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsstacprovider.h"
%End
public:
QgsStacProvider( const QString &name, const QString &description, const QStringList &roles, const QString &url );
%Docstring
QgsStacProvider constructor
:param name: The name of the organization or the individual.
:param description: Multi-line description to add further provider
information such as processing details for
processors and producers, hosting details for hosts
or basic contact information. CommonMark 0.29 syntax
MAY be used for rich text representation.
:param roles: Roles of the provider. Any of licensor, producer,
processor or host.
:param url: Homepage on which the provider describes the dataset and
publishes contact information.
%End
QString name() const;
%Docstring
Returns the name of the organization or the individual.
%End
QString description() const;
%Docstring
Returns a multi-line description to add further provider information
such as processing details for processors and producers, hosting details
for hosts or basic contact information. CommonMark 0.29 syntax MAY be
used for rich text representation.
%End
QStringList roles() const;
%Docstring
Returns the roles of the provider. Any of licensor, producer, processor
or host.
%End
QString url() const;
%Docstring
Returns the url of a homepage on which the provider describes the
dataset and publishes contact information.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/stac/qgsstacprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/