qgslayermetadata.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayermetadata.h
                             -------------------
    begin                : April 2017
    copyright            : (C) 2017 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 QGSLAYERMETADATA_H
#define QGSLAYERMETADATA_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractmetadatabase.h"
#include "qgsbox3d.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsrange.h"
 
class QgsMapLayer;

class CORE_EXPORT QgsLayerMetadata : public QgsAbstractMetadataBase
{
    Q_GADGET
 
    Q_PROPERTY( QStringList rights READ rights )
    Q_PROPERTY( QStringList licenses READ licenses )
 
  public:
    struct CORE_EXPORT SpatialExtent
    {
        QgsCoordinateReferenceSystem extentCrs;

        QgsBox3D bounds;
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsLayerMetadata::SpatialExtent &other ) const;
    };

    struct CORE_EXPORT Extent
    {
      public:
        QList< QgsLayerMetadata::SpatialExtent > spatialExtents() const;

        void setSpatialExtents( const QList< QgsLayerMetadata::SpatialExtent > &extents );

        QList< QgsDateTimeRange > temporalExtents() const;

        void setTemporalExtents( const QList< QgsDateTimeRange > &extents );
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsLayerMetadata::Extent &other ) const;
 
#ifndef SIP_RUN
      private:
        QList< QgsLayerMetadata::SpatialExtent > mSpatialExtents;
        QList< QgsDateTimeRange > mTemporalExtents;
 
#endif
    };

    struct CORE_EXPORT Constraint
    {
        Constraint( const QString &constraint = QString(), const QString &type = QString() )
          : type( type )
          , constraint( constraint )
        {}

        QString type;

        QString constraint;
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsLayerMetadata::Constraint &other ) const;
    };

    typedef QList< QgsLayerMetadata::Constraint > ConstraintList;
 
    QgsLayerMetadata() = default;
 
 
    QgsLayerMetadata *clone() const override SIP_FACTORY;

    QString fees() const;

    void setFees( const QString &fees );

    QgsLayerMetadata::ConstraintList constraints() const;

    void addConstraint( const QgsLayerMetadata::Constraint &constraint );

    void setConstraints( const QgsLayerMetadata::ConstraintList &constraints );

    QStringList rights() const;

    void setRights( const QStringList &rights );

    QStringList licenses() const;

    void setLicenses( const QStringList &licenses );

    QString encoding() const;

    void setEncoding( const QString &encoding );

    SIP_SKIP const QgsLayerMetadata::Extent &extent() const;

    QgsLayerMetadata::Extent &extent();

    void setExtent( const QgsLayerMetadata::Extent &extent );

    QgsCoordinateReferenceSystem crs() const;

    void setCrs( const QgsCoordinateReferenceSystem &crs );

    void saveToLayer( QgsMapLayer *layer ) const;

    void readFromLayer( const QgsMapLayer *layer );
 
    bool readMetadataXml( const QDomElement &metadataElement, const QgsReadWriteContext &context = QgsReadWriteContext() ) override;
    bool writeMetadataXml( QDomElement &metadataElement, QDomDocument &document, const QgsReadWriteContext &context = QgsReadWriteContext() ) const override;
    void combine( const QgsAbstractMetadataBase *other ) override;
    void registerTranslations( QgsTranslationContext *translationContext ) const override;
 
    bool operator==( const QgsLayerMetadata &metadataOther ) const;

    bool contains( const QString &searchString ) const;

    bool matches( const QVector<QRegularExpression> &searchReList ) const;
 
  private:
    /*
     * IMPORTANT!!!!!!
     *
     * Do NOT add anything to this class without also updating the schema
     * definition located at resources/qgis-resource-metadata.xsd
     *
     */
 
    QString mFees;
    ConstraintList mConstraints;
    QStringList mRights;
    QStringList mLicenses;
 
    // IMPORTANT - look up before adding anything here!!
 
    QString mEncoding;
    QgsCoordinateReferenceSystem mCrs;
 
    Extent mExtent;
 
    /*
     * IMPORTANT!!!!!!
     *
     * Do NOT add anything to this class without also updating the schema
     * definition located at resources/qgis-resource-metadata.xsd
     *
     */
};
 
Q_DECLARE_METATYPE( QgsLayerMetadata::ConstraintList )
Q_DECLARE_METATYPE( QgsLayerMetadata::Extent )
Q_DECLARE_METATYPE( QgsLayerMetadata )
 
#endif // QGSLAYERMETADATA_H