qgssensorthingsutils.h

Go to the documentation of this file.

/***************************************************************************
    qgssensorthingsutils.h
    --------------------
    begin                : November 2023
    copyright            : (C) 2023 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSSENSORTHINGSUTILS_H
#define QGSSENSORTHINGSUTILS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsFields;
class QgsFeedback;
class QgsRectangle;
class QgsSensorThingsExpansionDefinition;

class CORE_EXPORT QgsSensorThingsUtils
{
  public:
    static constexpr int DEFAULT_PAGE_SIZE = 200 SIP_SKIP;

    static constexpr int DEFAULT_FEATURE_LIMIT = 10000 SIP_SKIP;

    static constexpr int DEFAULT_EXPANSION_LIMIT = 100 SIP_SKIP;

    static Qgis::SensorThingsEntity stringToEntity( const QString &type );

    static QString displayString( Qgis::SensorThingsEntity type, bool plural = false );

    static Qgis::SensorThingsEntity entitySetStringToEntity( const QString &type );

    static QString entityToSetString( Qgis::SensorThingsEntity type );

    static QStringList propertiesForEntityType( Qgis::SensorThingsEntity type );

    static QgsFields fieldsForEntityType( Qgis::SensorThingsEntity type, bool includeRangeFieldProxies = true );

    static QgsFields fieldsForExpandedEntityType( Qgis::SensorThingsEntity baseType, const QList< Qgis::SensorThingsEntity > &expandedTypes );

    static QString geometryFieldForEntityType( Qgis::SensorThingsEntity type );

    static bool entityTypeHasGeometry( Qgis::SensorThingsEntity type );

    static Qgis::GeometryType geometryTypeForEntity( Qgis::SensorThingsEntity type );

    static QString filterForWkbType( Qgis::SensorThingsEntity entityType, Qgis::WkbType wkbType );

    static QString filterForExtent( const QString &geometryField, const QgsRectangle &extent );

    static QString combineFilters( const QStringList &filters );

    struct ServiceCapabilities
    {
        Qgis::SensorThingsVersion version = Qgis::SensorThingsVersion::Version1_1;
        Qgis::SensorThingsExtensions availableExtensions;
        QSet< Qgis::SensorThingsEntity > availableEntities;
    };

    static ServiceCapabilities determineServiceCapabilities( const QString &uri, QgsFeedback *feedback = nullptr, const QString &authCfg = QString() );

    static QList< Qgis::GeometryType > availableGeometryTypes( const QString &uri, Qgis::SensorThingsEntity type, QgsFeedback *feedback = nullptr, const QString &authCfg = QString() );

    static QList< Qgis::SensorThingsEntity > expandableTargets( Qgis::SensorThingsEntity type );

    static Qgis::RelationshipCardinality relationshipCardinality( Qgis::SensorThingsEntity baseType, Qgis::SensorThingsEntity relatedType, bool &valid SIP_OUT );

    static QString asQueryString( Qgis::SensorThingsEntity baseType, const QList< QgsSensorThingsExpansionDefinition > &expansions );
};
 

class CORE_EXPORT QgsSensorThingsExpansionDefinition
{
  public:
    QgsSensorThingsExpansionDefinition(
      Qgis::SensorThingsEntity childEntity = Qgis::SensorThingsEntity::Invalid,
      const QString &orderBy = QString(),
      Qt::SortOrder sortOrder = Qt::SortOrder::AscendingOrder,
      int limit = QgsSensorThingsUtils::DEFAULT_EXPANSION_LIMIT,
      const QString &filter = QString()
    );

    static QgsSensorThingsExpansionDefinition defaultDefinitionForEntity( Qgis::SensorThingsEntity entity );

    bool isValid() const;

    Qgis::SensorThingsEntity childEntity() const;

    void setChildEntity( Qgis::SensorThingsEntity entity );

    QString orderBy() const;

    void setOrderBy( const QString &field );

    Qt::SortOrder sortOrder() const;

    void setSortOrder( Qt::SortOrder order );

    int limit() const;

    void setLimit( int limit );

    QString filter() const;

    void setFilter( const QString &filter );

    QString toString() const;

    static QgsSensorThingsExpansionDefinition fromString( const QString &string );

    QString asQueryString( Qgis::SensorThingsEntity parentEntityType, const QStringList &additionalOptions = QStringList() ) const;
 
    bool operator==( const QgsSensorThingsExpansionDefinition &other ) const;
    bool operator!=( const QgsSensorThingsExpansionDefinition &other ) const;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    if ( !sipCpp->isValid() )
    {
      sipRes = PyUnicode_FromString( "<QgsSensorThingsExpansionDefinition: invalid>" );
    }
    else
    {
      QString innerDefinition;
      if ( !sipCpp->orderBy().isEmpty() )
      {
        innerDefinition = u"by %1 (%2)"_s.arg( sipCpp->orderBy(), sipCpp->sortOrder() == Qt::SortOrder::AscendingOrder ? u"asc"_s : u"desc"_s );
      }
      if ( sipCpp->limit() >= 0 )
      {
        if ( !innerDefinition.isEmpty() )
          innerDefinition = u"%1, limit %2"_s.arg( innerDefinition ).arg( sipCpp->limit() );
        else
          innerDefinition = u"limit %1"_s.arg( sipCpp->limit() );
      }
      if ( !sipCpp->filter().isEmpty() )
      {
        if ( !innerDefinition.isEmpty() )
          innerDefinition = u"%1, filter '%2'"_s.arg( innerDefinition ).arg( sipCpp->filter() );
        else
          innerDefinition = u"filter '%1'"_s.arg( sipCpp->filter() );
      }
 
      QString str = u"<QgsSensorThingsExpansionDefinition: %1%2>"_s.arg( qgsEnumValueToKey( sipCpp->childEntity() ), innerDefinition.isEmpty() ? QString() : ( u" "_s + innerDefinition ) );
      sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    }
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
 
    Qgis::SensorThingsEntity mChildEntity
    = Qgis::SensorThingsEntity::Invalid;
    QString mOrderBy;
    Qt::SortOrder mSortOrder = Qt::SortOrder::AscendingOrder;
    int mLimit = QgsSensorThingsUtils::DEFAULT_EXPANSION_LIMIT;
    QString mFilter;
};
Q_DECLARE_METATYPE( QgsSensorThingsExpansionDefinition )
 
#endif // QGSSENSORTHINGSUTILS_H