qgsmeshdataprovider.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmeshdataprovider.h
                         ---------------------
    begin                : April 2018
    copyright            : (C) 2018 by Peter Petrik
    email                : zilolv 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 QGSMESHDATAPROVIDER_H
#define QGSMESHDATAPROVIDER_H
 
#include <limits>
 
#include "qgis_core.h"
#include "qgsdataprovider.h"
#include "qgsmeshdataprovidertemporalcapabilities.h"
#include "qgsmeshdataset.h"
#include "qgsmeshutils.h"
#include "qgsprovidermetadata.h"
 
#include <QMap>
#include <QPair>
#include <QString>
#include <QVector>
 
#ifdef SIP_RUN
// clang-format off
% ModuleHeaderCode
#include "qgsmeshutils.h"
% End
// clang-format on
#endif
 
  class QgsRectangle;

struct CORE_EXPORT QgsMesh
{
    enum ElementType
    {
      Vertex = 1,
      Edge = 2,
      Face = 4
    };

    bool contains( const ElementType &type ) const;

    int vertexCount() const;
    int faceCount() const;

    int edgeCount() const;

    QgsMeshVertex vertex( int index ) const;
    QgsMeshFace face( int index ) const;

    QgsMeshEdge edge( int index ) const;

    void clear();

    static bool compareFaces( const QgsMeshFace &face1, const QgsMeshFace &face2 );
 
    QVector<QgsMeshVertex> vertices SIP_SKIP;
    QVector<QgsMeshEdge> edges SIP_SKIP;
    QVector<QgsMeshFace> faces SIP_SKIP;
};
 
// we need to declare metatype so QgsMesh can be passed as QVariant for expressions
Q_DECLARE_METATYPE( QgsMesh );
 

class CORE_EXPORT QgsMeshDataSourceInterface SIP_ABSTRACT
{
  public:
    virtual ~QgsMeshDataSourceInterface() = default;

    bool contains( const QgsMesh::ElementType &type ) const;

    virtual int vertexCount() const = 0;

    virtual int faceCount() const = 0;

    virtual int edgeCount() const = 0;

    virtual int maximumVerticesCountPerFace() const { return 0; };

    virtual void populateMesh( QgsMesh *mesh ) const = 0;

    virtual bool saveMeshFrame( const QgsMesh &mesh ) = 0;
};

class CORE_EXPORT QgsMeshDatasetSourceInterface SIP_ABSTRACT
{
  public:
    QgsMeshDatasetSourceInterface();
    virtual ~QgsMeshDatasetSourceInterface() = default;

    virtual bool addDataset( const QString &uri ) = 0;

    virtual QStringList extraDatasets() const = 0;

    virtual int datasetGroupCount() const = 0;

    virtual int datasetCount( int groupIndex ) const = 0;

    int datasetCount( QgsMeshDatasetIndex index ) const;

    virtual QgsMeshDatasetGroupMetadata datasetGroupMetadata( int groupIndex ) const = 0;

    QgsMeshDatasetGroupMetadata datasetGroupMetadata( QgsMeshDatasetIndex index ) const;

    virtual QgsMeshDatasetMetadata datasetMetadata( QgsMeshDatasetIndex index ) const = 0;

    virtual QgsMeshDatasetValue datasetValue( QgsMeshDatasetIndex index, int valueIndex ) const = 0;

    virtual QgsMeshDataBlock datasetValues( QgsMeshDatasetIndex index, int valueIndex, int count ) const = 0;

    virtual QgsMesh3DDataBlock dataset3dValues( QgsMeshDatasetIndex index, int faceIndex, int count ) const = 0;

    virtual bool isFaceActive( QgsMeshDatasetIndex index, int faceIndex ) const = 0;

    virtual QgsMeshDataBlock areFacesActive( QgsMeshDatasetIndex index, int faceIndex, int count ) const = 0;

    Q_DECL_DEPRECATED virtual bool persistDatasetGroup(
      const QString &path, const QgsMeshDatasetGroupMetadata &meta, const QVector<QgsMeshDataBlock> &datasetValues, const QVector<QgsMeshDataBlock> &datasetActive, const QVector<double> &times
    ) SIP_DEPRECATED;

    virtual bool persistDatasetGroup(
      const QString &outputFilePath,
      const QString &outputDriver,
      const QgsMeshDatasetGroupMetadata &meta,
      const QVector<QgsMeshDataBlock> &datasetValues,
      const QVector<QgsMeshDataBlock> &datasetActive,
      const QVector<double> &times
    ) = 0;
 

    virtual bool persistDatasetGroup( const QString &outputFilePath, const QString &outputDriver, QgsMeshDatasetSourceInterface *source, int datasetGroupIndex ) = 0;

    QgsMeshDatasetIndex datasetIndexAtTime( const QDateTime &referenceTime, int groupIndex, qint64 time, QgsMeshDataProviderTemporalCapabilities::MatchingTemporalDatasetMethod method ) const;

    QList<QgsMeshDatasetIndex> datasetIndexInTimeInterval( const QDateTime &referenceTime, int groupIndex, qint64 time1, qint64 time2 ) const;
 
  protected:
    std::unique_ptr<QgsMeshDataProviderTemporalCapabilities> mTemporalCapabilities;
};
 

class CORE_EXPORT QgsMeshDataProvider : public QgsDataProvider, public QgsMeshDataSourceInterface, public QgsMeshDatasetSourceInterface
{
    Q_OBJECT
  public:
    QgsMeshDataProvider( const QString &uri, const QgsDataProvider::ProviderOptions &providerOptions, Qgis::DataProviderReadFlags = Qgis::DataProviderReadFlags() );
 
    QgsMeshDataProviderTemporalCapabilities *temporalCapabilities() override;
    const QgsMeshDataProviderTemporalCapabilities *temporalCapabilities() const override SIP_SKIP;

    void setTemporalUnit( Qgis::TemporalUnit unit );
 

    virtual QgsMeshDriverMetadata driverMetadata() const;
 

    virtual void close() = 0;

    virtual bool removeDatasetGroup( int index ) = 0;
 
  signals:
    void datasetGroupsAdded( int count );
};
 
#endif // QGSMESHDATAPROVIDER_H