qgsmeshdatasetgroupstore.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmeshdatasetgroupstore.h
                         ---------------------
    begin                : June 2020
    copyright            : (C) 2020 by Vincent Cloarec
    email                : vcloarec 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 QGSMESHDATASETGROUPSTORE_H
#define QGSMESHDATASETGROUPSTORE_H
 
 
#include "qgsmeshdataprovider.h"
#include "qgsmeshdataset.h"
 
#define SIP_NO_FILE
 
class QgsMeshLayer;

class QgsMeshExtraDatasetStore: public QgsMeshDatasetSourceInterface
{
  public:

    int addDatasetGroup( std::unique_ptr< QgsMeshDatasetGroup > datasetGroup );

    void removeDatasetGroup( int index );

    bool hasTemporalCapabilities() const;

    qint64 datasetRelativeTime( QgsMeshDatasetIndex index ) const;

    QString description( int groupIndex ) const;

    QgsMeshDatasetGroup *datasetGroup( int groupIndex ) const;
 
    int datasetGroupCount() const override;
    int datasetCount( int groupIndex ) const override;
    QgsMeshDatasetGroupMetadata datasetGroupMetadata( int groupIndex ) const override;
    QgsMeshDatasetMetadata datasetMetadata( QgsMeshDatasetIndex index ) const override;
    QgsMeshDatasetValue datasetValue( QgsMeshDatasetIndex index, int valueIndex ) const override;
    QgsMeshDataBlock datasetValues( QgsMeshDatasetIndex index, int valueIndex, int count ) const override;
    QgsMesh3DDataBlock dataset3dValues( QgsMeshDatasetIndex index, int faceIndex, int count ) const override;
    bool isFaceActive( QgsMeshDatasetIndex index, int faceIndex ) const override;
    QgsMeshDataBlock areFacesActive( QgsMeshDatasetIndex index, int faceIndex, int count ) const override;

    bool addDataset( const QString &uri ) override;

    QStringList extraDatasets() const override;
 
    using QgsMeshDatasetSourceInterface::persistDatasetGroup;
    bool persistDatasetGroup( const QString &outputFilePath,
                              const QString &outputDriver,
                              const QgsMeshDatasetGroupMetadata &meta,
                              const QVector<QgsMeshDataBlock> &datasetValues,
                              const QVector<QgsMeshDataBlock> &datasetActive,
                              const QVector<double> &times ) override;

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

    QDomElement writeXml( int groupIndex, QDomDocument &doc, const QgsReadWriteContext &context );

    void updateTemporalCapabilities();
 
  private:
    std::vector<std::unique_ptr<QgsMeshDatasetGroup>> mGroups;
};

class QgsMeshDatasetGroupStore: public QObject
{
    Q_OBJECT

    typedef QPair<QgsMeshDatasetSourceInterface *, int> DatasetGroup;
 
  public:
    explicit QgsMeshDatasetGroupStore( QgsMeshLayer *layer );

    void setPersistentProvider( QgsMeshDataProvider *provider, const QStringList &extraDatasetUri );

    bool addPersistentDatasets( const QString &path );

    bool addDatasetGroup( std::unique_ptr< QgsMeshDatasetGroup > group );

    bool saveDatasetGroup( QString filePath, int groupIndex, QString driver );

    void resetDatasetGroupTreeItem();

    QgsMeshDatasetGroupTreeItem *datasetGroupTreeItem() const;

    void setDatasetGroupTreeItem( const QgsMeshDatasetGroupTreeItem *rootItem );

    QList<int> datasetGroupIndexes() const;

    QList<int> enabledDatasetGroupIndexes() const;

    int datasetGroupCount() const;

    int extraDatasetGroupCount() const;

    int datasetCount( int groupIndex ) const;

    QgsMeshDatasetGroupMetadata datasetGroupMetadata( const QgsMeshDatasetIndex &index ) const;

    QgsMeshDatasetMetadata datasetMetadata( const QgsMeshDatasetIndex &index ) const;

    QgsMeshDatasetValue datasetValue( const QgsMeshDatasetIndex &index, int valueIndex ) const;

    QgsMeshDataBlock datasetValues( const QgsMeshDatasetIndex &index, int valueIndex, int count ) const;

    QgsMesh3DDataBlock dataset3dValues( const QgsMeshDatasetIndex &index, int faceIndex, int count ) const;

    QgsMeshDataBlock areFacesActive( const QgsMeshDatasetIndex &index, int faceIndex, int count ) const;

    bool isFaceActive( const QgsMeshDatasetIndex &index, int faceIndex ) const;

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

    QList<QgsMeshDatasetIndex> datasetIndexInTimeInterval( qint64 time1, qint64 time2, int groupIndex ) const;

    qint64 datasetRelativeTime( const QgsMeshDatasetIndex &index ) const;

    bool hasTemporalCapabilities() const;

    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context );

    void readXml( const QDomElement &storeElem, const QgsReadWriteContext &context );

    int globalDatasetGroupIndexInSource( QgsMeshDatasetSourceInterface *source, int nativeGroupIndex ) const;

    int indexFromGroupName( const QString &groupName ) const;

    QString groupName( int groupIndex ) const;

    void removeDatasetGroup( int groupIndex );
 
  signals:
    void datasetGroupsAdded( QList<int> indexes );
 
  private slots:
    void onPersistentDatasetAdded( int count );
 
  private:
    QgsMeshLayer *mLayer = nullptr;
    QgsMeshDataProvider *mPersistentProvider = nullptr;
    QgsMeshExtraDatasetStore mExtraDatasets;
    QMap < int, DatasetGroup> mRegistry;
    QList<int> mPersistentExtraDatasetGroupIndexes;
    QMap<QString, int> mGroupNameToGlobalIndex;
    std::unique_ptr<QgsMeshDatasetGroupTreeItem> mDatasetGroupTreeRootItem;
 
    void removePersistentProvider();

    void reindexDatasetGroups();
 
    DatasetGroup datasetGroup( int index ) const;

    int newIndex();
 
    int registerDatasetGroup( const DatasetGroup &group );
    void createDatasetGroupTreeItems( const QList<int> &indexes );

    void eraseDatasetGroup( const DatasetGroup &group );

    void eraseExtraDataset( int indexInExtraStore );
 
    void checkDatasetConsistency( QgsMeshDatasetSourceInterface *source );
    void removeUnregisteredItemFromTree();
    void unregisterGroupNotPresentInTree();
 
    void syncItemToDatasetGroup( int groupIndex );
};
 
#endif // QGSMESHDATASETGROUPSTORE_H