// Copyright (C) Stichting Deltares 2016. All rights reserved. // // This file is part of Ringtoets. // // Ringtoets 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. // // This program 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 for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . // // All names, logos, and references to "Deltares" are registered trademarks of // Stichting Deltares and remain full property of Stichting Deltares at all times. // All rights reserved. using System.Collections; using System.Collections.Generic; using System.Drawing; using System.IO; using System.Linq; using System.Windows.Forms; using Core.Common.Controls.TreeView; using Core.Common.Gui.ContextMenu; using Core.Common.Gui.Forms.ProgressDialog; using Core.Common.Gui.Plugin; using Ringtoets.Common.Data; using Ringtoets.Common.Data.AssessmentSection; using Ringtoets.Common.Data.Calculation; using Ringtoets.Common.Forms.Helpers; using Ringtoets.Common.Forms.PresentationObjects; using Ringtoets.Common.Forms.TreeNodeInfos; using Ringtoets.HydraRing.Data; using Ringtoets.HydraRing.IO; using Ringtoets.Revetment.Service; using Ringtoets.StabilityStoneCover.Data; using Ringtoets.StabilityStoneCover.Forms.PresentationObjects; using Ringtoets.StabilityStoneCover.Forms.PropertyClasses; using Ringtoets.StabilityStoneCover.Forms.Views; using Ringtoets.StabilityStoneCover.Plugin.Properties; using Ringtoets.StabilityStoneCover.Service; using RingtoetsCommonDataResources = Ringtoets.Common.Data.Properties.Resources; using RingtoetsCommonFormsResources = Ringtoets.Common.Forms.Properties.Resources; using StabilityStoneCoverDataResources = Ringtoets.StabilityStoneCover.Data.Properties.Resources; using StabilityStoneCoverFormsResources = Ringtoets.StabilityStoneCover.Forms.Properties.Resources; using RingtoetsCommonServiceResources = Ringtoets.Common.Service.Properties.Resources; namespace Ringtoets.StabilityStoneCover.Plugin { /// /// The plugin for the . /// public class StabilityStoneCoverPlugin : PluginBase { public override IEnumerable GetPropertyInfos() { yield return new PropertyInfo(); } public override IEnumerable GetViewInfos() { yield return new ViewInfo, IEnumerable, StabilityStoneCoverResultView> { GetViewName = (v, o) => RingtoetsCommonFormsResources.FailureMechanism_AssessmentResult_DisplayName, Image = RingtoetsCommonFormsResources.FailureMechanismSectionResultIcon, CloseForData = CloseFailureMechanismResultViewForData, GetViewData = context => context.WrappedData, AfterCreate = (view, context) => view.FailureMechanism = context.FailureMechanism }; } public override IEnumerable GetTreeNodeInfos() { yield return RingtoetsTreeNodeInfoFactory.CreateFailureMechanismContextTreeNodeInfo( FailureMechanismEnabledChildNodeObjects, FailureMechanismDisabledChildNodeObjects, FailureMechanismEnabledContextMenuStrip, FailureMechanismDisabledContextMenuStrip); yield return RingtoetsTreeNodeInfoFactory.CreateCalculationGroupContextTreeNodeInfo( WaveConditionsCalculationGroupContextChildNodeObjects, WaveConditionsCalculationGroupContextContextMenuStrip, WaveConditionsCalculationGroupContextOnNodeRemoved); yield return RingtoetsTreeNodeInfoFactory.CreateCalculationContextTreeNodeInfo( StabilityStoneCoverFormsResources.CalculationIcon, WaveConditionsCalculationContextChildNodeObjects, WaveConditionsCalculationContextContextMenuStrip, WaveConditionsCalculationContextOnNodeRemoved); yield return new TreeNodeInfo { Text = context => RingtoetsCommonFormsResources.Calculation_Input, Image = context => RingtoetsCommonFormsResources.GenericInputOutputIcon, ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl) .AddPropertiesItem() .Build() }; yield return new TreeNodeInfo { Text = emptyPipingOutput => RingtoetsCommonFormsResources.CalculationOutput_DisplayName, Image = emptyPipingOutput => RingtoetsCommonFormsResources.GeneralOutputIcon, ForeColor = emptyPipingOutput => Color.FromKnownColor(KnownColor.GrayText), ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl) .AddPropertiesItem() .Build() }; yield return new TreeNodeInfo> { Text = context => RingtoetsCommonFormsResources.FailureMechanism_AssessmentResult_DisplayName, Image = context => RingtoetsCommonFormsResources.FailureMechanismSectionResultIcon, ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl) .AddOpenItem() .Build() }; } #region ViewInfos #region FailureMechanismSectionResultContext private static bool CloseFailureMechanismResultViewForData(StabilityStoneCoverResultView view, object dataToCloseFor) { var viewData = view.Data; var assessmentSection = dataToCloseFor as IAssessmentSection; var failureMechanism = dataToCloseFor as StabilityStoneCoverFailureMechanism; var failureMechanismContext = dataToCloseFor as IFailureMechanismContext; if (assessmentSection != null) { return assessmentSection .GetFailureMechanisms() .OfType() .Any(fm => ReferenceEquals(viewData, fm.SectionResults)); } if (failureMechanismContext != null) { failureMechanism = failureMechanismContext.WrappedData; } return failureMechanism != null && ReferenceEquals(view.Data, failureMechanism.SectionResults); } #endregion #endregion #region TreeNodeInfos #region StabilityStoneCoverFailureMechanismContext private object[] FailureMechanismEnabledChildNodeObjects(StabilityStoneCoverFailureMechanismContext failureMechanismContext) { StabilityStoneCoverFailureMechanism wrappedData = failureMechanismContext.WrappedData; return new object[] { new CategoryTreeFolder(RingtoetsCommonFormsResources.FailureMechanism_Inputs_DisplayName, GetInputs(wrappedData, failureMechanismContext.Parent), TreeFolderCategory.Input), new StabilityStoneCoverWaveConditionsCalculationGroupContext(wrappedData.WaveConditionsCalculationGroup, wrappedData, failureMechanismContext.Parent), new CategoryTreeFolder(RingtoetsCommonFormsResources.FailureMechanism_Outputs_DisplayName, GetOutputs(wrappedData), TreeFolderCategory.Output) }; } private object[] FailureMechanismDisabledChildNodeObjects(StabilityStoneCoverFailureMechanismContext failureMechanismContext) { return new object[] { new CommentContext(failureMechanismContext.WrappedData) }; } private static IList GetInputs(StabilityStoneCoverFailureMechanism failureMechanism, IAssessmentSection assessmentSection) { return new ArrayList { new FailureMechanismSectionsContext(failureMechanism, assessmentSection), new ForeshoreProfilesContext(failureMechanism.ForeshoreProfiles, assessmentSection), new CommentContext(failureMechanism) }; } private IList GetOutputs(StabilityStoneCoverFailureMechanism failureMechanism) { return new ArrayList { new FailureMechanismSectionResultContext(failureMechanism.SectionResults, failureMechanism) }; } private ContextMenuStrip FailureMechanismEnabledContextMenuStrip(StabilityStoneCoverFailureMechanismContext failureMechanismContext, object parentData, TreeViewControl treeViewControl) { var builder = new RingtoetsContextMenuBuilder(Gui.Get(failureMechanismContext, treeViewControl)); return builder.AddToggleRelevancyOfFailureMechanismItem(failureMechanismContext, RemoveAllViewsForItem) .AddSeparator() .AddExpandAllItem() .AddCollapseAllItem() .AddSeparator() .AddPropertiesItem() .Build(); } private void RemoveAllViewsForItem(StabilityStoneCoverFailureMechanismContext failureMechanismContext) { Gui.ViewCommands.RemoveAllViewsForItem(failureMechanismContext); } private ContextMenuStrip FailureMechanismDisabledContextMenuStrip(StabilityStoneCoverFailureMechanismContext failureMechanismContext, object parentData, TreeViewControl treeViewControl) { var builder = new RingtoetsContextMenuBuilder(Gui.Get(failureMechanismContext, treeViewControl)); return builder.AddToggleRelevancyOfFailureMechanismItem(failureMechanismContext, null) .AddSeparator() .AddExpandAllItem() .AddCollapseAllItem() .Build(); } #endregion #region StabilityStoneCoverWaveCibdutuibsCalculationGroupContext private object[] WaveConditionsCalculationGroupContextChildNodeObjects(StabilityStoneCoverWaveConditionsCalculationGroupContext nodeData) { var childNodeObjects = new List(); foreach (ICalculationBase item in nodeData.WrappedData.Children) { var calculation = item as StabilityStoneCoverWaveConditionsCalculation; var group = item as CalculationGroup; if (calculation != null) { childNodeObjects.Add(new StabilityStoneCoverWaveConditionsCalculationContext(calculation, nodeData.FailureMechanism, nodeData.AssessmentSection)); } else if (group != null) { childNodeObjects.Add(new StabilityStoneCoverWaveConditionsCalculationGroupContext(group, nodeData.FailureMechanism, nodeData.AssessmentSection)); } else { childNodeObjects.Add(item); } } return childNodeObjects.ToArray(); } private ContextMenuStrip WaveConditionsCalculationGroupContextContextMenuStrip(StabilityStoneCoverWaveConditionsCalculationGroupContext nodeData, object parentData, TreeViewControl treeViewControl) { var group = nodeData.WrappedData; var builder = new RingtoetsContextMenuBuilder(Gui.Get(nodeData, treeViewControl)); var isNestedGroup = parentData is StabilityStoneCoverWaveConditionsCalculationGroupContext; StrictContextMenuItem generateCalculationsItem = CreateGenerateWaveConditionsCalculationsItem(nodeData); if (!isNestedGroup) { builder.AddCustomItem(generateCalculationsItem) .AddSeparator(); } builder.AddCreateCalculationGroupItem(group) .AddCreateCalculationItem(nodeData, AddWaveConditionsCalculation); if (!isNestedGroup) { builder.AddSeparator() .AddRemoveAllChildrenItem(group, Gui.ViewCommands); } builder.AddSeparator() .AddValidateAllCalculationsInGroupItem(nodeData, c => ValidateAll( c.WrappedData.GetCalculations().OfType(), c.FailureMechanism.GeneralInput, c.AssessmentSection.FailureMechanismContribution.Norm, c.AssessmentSection.HydraulicBoundaryDatabase), ValidateAllDataAvailableAndGetErrorMessageForCalculationGroup) .AddPerformAllCalculationsInGroupItem(group, nodeData, CalculateAll) .AddClearAllCalculationOutputInGroupItem(group) .AddSeparator(); if (isNestedGroup) { builder.AddRenameItem() .AddDeleteItem() .AddSeparator(); } return builder.AddExpandAllItem() .AddCollapseAllItem() .AddSeparator() .AddPropertiesItem() .Build(); } private string ValidateAllDataAvailableAndGetErrorMessageForCalculationGroup(StabilityStoneCoverWaveConditionsCalculationGroupContext context) { return ValidateAllDataAvailableAndGetErrorMessage(context.AssessmentSection, context.FailureMechanism); } private string ValidateAllDataAvailableAndGetErrorMessageForCalculation(StabilityStoneCoverWaveConditionsCalculationContext context) { return ValidateAllDataAvailableAndGetErrorMessage(context.AssessmentSection, context.FailureMechanism); } private string ValidateAllDataAvailableAndGetErrorMessage(IAssessmentSection assessmentSection, StabilityStoneCoverFailureMechanism failureMechanism) { if (!failureMechanism.Sections.Any()) { return RingtoetsCommonFormsResources.Plugin_AllDataAvailable_No_failure_mechanism_sections_imported; } if (assessmentSection.HydraulicBoundaryDatabase == null) { return RingtoetsCommonFormsResources.Plugin_AllDataAvailable_No_hydraulic_boundary_database_imported; } string validationProblem = HydraulicDatabaseHelper.ValidatePathForCalculation(assessmentSection.HydraulicBoundaryDatabase.FilePath); if (!string.IsNullOrEmpty(validationProblem)) { return string.Format(RingtoetsCommonServiceResources.Hydraulic_boundary_database_connection_failed_0_, validationProblem); } return null; } private StrictContextMenuItem CreateGenerateWaveConditionsCalculationsItem(StabilityStoneCoverWaveConditionsCalculationGroupContext nodeData) { return new StrictContextMenuItem(RingtoetsCommonFormsResources.CalculationsGroup_Generate_calculations, Resources.StabilityStoneCoverPlugin_CreateGenerateHydraulicBoundaryCalculationsItem_ToolTip, RingtoetsCommonFormsResources.GenerateScenariosIcon, (sender, args) => { /* TODO: Implement for WTI-733 */ }) { Enabled = false }; } private void AddWaveConditionsCalculation(StabilityStoneCoverWaveConditionsCalculationGroupContext nodeData) { var calculation = new StabilityStoneCoverWaveConditionsCalculation { Name = NamingHelper.GetUniqueName(nodeData.WrappedData.Children, StabilityStoneCoverDataResources.StabilityStoneCoverWaveConditionsCalculation_DefaultName, c => c.Name) }; nodeData.WrappedData.Children.Add(calculation); nodeData.WrappedData.NotifyObservers(); } private void ValidateAll(IEnumerable calculations, GeneralStabilityStoneCoverWaveConditionsInput generalInput, int norm, HydraulicBoundaryDatabase database) { foreach (StabilityStoneCoverWaveConditionsCalculation calculation in calculations) { WaveConditionsCalculationService.Instance.Validate(calculation.Name); } } private void CalculateAll(CalculationGroup group, StabilityStoneCoverWaveConditionsCalculationGroupContext context) { var calculations = group.GetCalculations().OfType().ToArray(); CalculateAll(calculations, context.FailureMechanism, context.AssessmentSection); } private void CalculateAll(IEnumerable calculations, StabilityStoneCoverFailureMechanism failureMechanism, IAssessmentSection assessmentSection) { ActivityProgressDialogRunner.Run( Gui.MainWindow, calculations .Select(calculation => new StabilityStoneCoverWaveConditionsCalculationActivity(calculation, Path.GetDirectoryName(assessmentSection.HydraulicBoundaryDatabase.FilePath), failureMechanism, assessmentSection)) .ToList()); foreach (var calculation in calculations) { calculation.NotifyObservers(); } } private void WaveConditionsCalculationGroupContextOnNodeRemoved(StabilityStoneCoverWaveConditionsCalculationGroupContext nodeData, object parentNodeData) { var parentGroupContext = (StabilityStoneCoverWaveConditionsCalculationGroupContext) parentNodeData; parentGroupContext.WrappedData.Children.Remove(nodeData.WrappedData); parentGroupContext.NotifyObservers(); } #endregion #region StabilityStoneCoverWaveConditionsCalculationContext private object[] WaveConditionsCalculationContextChildNodeObjects(StabilityStoneCoverWaveConditionsCalculationContext context) { var childNodes = new List { new CommentContext(context.WrappedData), new StabilityStoneCoverWaveConditionsCalculationInputContext(context.WrappedData.InputParameters, context.FailureMechanism, context.AssessmentSection) }; if (context.WrappedData.HasOutput) { childNodes.Add(context.WrappedData.Output); } else { childNodes.Add(new EmptyStabilityStoneCoverOutput()); } return childNodes.ToArray(); } private ContextMenuStrip WaveConditionsCalculationContextContextMenuStrip(StabilityStoneCoverWaveConditionsCalculationContext nodeData, object parentData, TreeViewControl treeViewControl) { var builder = new RingtoetsContextMenuBuilder(Gui.Get(nodeData, treeViewControl)); StabilityStoneCoverWaveConditionsCalculation calculation = nodeData.WrappedData; return builder.AddValidateCalculationItem(nodeData, c => ValidateAll( new [] { c.WrappedData }, c.FailureMechanism.GeneralInput, c.AssessmentSection.FailureMechanismContribution.Norm, c.AssessmentSection.HydraulicBoundaryDatabase), ValidateAllDataAvailableAndGetErrorMessageForCalculation) .AddPerformCalculationItem(calculation, nodeData, PerformCalculation) .AddClearCalculationOutputItem(calculation) .AddSeparator() .AddRenameItem() .AddDeleteItem() .AddSeparator() .AddExpandAllItem() .AddCollapseAllItem() .AddSeparator() .AddPropertiesItem() .Build(); } private void PerformCalculation(StabilityStoneCoverWaveConditionsCalculation calculation, StabilityStoneCoverWaveConditionsCalculationContext context) { ActivityProgressDialogRunner.Run(Gui.MainWindow, new StabilityStoneCoverWaveConditionsCalculationActivity(calculation, Path.GetDirectoryName(context.AssessmentSection.HydraulicBoundaryDatabase.FilePath), context.FailureMechanism, context.AssessmentSection)); calculation.NotifyObservers(); } private void WaveConditionsCalculationContextOnNodeRemoved(StabilityStoneCoverWaveConditionsCalculationContext nodeData, object parentNodeData) { var calculationGroupContext = parentNodeData as StabilityStoneCoverWaveConditionsCalculationGroupContext; if (calculationGroupContext != null) { bool successfullyRemovedData = calculationGroupContext.WrappedData.Children.Remove(nodeData.WrappedData); if (successfullyRemovedData) { calculationGroupContext.NotifyObservers(); } } } #endregion #endregion } }