ResInsight/ApplicationLibCode/ProjectDataModel/Formations/RimFormationNames.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 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 "cafPdmField.h"
#include "cafPdmObject.h"

#include <expected>
#include <memory>

class RigFormationNames;

class QTextStream;

//==================================================================================================
///
//==================================================================================================
class RimFormationNames : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    RimFormationNames();
    ~RimFormationNames() override;

    void    setFileName( const QString& fileName );
    QString fileName();
    QString shortName();

    const RigFormationNames* formationNamesData() const;

    void updateConnectedViews();

    std::expected<void, QString> readFormationNamesFile();

    static QString layerZoneTableFileName();

protected:
    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;

    void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName = "" ) override;

private:
    void updateUiTreeName();

private:
    caf::PdmField<caf::FilePath> m_formationNamesFileName;

    std::unique_ptr<RigFormationNames> m_formationNamesData;
};