/////////////////////////////////////////////////////////////////////////////////
//
//  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 "RiaDefines.h"
#include "RifEclipseSummaryAddress.h"

#include <map>
#include <set>
#include <string>
#include <vector>

class QDateTime;

//==================================================================================================
//
//
//==================================================================================================
class RifSummaryReaderInterface
{
public:
    RifSummaryReaderInterface();
    virtual ~RifSummaryReaderInterface() = default;

    bool hasAddress( const RifEclipseSummaryAddress& resultAddress ) const;

    const std::set<RifEclipseSummaryAddress>& allResultAddresses() const;
    const std::set<RifEclipseSummaryAddress>& allErrorAddresses() const;

    RifEclipseSummaryAddress errorAddress( const RifEclipseSummaryAddress& resultAddress ) const;

    virtual std::vector<time_t> timeSteps( const RifEclipseSummaryAddress& resultAddress ) const = 0;

    virtual std::pair<bool, std::vector<double>> values( const RifEclipseSummaryAddress& resultAddress ) const = 0;

    virtual std::string                   unitName( const RifEclipseSummaryAddress& resultAddress ) const = 0;
    virtual RiaDefines::EclipseUnitSystem unitSystem() const                                              = 0;

    virtual void createAndSetAddresses();
    void         createAddressesIfRequired();

    // Recreate the addresses provided by calculation objects. Does nothing if no addresses have been created yet, as the calculated
    // addresses in that case are created as part of createAddressesIfRequired().
    virtual void refreshCalculatedAddresses();

    int serialNumber() const;

    // Returns the number of result addresses. If no addresses are present, keywordCount() is returned.
    size_t dataObjectCount() const;

    // The keywordCount is considered a internal method, not to be used by clients. Having it as a protected method will not work well, as
    // this class is also used as a contained object in addition to deriving from this interface.
    virtual size_t keywordCount() const = 0;

protected:
    void increaseSerialNumber();

    std::set<RifEclipseSummaryAddress> m_allResultAddresses; // Result and error addresses
    std::set<RifEclipseSummaryAddress> m_allErrorAddresses; // Error addresses

private:
    static int m_nextSerialNumber;
    int        m_serialNumber;
};