ResInsight/ApplicationLibCode/FileInterface/RifEclipseRftAddress.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 "RiaRftDefines.h"

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

#include <QDateTime>

//==================================================================================================
///
///
//==================================================================================================
class RifEclipseRftAddress
{
public:
    enum class RftWellLogChannelType
    {
        NONE,
        TVD,
        PRESSURE,
        SWAT,
        SOIL,
        SGAS,
        WRAT,
        ORAT,
        GRAT,
        MD,
        PRESSURE_P10,
        PRESSURE_P50,
        PRESSURE_P90,
        PRESSURE_MEAN,
        PRESSURE_ERROR,
        SEGMENT_VALUES
    };

public:
    static RifEclipseRftAddress createAddress( const QString& wellName, const QDateTime& timeStep, RftWellLogChannelType wellLogChannel );

    static RifEclipseRftAddress createSegmentAddress( const QString& wellName, const QDateTime& dateTime, const QString& resultName );

    static RifEclipseRftAddress createBranchSegmentAddress( const QString&            wellName,
                                                            const QDateTime&          dateTime,
                                                            const QString&            resultName,
                                                            int                       segmentBranchIndex,
                                                            RiaDefines::RftBranchType segmentBranchType );

    QString                   segmentResultName() const;
    int                       segmentBranchIndex() const;
    RiaDefines::RftBranchType segmentBranchType() const;

    const QString&               wellName() const;
    QDateTime                    timeStep() const;
    const RftWellLogChannelType& wellLogChannel() const;

    static std::set<RftWellLogChannelType> rftPlotChannelTypes();
    static std::set<RftWellLogChannelType> pltPlotChannelTypes();

private:
    RifEclipseRftAddress( const QString&            wellName,
                          const QDateTime&          timeStep,
                          RftWellLogChannelType     wellLogChannel,
                          const QString&            segmentResultName,
                          int                       segmentBranchIndex,
                          RiaDefines::RftBranchType segmentBranchType );

private:
    QString               m_wellName;
    QDateTime             m_timeStep;
    RftWellLogChannelType m_wellLogChannel;

    QString                   m_segmentResultName;
    int                       m_segmentBranchIndex;
    RiaDefines::RftBranchType m_segmentBranchType;
};

bool operator==( const RifEclipseRftAddress& first, const RifEclipseRftAddress& second );

bool operator<( const RifEclipseRftAddress& first, const RifEclipseRftAddress& second );