ResInsight/ApplicationLibCode/ProjectDataModel/Cloud/RimCloudDataSourceCollection.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2024     Equinor ASA
//
//  ResInsight 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 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
//
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "cafPdmChildArrayField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"

#include "Cloud/RiaSumoConnector.h"

#include <QPointer>
#include <QString>

class RimSumoDataSource;

//==================================================================================================
///
///
//==================================================================================================
class RimCloudDataSourceCollection : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    RimCloudDataSourceCollection();

    static RimCloudDataSourceCollection* instance();

    std::vector<RimSumoDataSource*> sumoDataSources() const;

    static void createEnsemblesFromSelectedDataSources( const std::vector<RimSumoDataSource*>& dataSources );

private:
    void initAfterRead() override;

    // Fetch the realization ids, vector names and grid names of the data sources that do not have them. They
    // are not written to the project file, so a data source restored from one starts out without them.
    void refreshDataSourcesFromSumo();

    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;

    QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions ) override;
    void                          defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
    void defineEditorAttribute( const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute ) override;

    std::vector<RimSumoDataSource*> addDataSources();
    void                            addEnsembles();

    static bool isCloudApiServerAvailable();

    // The option lists are rebuilt every time the property editor refreshes, so what Sumo answered is kept
    // here and only asked for again when the selection it belongs to changes.
    const std::vector<SumoAsset>& cachedAssets();
    const std::vector<SumoCase>&  cachedCases( const QString& assetName );
    const std::vector<QString>&   cachedEnsembleNames( const SumoCaseId& caseId );

    void clearCachedCases();

    void clearCachedEnsembleNames();

private:
    caf::PdmField<bool>                 m_authenticate;
    caf::PdmField<QString>              m_sumoFieldName;
    caf::PdmField<QString>              m_sumoCaseId;
    caf::PdmField<std::vector<QString>> m_sumoEnsembleNames;

    caf::PdmField<bool>                         m_addDataSources;
    caf::PdmField<bool>                         m_addEnsembles;
    caf::PdmChildArrayField<RimSumoDataSource*> m_sumoDataSources;

    caf::PdmField<bool> m_startServer;
    caf::PdmField<bool> m_stopServer;
    caf::PdmField<bool> m_restartServer;

    QPointer<RiaSumoConnector> m_sumoConnector;

    std::vector<SumoAsset> m_assets;

    QString               m_casesAssetName;
    std::vector<SumoCase> m_cases;

    QString              m_ensembleNamesCaseId;
    std::vector<QString> m_ensembleNames;
};