ResInsight/ApplicationLibCode/UserInterface/RiuResultTextBuilder.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) Statoil ASA
//  Copyright (C) Ceetron Solutions 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 "cafPdmPointer.h"

#include "cvfStructGrid.h"

#include <map>

class RimEclipseView;
class RimEclipseCellColors;
class Rim2dIntersectionView;
class RigEclipseCaseData;
class RimEclipseResultDefinition;
class RimGridView;
class RigGridBase;

class QString;

namespace cvf
{
class Part;
}

//==================================================================================================
//
//
//==================================================================================================
class RiuResultTextBuilder
{
public:
    RiuResultTextBuilder( RimGridView* settingsView, RimEclipseResultDefinition* eclResDef, size_t gridIndex, size_t cellIndex, size_t timeStepIndex );
    RiuResultTextBuilder( RimGridView* settingsView, RimEclipseResultDefinition* eclResDef, size_t reservoirCellIndex, size_t timeStepIndex );

    void setFace( cvf::StructGridInterface::FaceType face );
    void setNncIndex( size_t nncIndex );
    void setIntersectionPointInDisplay( cvf::Vec3d intersectionPointInDisplay );
    void set2dIntersectionView( Rim2dIntersectionView* intersectionView );

    QString mainResultText();

    QString geometrySelectionText( const QString& itemSeparator );

private:
    void appendDetails( QString& text, const QString& details );

    QString gridResultDetails();
    QString faultResultDetails();
    QString formationDetails();
    QString cellEdgeResultDetails();
    QString nncDetails();

    QString gridResultText();
    QString faultResultText();
    QString nncResultText();
    QString wellResultText();

    QString cellResultText( const std::vector<RimEclipseResultDefinition*>& resultDefinitions, bool appendCaseName = false );
    std::map<QString, QString> cellResultTextAndValueText( RimEclipseResultDefinition* resultDefinition );

    void appendTextFromResultColors( RigEclipseCaseData*         eclipseCase,
                                     size_t                      gridIndex,
                                     size_t                      cellIndex,
                                     size_t                      timeStepIndex,
                                     RimEclipseResultDefinition* resultColors,
                                     QString*                    resultInfoText );

    std::pair<bool, QStringList> resultTextFromLinkedViews() const;

    QString coordinatesText( const RigGridBase* grid, size_t globalCellIndex, const QString& itemSeparator );

    static QString createTextFromDomainCoordinate( const QString& formatString, const cvf::Vec3d& domainCoord );

private:
    caf::PdmPointer<RimGridView>    m_displayCoordView;
    caf::PdmPointer<RimEclipseView> m_eclipseView;

    caf::PdmPointer<RimEclipseResultDefinition> m_eclResDef;
    caf::PdmPointer<Rim2dIntersectionView>      m_2dIntersectionView;

    size_t m_gridIndex;
    size_t m_cellIndex;
    size_t m_timeStepIndex;

    cvf::StructGridInterface::FaceType m_face;

    size_t m_nncIndex;

    cvf::Vec3d m_intersectionPointInDisplay;
};