Files
ResInsight/ApplicationLibCode/Commands/RicExportContourMapToTextFeature.h
T
Kristian Bendiksen ebf7a061d8 #14772 Python: Add View.export_contour_map_to_text as object method and forward exportContourMapToText to it
Rim3dView_exportContourMapToText exports the contour map of an Eclipse
or GeoMech contour map view. The implementation is extracted from the
RICF_SOURCE_INIT feature RicExportContourMapToTextFeature into a static
helper returning std::expected, used by both the object method and the
legacy command.

The Python EclipseContourMap/GeoMechContourMap.export_to_text() wrappers
are kept as aliases of the generated method.
2026-09-22 14:19:23 +02:00

79 lines
3.3 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2019- Equinor 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 "CommandFileInterface/Core/RicfCommandObject.h"
#include "cafCmdFeature.h"
#include "cafPdmField.h"
#include <expected>
#include <utility>
class RimContourMapProjection;
class Rim3dView;
class RimEclipseContourMapView;
class RimGeoMechContourMapView;
class QTextStream;
//==================================================================================================
///
//==================================================================================================
class RicExportContourMapToTextFeature : public caf::CmdFeature, public RicfCommandObject
{
RICF_HEADER_INIT;
public:
RicExportContourMapToTextFeature();
caf::PdmScriptResponse execute() override;
static std::pair<RimEclipseContourMapView*, RimGeoMechContourMapView*> findContourMapView();
/// Export the contour map of the given view (an Eclipse or GeoMech contour map view) to a text file.
static std::expected<void, QString> exportContourMapToText( Rim3dView* view,
const QString& exportFileName,
bool exportLocalCoordinates,
const QString& undefinedValueLabel,
bool excludeUndefinedValues );
protected:
bool isCommandEnabled() const override;
void onActionTriggered( bool isChecked ) override;
void setupActionLook( QAction* actionToSetup ) override;
static void writeMetaDataToStream( QTextStream& stream,
const RimContourMapProjection* contourMapProjection,
const QString& caseName,
bool exportLocalCoordinates );
static void writeContourMapToStream( QTextStream& stream,
const RimContourMapProjection* contourMapProjection,
bool exportLocalCoordinates,
const QString& undefinedValueLabel,
bool excludeUndefinedValues );
private:
caf::PdmField<QString> m_exportFileName;
caf::PdmField<bool> m_exportLocalCoordinates;
caf::PdmField<QString> m_undefinedValueLabel;
caf::PdmField<bool> m_excludeUndefinedValues;
caf::PdmField<int> m_viewId;
};