/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2016  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 "RifSummaryReaderInterface.h"

#include "RimSummaryCase.h"

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

#include <memory>

class RifEclipseSummaryAddress;

//==================================================================================================
///
//==================================================================================================
enum class DerivedSummaryOperator
{
    DERIVED_OPERATOR_SUB,
    DERIVED_OPERATOR_ADD
};

//==================================================================================================
//
//==================================================================================================
class RimDeltaSummaryCase : public RimSummaryCase, public RifSummaryReaderInterface
{
    CAF_PDM_HEADER_INIT;

public:
    enum class FixedTimeStepMode
    {
        FIXED_TIME_STEP_NONE,
        FIXED_TIME_STEP_CASE_1,
        FIXED_TIME_STEP_CASE_2
    };

public:
    RimDeltaSummaryCase();

    void setInUse( bool inUse );
    bool isInUse() const;
    void setSummaryCases( RimSummaryCase* sumCase1, RimSummaryCase* sumCase2 );
    void setOperator( DerivedSummaryOperator oper );
    void setFixedTimeSteps( int fixedTimeStepCase1, int fixedTimeStepCase2 );

    bool needsCalculation( const RifEclipseSummaryAddress& address ) const;

    std::string unitName( const RifEclipseSummaryAddress& resultAddress ) const override;

    std::vector<time_t>                  timeSteps( const RifEclipseSummaryAddress& resultAddress ) const override;
    std::pair<bool, std::vector<double>> values( const RifEclipseSummaryAddress& resultAddress ) const override;
    RiaDefines::EclipseUnitSystem        unitSystem() const override;

    static std::pair<std::vector<time_t>, std::vector<double>> calculateDerivedValues( RifSummaryReaderInterface*      reader1,
                                                                                       int                             fixedTimeStepCase1,
                                                                                       RifSummaryReaderInterface*      reader2,
                                                                                       int                             fixedTimeStepCase2,
                                                                                       DerivedSummaryOperator          m_operator,
                                                                                       const RifEclipseSummaryAddress& address,
                                                                                       bool includeIncompleteCurves );

    void                       createSummaryReaderInterface() override;
    RifSummaryReaderInterface* summaryReader() override;

    void updateDisplayNameFromCases();

    RimSummaryCase* summaryCase1() const;
    RimSummaryCase* summaryCase2() const;

protected:
    QString caseName() const override;

private:
    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;

    void calculate( const RifEclipseSummaryAddress& address ) const;
    void clearData( const RifEclipseSummaryAddress& address ) const;

    void clearCache();

private:
    caf::PdmPtrField<RimSummaryCase*> m_summaryCase1;
    caf::PdmPtrField<RimSummaryCase*> m_summaryCase2;

    caf::PdmField<caf::AppEnum<DerivedSummaryOperator>> m_operator;

    caf::PdmField<caf::AppEnum<FixedTimeStepMode>> m_useFixedTimeStep;
    caf::PdmField<int>                             m_fixedTimeStepIndex;

    caf::PdmField<bool> m_inUse;

    // Local cache considered mutable
    mutable std::map<RifEclipseSummaryAddress, std::pair<std::vector<time_t>, std::vector<double>>> m_dataCache;
};