mirror of
https://github.com/OPM/ResInsight.git
synced 2026-11-13 09:37:29 -06:00
Kristian Bendiksen
add80526fa
Double-click a nested workflow task (or use Open Nested Workflow) to show the inner workflow read-only in a tab of its own. The inner workflow is described by the new taskmaestro_helper describe-nested command, for YAML workflow entries and installed workflows. Workflows with workflow entries now load.
111 lines
6.4 KiB
C++
111 lines
6.4 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2026- 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 "RimWorkflowDefinition.h"
|
|
|
|
#include <QJsonArray>
|
|
#include <QJsonObject>
|
|
#include <QMap>
|
|
#include <QString>
|
|
#include <QStringList>
|
|
|
|
#include <expected>
|
|
#include <optional>
|
|
#include <vector>
|
|
|
|
class RimWorkflowTaskCatalog;
|
|
|
|
//==================================================================================================
|
|
/// Pure functions on RimWorkflowDefinition: JSON conversion, config derivation, edit operations,
|
|
/// static validation and the graph JSON shown by RiuWorkflowGraphView.
|
|
/// Edit operations return the new definition, or an error message for the user.
|
|
//==================================================================================================
|
|
namespace RimWorkflowDefinitionTools
|
|
{
|
|
using EditResult = std::expected<RimWorkflowDefinition, QString>;
|
|
|
|
constexpr const char* connectTaskId = "resinsight.connect";
|
|
|
|
// Conversion
|
|
std::expected<RimWorkflowDefinition, QString> fromJson( const QJsonObject& json );
|
|
QJsonObject toJson( const RimWorkflowDefinition& definition );
|
|
RimWorkflowDefinition createEmpty( const QString& name );
|
|
RimWorkflowDefinition editableCopy( const RimWorkflowDefinition& definition, const QString& name );
|
|
|
|
// Names
|
|
bool isIdentifier( const QString& name );
|
|
QString identifierFrom( const QString& text );
|
|
QString uniqueInstanceName( const RimWorkflowDefinition& definition, const QString& baseName );
|
|
std::expected<void, QString>
|
|
validateInstanceName( const RimWorkflowDefinition& definition, const QString& name, const QString& currentName = {} );
|
|
QStringList sinkTasks( const RimWorkflowDefinition& definition );
|
|
QString effectiveResultTask( const RimWorkflowDefinition& definition );
|
|
QStringList structuralReadOnlyReasons( const RimWorkflowDefinition& definition );
|
|
|
|
// Config fields
|
|
QStringList coveredInputFields( const RimWorkflowDefinition& definition, const QString& nodeName );
|
|
QStringList deriveConfigFields( const RimWorkflowDefinition& definition, const QString& nodeName );
|
|
RimWorkflowDefinition normalize( RimWorkflowDefinition definition );
|
|
|
|
// Edit operations
|
|
EditResult addTask( const RimWorkflowDefinition& definition,
|
|
const RimWorkflowTaskCatalog& catalog,
|
|
const QString& taskId,
|
|
QString* addedName = nullptr );
|
|
EditResult removeTask( const RimWorkflowDefinition& definition, const QString& nodeName );
|
|
EditResult connect( const RimWorkflowDefinition& definition, const RimWorkflowDefinitionEdge& edge );
|
|
EditResult disconnect( const RimWorkflowDefinition& definition, const RimWorkflowDefinitionEdge& edge );
|
|
EditResult setCollectKey( const RimWorkflowDefinition& definition, const RimWorkflowDefinitionEdge& edge, const QString& key );
|
|
EditResult moveCollectMember( const RimWorkflowDefinition& definition, const RimWorkflowDefinitionEdge& edge, int delta );
|
|
EditResult setTaskMap( const RimWorkflowDefinition& definition, const QString& nodeName, const std::optional<RimWorkflowTaskMap>& map );
|
|
std::expected<void, QString> checkTaskMap( const RimWorkflowDefinition& definition, const QString& nodeName, const RimWorkflowTaskMap& map );
|
|
QJsonObject mapOverSchema( const RimWorkflowDefinition& definition, const QString& nodeName );
|
|
EditResult setTaskGuard( const RimWorkflowDefinition& definition, const QString& nodeName, const std::optional<RimWorkflowTaskGuard>& guard );
|
|
std::expected<void, QString>
|
|
checkTaskGuard( const RimWorkflowDefinition& definition, const QString& nodeName, const RimWorkflowTaskGuard& guard );
|
|
EditResult addFirstOfMember( const RimWorkflowDefinition& definition, const RimWorkflowDefinitionEdge& edge );
|
|
EditResult renameTask( const RimWorkflowDefinition& definition, const QString& oldName, const QString& newName );
|
|
EditResult renameWorkflow( const RimWorkflowDefinition& definition, const QString& newName );
|
|
EditResult setResultTask( const RimWorkflowDefinition& definition, const QString& nodeName );
|
|
EditResult setOptionalInputConfigured( const RimWorkflowDefinition& definition, const QString& nodeName, const QString& field, bool configured );
|
|
RimWorkflowDefinition
|
|
autoWireResInsightInputs( const RimWorkflowDefinition& definition, const RimWorkflowTaskCatalog& catalog, const QString& nodeName );
|
|
|
|
// Conditional branches
|
|
bool isSwitchTask( const QJsonObject& taskType );
|
|
QJsonArray switchBranches( const QJsonObject& taskType );
|
|
QStringList guardFields( const RimWorkflowDefinition& definition, const QString& sourceName );
|
|
QJsonObject guardFieldSchema( const RimWorkflowDefinition& definition, const QString& sourceName, const QString& field );
|
|
QString guardValueText( const QJsonValue& value );
|
|
QJsonArray guardValuesFromText( const QString& text, const QJsonObject& fieldSchema );
|
|
QString guardValuesToText( const QJsonArray& values, const QJsonObject& fieldSchema );
|
|
QString guardLabel( const RimWorkflowTaskGuard& guard );
|
|
QString firstOfLabel( int position );
|
|
|
|
// Validation and display
|
|
std::vector<RimWorkflowIssue> validate( const RimWorkflowDefinition& definition );
|
|
QJsonObject graphFromDefinition( const RimWorkflowDefinition& definition, bool editMode, const std::vector<RimWorkflowIssue>& extraIssues = {} );
|
|
|
|
// Nested workflows: tasks wrapping a whole workflow. The `workflow:` entries of a YAML workflow
|
|
// (`workflow` file and `workflow_input`) by task name, and the graph with these tasks marked.
|
|
QMap<QString, QJsonObject> nestedWorkflowEntries( const RimWorkflowDefinition& definition );
|
|
QJsonObject markNestedWorkflows( const QJsonObject& graph, const QMap<QString, QJsonObject>& entries, const QJsonObject& describe );
|
|
} // namespace RimWorkflowDefinitionTools
|