/////////////////////////////////////////////////////////////////////////////////
//
//  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 "RimAbstractPlotCollection.h"

#include "cafPdmChildArrayField.h"
#include "cafPdmChildField.h"
#include "cafPdmObject.h"

class RimWellAllocationOverTimePlot;
class RimWellAllocationPlot;
class RimFlowCharacteristicsPlot;
class RimWellDistributionPlot;
class RimWellDistributionPlotCollection;
class RimWellConnectivityTable;

//==================================================================================================
///
///
//==================================================================================================
class RimFlowPlotCollection : public caf::PdmObject, public RimPlotCollection
{
    CAF_PDM_HEADER_INIT;

public:
    RimFlowPlotCollection();
    ~RimFlowPlotCollection() override;

    void   deleteAllPlots() override;
    void   loadDataAndUpdateAllPlots() override;
    size_t plotCount() const override;

    void                               addWellAllocPlotToStoredPlots( RimWellAllocationPlot* plot );
    void                               addFlowCharacteristicsPlotToStoredPlots( RimFlowCharacteristicsPlot* plot );
    RimWellConnectivityTable*          defaultWellConnectivityTable();
    RimWellAllocationOverTimePlot*     defaultWellAllocOverTimePlot();
    RimWellAllocationPlot*             defaultWellAllocPlot();
    RimFlowCharacteristicsPlot*        defaultFlowCharacteristicsPlot();
    RimWellDistributionPlotCollection* wellDistributionPlotCollection() const;
    void                               ensureDefaultFlowPlotsAreCreated();

private:
    caf::PdmChildField<RimFlowCharacteristicsPlot*>        m_flowCharacteristicsPlot;
    caf::PdmChildField<RimWellConnectivityTable*>          m_defaultWellConnectivityTable;
    caf::PdmChildField<RimWellAllocationOverTimePlot*>     m_defaultWellAllocOverTimePlot;
    caf::PdmChildField<RimWellAllocationPlot*>             m_defaultWellAllocPlot;
    caf::PdmChildField<RimWellDistributionPlotCollection*> m_wellDistributionPlotCollection;
    caf::PdmChildArrayField<RimWellAllocationPlot*>        m_storedWellAllocPlots;
    caf::PdmChildArrayField<RimFlowCharacteristicsPlot*>   m_storedFlowCharacteristicsPlots;
};