#3957 Add button to valve for creating new valve template or editing existing template

* Also added separate delete valve feature so we can clear the template and update the valves referencing it.

ApplicationCode/Commands/CompletionCommands/CMakeLists_files.cmake

@@ -8,6 +8,7 @@ ${CMAKE_CURRENT_LIST_DIR}/RicNewPerforationIntervalFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicNewPerforationIntervalAtMeasuredDepthFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicNewValveFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicNewValveTemplateFeature.h
+${CMAKE_CURRENT_LIST_DIR}/RicDeleteValveTemplateFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicWellPathImportCompletionsFileFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicWellPathImportPerforationIntervalsFeature.h
 )
@@ -21,6 +22,7 @@ ${CMAKE_CURRENT_LIST_DIR}/RicNewPerforationIntervalFeature.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RicNewPerforationIntervalAtMeasuredDepthFeature.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RicNewValveFeature.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RicNewValveTemplateFeature.cpp
+${CMAKE_CURRENT_LIST_DIR}/RicDeleteValveTemplateFeature.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RicWellPathImportCompletionsFileFeature.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RicWellPathImportPerforationIntervalsFeature.cpp
 )

ApplicationCode/Commands/CompletionCommands/RicDeleteValveTemplateFeature.cpp

@@ -0,0 +1,82 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+//  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.
+//
+/////////////////////////////////////////////////////////////////////////////////
+#include "RicDeleteValveTemplateFeature.h"
+
+#include "RimProject.h"
+#include "RimValveTemplate.h"
+#include "RimValveTemplateCollection.h"
+#include "RimWellPathValve.h"
+
+#include "cafSelectionManager.h"
+
+#include <QAction>
+
+CAF_CMD_SOURCE_INIT(RicDeleteValveTemplateFeature, "RicDeleteValveTemplateFeature");
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RicDeleteValveTemplateFeature::isCommandEnabled()
+{
+    if (caf::SelectionManager::instance()->selectedItemOfType<RimValveTemplate>())
+    {
+        return true;
+    }
+    return false;
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicDeleteValveTemplateFeature::onActionTriggered(bool isChecked)
+{
+    RimValveTemplate* valveTemplate = caf::SelectionManager::instance()->selectedItemOfType<RimValveTemplate>();
+
+    if (valveTemplate)
+    {
+        RimProject* project = nullptr;
+        valveTemplate->firstAncestorOrThisOfTypeAsserted(project);
+        std::vector<RimWellPathValve*> valves;
+        project->descendantsIncludingThisOfType(valves);
+        for (RimWellPathValve* valve : valves)
+        {
+            if (valve->valveTemplate() == valveTemplate)
+            {
+                valve->setValveTemplate(nullptr);
+                valve->updateAllRequiredEditors();
+            }
+        }
+
+        RimValveTemplateCollection* collection = nullptr;
+        valveTemplate->firstAncestorOrThisOfTypeAsserted(collection);
+        collection->removeAndDeleteValveTemplate(valveTemplate);
+        collection->updateAllRequiredEditors();
+
+        project->scheduleCreateDisplayModelAndRedrawAllViews();
+    }
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicDeleteValveTemplateFeature::setupActionLook(QAction* actionToSetup)
+{
+    actionToSetup->setText("Delete Valve Template");
+    actionToSetup->setIcon(QIcon(":/Erase.png"));
+}
+

ApplicationCode/Commands/CompletionCommands/RicDeleteValveTemplateFeature.h

@@ -0,0 +1,35 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+//  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 "cafCmdFeature.h"
+
+//==================================================================================================
+///
+//==================================================================================================
+class RicDeleteValveTemplateFeature : public caf::CmdFeature
+{
+    CAF_CMD_HEADER_INIT;
+
+protected:
+    // Overrides
+    bool isCommandEnabled() override;
+    void onActionTriggered(bool isChecked) override;
+    void setupActionLook(QAction* actionToSetup) override;
+};

ApplicationCode/Commands/CompletionCommands/RicNewValveTemplateFeature.cpp

@@ -25,6 +25,7 @@
 #include "RimValveTemplateCollection.h"
 #include "RimOilField.h"
 #include "RimProject.h"
+#include "RimWellPathValve.h"
 
 #include "Riu3DMainWindowTools.h"
 
@@ -39,12 +40,16 @@ CAF_CMD_SOURCE_INIT(RicNewValveTemplateFeature, "RicNewValveTemplateFeature");
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
-void RicNewValveTemplateFeature::selectValveTemplateAndUpdate(RimValveTemplateCollection* templateCollection,
+void RicNewValveTemplateFeature::selectValveTemplateAndUpdate(RimValveTemplate*           valveTemplate)
-                                                              RimValveTemplate*           valveTemplate)
 {
     valveTemplate->loadDataAndUpdate();
 
+    RimValveTemplateCollection* templateCollection = nullptr;
+    valveTemplate->firstAncestorOrThisOfType(templateCollection);
+    if (templateCollection)
+    {
         templateCollection->updateConnectedEditors();
+    }
 
     RimProject* project = RiaApplication::instance()->project();
 
@@ -65,13 +70,23 @@ void RicNewValveTemplateFeature::selectValveTemplateAndUpdate(RimValveTemplateCo
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
-void RicNewValveTemplateFeature::onActionTriggered(bool isChecked)
+void RicNewValveTemplateFeature::createNewValveTemplateForValveAndUpdate(RimWellPathValve* valve)
+{
+    RimValveTemplate* valveTemplate = createNewValveTemplate();
+    valve->setValveTemplate(valveTemplate);
+    selectValveTemplateAndUpdate(valveTemplate);
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+RimValveTemplate* RicNewValveTemplateFeature::createNewValveTemplate()
 {
     RimProject* project = RiaApplication::instance()->project();
     CVF_ASSERT(project);
 
     RimOilField* oilfield = project->activeOilField();
-    if (oilfield == nullptr) return;
+    if (oilfield == nullptr) return nullptr;
 
     RimValveTemplateCollection* valveTemplateColl = oilfield->valveTemplateCollection();
 
@@ -83,8 +98,20 @@ void RicNewValveTemplateFeature::onActionTriggered(bool isChecked)
         valveTemplateColl->addValveTemplate(valveTemplate);
         valveTemplate->setUnitSystem(valveTemplateColl->defaultUnitSystemType());
         valveTemplate->setDefaultValuesFromUnits();
+        return valveTemplate;
+    }
+    return nullptr;
+}
 
-        selectValveTemplateAndUpdate(valveTemplateColl, valveTemplate);
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicNewValveTemplateFeature::onActionTriggered(bool isChecked)
+{
+    RimValveTemplate* valveTemplate = createNewValveTemplate();
+    if (valveTemplate)
+    {
+        selectValveTemplateAndUpdate(valveTemplate);
     }
 }
 

ApplicationCode/Commands/CompletionCommands/RicNewValveTemplateFeature.h

@@ -24,6 +24,7 @@
 
 class RimValveTemplate;
 class RimValveTemplateCollection;
+class RimWellPathValve;
 
 //==================================================================================================
 ///
@@ -33,10 +34,10 @@ class RicNewValveTemplateFeature : public caf::CmdFeature
     CAF_CMD_HEADER_INIT;
 
 public:
-    static void selectValveTemplateAndUpdate(RimValveTemplateCollection* templateCollection,
+    static void selectValveTemplateAndUpdate(RimValveTemplate*           valveTemplate);
-                                             RimValveTemplate*           valveTemplate);
+    static void createNewValveTemplateForValveAndUpdate(RimWellPathValve* valve);
-
 protected:
+    static RimValveTemplate* createNewValveTemplate();
     void onActionTriggered(bool isChecked) override;
     void setupActionLook(QAction* actionToSetup) override;
     bool isCommandEnabled() override;

ApplicationCode/Commands/RicDeleteItemExec.cpp

@@ -51,8 +51,6 @@
 #include "RiuPlotMainWindow.h"
 
 #include "RimFractureTemplateCollection.h"
-#include "RimValveTemplateCollection.h"
-
 
 #include "cafNotificationCenter.h"
 #include "cafPdmChildArrayField.h"
@@ -156,11 +154,9 @@ void RicDeleteItemExec::redo()
         }
 
 
-        RimValveTemplateCollection* valveTemplateColl;
         RimFractureTemplateCollection* fracTemplateColl;
         parentObj->firstAncestorOrThisOfType(fracTemplateColl);
-        parentObj->firstAncestorOrThisOfType(valveTemplateColl);
+        if (fracTemplateColl)
-        if (fracTemplateColl || valveTemplateColl)
         {
             RimProject* proj = nullptr;
             parentObj->firstAncestorOrThisOfType(proj);

ApplicationCode/Commands/RicDeleteItemFeature.cpp

@@ -60,7 +60,6 @@
 #include "RimSimWellFracture.h"
 #include "RimSimWellFractureCollection.h"
 #include "RimStimPlanFractureTemplate.h"
-#include "RimValveTemplate.h"
 #include "RimWellPathFracture.h"
 #include "RimWellPathFractureCollection.h"
 
@@ -123,7 +122,6 @@ bool isDeletable(caf::PdmUiItem* uiItem)
     if (dynamic_cast<RimWellPathFracture*>(uiItem))             return true;
     if (dynamic_cast<RimEllipseFractureTemplate*>(uiItem))      return true;
     if (dynamic_cast<RimStimPlanFractureTemplate*>(uiItem))     return true;
-    if (dynamic_cast<RimValveTemplate*>(uiItem))                return true;
     if (dynamic_cast<RimSimWellFractureCollection*>(uiItem))    return true;
     if (dynamic_cast<RimSimWellFracture*>(uiItem))              return true;
     if (dynamic_cast<RimEnsembleCurveSet*>(uiItem))             return true;

ApplicationCode/ProjectDataModel/Completions/RimValveTemplate.h

@@ -47,7 +47,6 @@ public:
     QString                             typeLabel() const;
     QString                             fullLabel() const;
     void                                setUserLabel(const QString& userLabel);
-
 protected:
     QList<caf::PdmOptionItemInfo> calculateValueOptions(const caf::PdmFieldHandle* fieldNeedingOptions,
                                                         bool*                      useOptionsOnly) override;
@@ -68,6 +67,5 @@ private:
     caf::PdmField<double>                              m_flowCoefficient;
     // AICDs
     caf::PdmChildField<RimWellPathAicdParameters*>     m_aicdParameters;
-
 };
 

ApplicationCode/ProjectDataModel/Completions/RimValveTemplateCollection.cpp

@@ -66,6 +66,15 @@ void RimValveTemplateCollection::addValveTemplate(RimValveTemplate* valveTemplat
     m_valveDefinitions.push_back(valveTemplate);
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimValveTemplateCollection::removeAndDeleteValveTemplate(RimValveTemplate* valveTemplate)
+{
+    m_valveDefinitions.removeChildObject(valveTemplate);
+    delete valveTemplate;
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------

ApplicationCode/ProjectDataModel/Completions/RimValveTemplateCollection.h

@@ -40,6 +40,7 @@ public:
 
     std::vector<RimValveTemplate*>           valveTemplates() const;
     void                                     addValveTemplate(RimValveTemplate* valveTemplate);
+    void                                     removeAndDeleteValveTemplate(RimValveTemplate* valveTemplate);
 
     RiaEclipseUnitTools::UnitSystemType      defaultUnitSystemType() const;
     void                                     setDefaultUnitSystemBasedOnLoadedCases();

ApplicationCode/ProjectDataModel/Completions/RimWellPathValve.cpp

@@ -22,6 +22,8 @@
 #include "RiaColorTables.h"
 #include "RiaEclipseUnitTools.h"
 
+#include "Riu3DMainWindowTools.h"
+
 #include "RigWellPath.h"
 
 #include "RimMultipleValveLocations.h"
@@ -30,7 +32,10 @@
 #include "RimValveTemplate.h"
 #include "RimWellPath.h"
 
+#include "CompletionCommands/RicNewValveTemplateFeature.h"
+
 #include "cafPdmUiDoubleSliderEditor.h"
+#include "cafPdmUiToolButtonEditor.h"
 
 CAF_PDM_SOURCE_INIT(RimWellPathValve, "WellPathValve");
 
@@ -42,14 +47,15 @@ RimWellPathValve::RimWellPathValve()
     CAF_PDM_InitObject("WellPathValve", ":/ICDValve16x16.png", "", "");
 
     CAF_PDM_InitFieldNoDefault(&m_valveTemplate, "ValveTemplate", "Valve Template", "", "", "");
-
     CAF_PDM_InitField(&m_measuredDepth, "StartMeasuredDepth", 0.0, "Start MD", "", "", "");    
-    m_measuredDepth.uiCapability()->setUiEditorTypeName(caf::PdmUiDoubleSliderEditor::uiEditorTypeName());
-
     CAF_PDM_InitFieldNoDefault(&m_multipleValveLocations, "ValveLocations", "Valve Locations", "", "", "");
+    CAF_PDM_InitField(&m_createOrEditValveTemplate, "CreateTemplate", false, "Create new", "", "", "");
+    
+    m_measuredDepth.uiCapability()->setUiEditorTypeName(caf::PdmUiDoubleSliderEditor::uiEditorTypeName());
     m_multipleValveLocations = new RimMultipleValveLocations;
     m_multipleValveLocations.uiCapability()->setUiTreeHidden(true);
     m_multipleValveLocations.uiCapability()->setUiTreeChildrenHidden(true);
+    m_createOrEditValveTemplate.uiCapability()->setUiEditorTypeName(caf::PdmUiToolButtonEditor::uiEditorTypeName());
     nameField()->uiCapability()->setUiReadOnly(true);
 
 }
@@ -150,6 +156,14 @@ double RimWellPathValve::flowCoefficient() const
     return 0.0;
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+RimValveTemplate* RimWellPathValve::valveTemplate() const
+{
+    return m_valveTemplate;
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
@@ -407,6 +421,18 @@ void RimWellPathValve::fieldChangedByUi(const caf::PdmFieldHandle* changedField,
         applyValveLabelAndIcon();
         this->updateConnectedEditors();
     }
+    else if (changedField == &m_createOrEditValveTemplate)
+    {
+        m_createOrEditValveTemplate = false;
+        if (m_valveTemplate == nullptr)
+        {
+            RicNewValveTemplateFeature::createNewValveTemplateForValveAndUpdate(this);
+        }
+        else
+        {
+            Riu3DMainWindowTools::selectAsCurrentItem(m_valveTemplate());
+        }
+    }
 
     RimPerforationInterval* perfInterval;
     this->firstAncestorOrThisOfTypeAsserted(perfInterval);
@@ -426,7 +452,23 @@ void RimWellPathValve::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering
 
     uiOrdering.add(&m_valveTemplate);
 
-    if (componentType() == RiaDefines::UNDEFINED_COMPONENT) return;
+    {
+        uiOrdering.add(&m_createOrEditValveTemplate, false);
+        if (m_valveTemplate() == nullptr)
+        {
+            m_createOrEditValveTemplate.uiCapability()->setUiName("New");
+        }
+        else
+        {
+            m_createOrEditValveTemplate.uiCapability()->setUiName("Edit");
+        }
+    }
+
+    if (m_valveTemplate())
+    {
+        caf::PdmUiGroup* group = uiOrdering.addNewGroup("Parameters from Template");
+        m_valveTemplate->uiOrdering("InsideValve", *group);
+    }
 
     if (componentType() == RiaDefines::ICV || componentType() == RiaDefines::ICD)
     {        
@@ -455,12 +497,7 @@ void RimWellPathValve::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering
         m_multipleValveLocations->uiOrdering(uiConfigName, *group);
     }
   
-    if (m_valveTemplate)
+    uiOrdering.skipRemainingFields(true);
-    {
-        caf::PdmUiGroup* group = uiOrdering.addNewGroup("Parameters from Template");
-        m_valveTemplate->uiOrdering("InsideValve", *group);
-    }
-
 }
 
 //--------------------------------------------------------------------------------------------------

ApplicationCode/ProjectDataModel/Completions/RimWellPathValve.h

@@ -50,6 +50,7 @@ public:
     std::vector<double>        valveLocations() const;
     double                     orificeDiameter(RiaEclipseUnitTools::UnitSystem unitSystem) const;
     double                     flowCoefficient() const;
+    RimValveTemplate*          valveTemplate() const;
     void                       setValveTemplate(RimValveTemplate* valveTemplate);
     void                       applyValveLabelAndIcon();
     const RimWellPathAicdParameters* aicdParameters() const;
@@ -82,7 +83,7 @@ private:
     caf::PdmPtrField<RimValveTemplate*>            m_valveTemplate;
     caf::PdmField<double>                          m_measuredDepth;
     caf::PdmChildField<RimMultipleValveLocations*> m_multipleValveLocations;
-
+    caf::PdmField<bool>                            m_createOrEditValveTemplate;
 
 };
 

ApplicationCode/ProjectDataModel/RimContextCommandBuilder.cpp

@@ -664,6 +664,10 @@ caf::CmdFeatureMenuBuilder RimContextCommandBuilder::commandsFromSelection()
         {
             menuBuilder << "RicNewValveTemplateFeature";
         }
+        else if (dynamic_cast<RimValveTemplate*>(uiItem))
+        {
+           menuBuilder << "RicDeleteValveTemplateFeature";
+        }
         else if (dynamic_cast<RimFractureTemplateCollection*>(uiItem))
         {
             menuBuilder << "RicPasteEllipseFractureFeature";