Files
ResInsight/ApplicationLibCode/Commands/ExportCommands/RicSaveEclipseInputVisibleCellsUi.cpp
T
Kristian Bendiksen 001a515c68 #14772 Python: Add EclipseView.export_visible_cells as object method and forward exportVisibleCells to it
RimEclipseView_exportVisibleCells writes a FLUXNUM/MULTNUM/ACTNUM
keyword based on cell visibility in the view and requires an explicit
export file. The export keyword reuses
RicSaveEclipseInputVisibleCellsUi::ExportKeyword, registered as the
Python StrEnum VisibleCellsExportKeyword.

RicSaveEclipseInputVisibleCellsFeature::exportVisibleCells() is split
out of executeCommand() to return errors via std::expected instead of
only logging them.

RicfExportVisibleCells resolves the export folder from the command file
executor's CELLS export path and forwards to the object method. The
hand-written View.export_visible_cells() wrapper is removed since the
generated EclipseView method shadows it.
2026-09-22 14:19:23 +02:00

145 lines
5.9 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// 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.
//
/////////////////////////////////////////////////////////////////////////////////
#include "RicSaveEclipseInputVisibleCellsUi.h"
#include "RiaApplication.h"
#include "RiaPreferences.h"
#include "cafPdmScriptEnumNameRegistry.h"
#include "cafPdmUiFilePathEditor.h"
#include <QDir>
namespace caf
{
template <>
void RicSaveEclipseInputVisibleCellsUi::ExportKeywordEnum::setUp()
{
addItem( RicSaveEclipseInputVisibleCellsUi::FLUXNUM, "FLUXNUM", "FLUXNUM" );
addItem( RicSaveEclipseInputVisibleCellsUi::MULTNUM, "MULTNUM", "MULTNUM" );
addItem( RicSaveEclipseInputVisibleCellsUi::ACTNUM, "ACTNUM", "ACTNUM" );
setDefault( RicSaveEclipseInputVisibleCellsUi::FLUXNUM );
}
} // namespace caf
namespace
{
// Pin the Python StrEnum class name for the export keyword used by RimEclipseView_exportVisibleCells
struct RegisterScriptEnumNames
{
RegisterScriptEnumNames()
{
caf::PdmScriptEnumNameRegistry::registerName<RicSaveEclipseInputVisibleCellsUi::ExportKeyword>( "VisibleCellsExportKeyword" );
}
};
const RegisterScriptEnumNames s_registerScriptEnumNames;
} // namespace
CAF_PDM_SOURCE_INIT( RicSaveEclipseInputVisibleCellsUi, "RicSaveEclipseInputVisibleCellsUi" );
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RicSaveEclipseInputVisibleCellsUi::RicSaveEclipseInputVisibleCellsUi()
: exportFilenameManuallyChanged( false )
{
CAF_PDM_InitObject( "Export Visible Cells FLUXNUM/MULTNUM/ACTNUM" );
CAF_PDM_InitField( &exportFilename, "ExportFilename", QString(), "Export Filename" );
exportFilename.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
CAF_PDM_InitFieldNoDefault( &exportKeyword, "ExportKeyword", "Export Keyword" );
CAF_PDM_InitField( &visibleActiveCellsValue, "VisibleActiveCellsValue", 1, "Visible Active Cells Value" );
CAF_PDM_InitField( &hiddenActiveCellsValue, "HiddenActiveCellsValue", 0, "Hidden Active Cells Value" );
CAF_PDM_InitField( &inactiveCellsValue, "InactiveCellsValue", 0, "Inactive Cells Value" );
CAF_PDM_InitField( &writeEchoInGrdeclFiles,
"WriteEchoInGrdeclFiles",
RiaPreferences::current()->writeEchoInGrdeclFiles(),
"Write NOECHO and ECHO" );
exportFilename = getDefaultExportPath();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RicSaveEclipseInputVisibleCellsUi::~RicSaveEclipseInputVisibleCellsUi()
{
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicSaveEclipseInputVisibleCellsUi::defineEditorAttribute( const caf::PdmFieldHandle* field,
QString uiConfigName,
caf::PdmUiEditorAttribute* attribute )
{
if ( field == &exportFilename )
{
auto* myAttr = dynamic_cast<caf::PdmUiFilePathEditorAttribute*>( attribute );
if ( myAttr )
{
myAttr->m_selectSaveFileName = true;
myAttr->m_fileSelectionFilter = "GRDECL files (*.grdecl *.GRDECL);;All files (*.*)";
}
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicSaveEclipseInputVisibleCellsUi::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
uiOrdering.add( &exportFilename );
uiOrdering.add( &exportKeyword );
uiOrdering.add( &writeEchoInGrdeclFiles );
uiOrdering.add( &visibleActiveCellsValue );
uiOrdering.add( &hiddenActiveCellsValue );
uiOrdering.add( &inactiveCellsValue );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicSaveEclipseInputVisibleCellsUi::fieldChangedByUi( const caf::PdmFieldHandle* changedField,
const QVariant& oldValue,
const QVariant& newValue )
{
if ( changedField == &exportFilename )
{
exportFilenameManuallyChanged = true;
}
else if ( changedField == &exportKeyword )
{
if ( !exportFilenameManuallyChanged )
{
exportFilename = getDefaultExportPath();
}
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicSaveEclipseInputVisibleCellsUi::getDefaultExportPath() const
{
QDir baseDir( RiaApplication::instance()->currentProjectPath() );
return baseDir.absoluteFilePath( QString( "%1.grdecl" ).arg( exportKeyword().text() ) );
}