ResInsight/ApplicationCode/ProjectDataModel/Flow/RimWellRftPlot.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2017     Statoil 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 "RimViewWindow.h"

#include "RifDataSourceForRftPltQMetaType.h"

#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "cafPdmPtrField.h"
#include "cvfCollection.h"

#include <QDate>
#include <QMetaType>
#include <QPointer>

#include <map>
#include <set>
#include <utility>

class RimEclipseCase;
class RimEclipseResultCase;
class RimWellLogCurve;
class RimWellLogFileChannel;
class RimWellLogPlot;
class RimWellPath;
class RiuWellRftPlot;
class RigEclipseCaseData;
class RiaRftPltCurveDefinition;
class RifDataSourceForRftPlt;

namespace cvf {
    class Color3f;
}

namespace caf {
    class PdmOptionItemInfo;
}


//==================================================================================================
///  
///  
//==================================================================================================
class RimWellRftPlot : public RimViewWindow
{
    CAF_PDM_HEADER_INIT;

    static const std::set<QString> PRESSURE_DATA_NAMES;
    static const char PLOT_NAME_QFORMAT_STRING[];

public:
    RimWellRftPlot();
    ~RimWellRftPlot() override;

    void               setDescription(const QString& description);
    QString            description() const;

    QWidget*           viewWidget() override;
    void               zoomAll() override;

    RimWellLogPlot*    wellLogPlot() const;

    void               setSimWellOrWellPathName(const QString& currWellName);

    int                branchIndex() const;

    void               applyInitialSelections();

    static const char* plotNameFormatString();

protected:
    // Overridden PDM methods
    caf::PdmFieldHandle*                userDescriptionField() override { return &m_userName; }
    void                                fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue) override;
    void                                defineUiTreeOrdering(caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName) override;

    QList<caf::PdmOptionItemInfo>       calculateValueOptions(const caf::PdmFieldHandle* fieldNeedingOptions, bool * useOptionsOnly) override;

    QImage                              snapshotWindowContent() override;


    void                                defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering) override;
    void                                onLoadDataAndUpdate() override;

private:
    void                                calculateValueOptionsForWells(QList<caf::PdmOptionItemInfo>& options);
    void                                updateEditorsFromCurves();
    void                                updateWidgetTitleWindowTitle();
    void                                syncCurvesFromUiSelection();
    void                                assignWellPathToExtractionCurves();

    std::set<RiaRftPltCurveDefinition>  selectedCurveDefs() const;
    std::set<RiaRftPltCurveDefinition>  curveDefsFromCurves() const;

    void                                updateCurvesInPlot(const std::set<RiaRftPltCurveDefinition>& allCurveDefs,
                                                           const std::set<RiaRftPltCurveDefinition>& curveDefsToAdd,
                                                           const std::set<RimWellLogCurve*>&         curvesToDelete);

    std::vector<RifDataSourceForRftPlt> selectedSourcesExpanded() const;

    // RimViewWindow overrides

    QWidget*                            createViewWidget(QWidget* mainWindowParent) override; 
    void                                deleteViewWidget() override; 

    void                                applyCurveAppearance(RimWellLogCurve* newCurve);

    void                                updateFormationsOnPlot() const;
    QString                             associatedSimWellName() const;

private:
    caf::PdmField<bool>                             m_showPlotTitle;
    caf::PdmField<QString>                          m_userName;

    caf::PdmField<QString>                          m_wellPathNameOrSimWellName;
    caf::PdmField<int>                              m_branchIndex;
    caf::PdmField<bool>                             m_branchDetection;

    caf::PdmField<std::vector<RifDataSourceForRftPlt>>   m_selectedSources;
    
    caf::PdmField<std::vector<QDateTime>>           m_selectedTimeSteps;

    caf::PdmChildField<RimWellLogPlot*>             m_wellLogPlot;

    QPointer<RiuWellRftPlot>                        m_wellLogPlotWidget;

    bool m_isOnLoad;
};