/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2011-     Statoil ASA
//  Copyright (C) 2013-     Ceetron Solutions AS
//  Copyright (C) 2011-2012 Ceetron AS
// 
//  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 "cvfBase.h"
#include "cvfObject.h"

#include <QStringList>
#include <QDateTime>

#include <vector>

#include "ert/ecl_well/well_info.h"

#include "RifReaderInterface.h"


class RifKeywordLocation
{
public:
    RifKeywordLocation(const std::string& keyword, size_t itemCount, int indexWithinReportStep)
        : m_keyword(keyword),
        m_itemCount(itemCount),
        m_indexWithinReportStep(indexWithinReportStep)
    {
    }

    std::string keyword() const         { return m_keyword; }
    size_t itemCount() const            { return m_itemCount; }
    int indexWithinReportStep() const   { return m_indexWithinReportStep; }

private:
    std::string m_keyword;
    size_t      m_itemCount;
    int         m_indexWithinReportStep;
};

class RifRestartReportKeywords
{
public:
    RifRestartReportKeywords();

    void appendKeyword(const std::string& keyword, size_t itemCount, int globalIndex);

    std::vector<std::string> keywordsWithItemCountFactorOf(const std::vector<size_t>& factorCandidates);
    std::vector<std::pair<std::string, size_t> > keywordsWithAggregatedItemCount();

private:
    std::vector<RifKeywordLocation> objectsForKeyword(const std::string& keyword);
    std::set<std::string> uniqueKeywords();

private:
    std::vector<RifKeywordLocation> m_keywordNameAndItemCount;
};


class RifRestartReportStep
{
public:
    //int globalIndex;
    QDateTime dateTime;

    RifRestartReportKeywords m_keywords;
};

//==================================================================================================
//
// Abstract class for results access
//
//==================================================================================================
class RifEclipseRestartDataAccess : public cvf::Object
{
public:
    RifEclipseRestartDataAccess();
    virtual ~RifEclipseRestartDataAccess();

    virtual bool                open() = 0;
    virtual void                setRestartFiles(const QStringList& fileSet) = 0;
    virtual void                close() = 0;

    virtual void                setTimeSteps(const std::vector<QDateTime>& timeSteps) {};
    virtual size_t              timeStepCount() = 0;
    virtual void                timeSteps(std::vector<QDateTime>* timeSteps, std::vector<double>* daysSinceSimulationStart) = 0;
    virtual std::vector<int>    reportNumbers() = 0;

    virtual void                resultNames(QStringList* resultNames, std::vector<size_t>* resultDataItemCounts) = 0;
    virtual bool                results(const QString& resultName, size_t timeStep, size_t gridCount, std::vector<double>* values) = 0;

    virtual bool                dynamicNNCResults(const ecl_grid_type* grid, size_t timeStep, std::vector<double>* waterFlux, std::vector<double>* oilFlux, std::vector<double>* gasFlux) = 0;

    virtual void                readWellData(well_info_type * well_info, bool importCompleteMswData) = 0;
    virtual int                 readUnitsType() = 0;

    virtual std::set<RiaDefines::PhaseType> availablePhases() const = 0;
};