// Copyright (C) Stichting Deltares 2017. 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; using System.Collections.Generic; using System.Drawing; using System.Linq; using System.Windows.Forms; using Core.Common.Base; using Core.Common.Base.IO; using Core.Common.Controls.TreeView; using Core.Common.Gui.ContextMenu; using Core.Common.Gui.Forms.ProgressDialog; using Core.Common.Gui.Plugin; using Core.Common.Util; using Ringtoets.Common.Data.AssessmentSection; using Ringtoets.Common.Data.FailureMechanism; using Ringtoets.Common.Forms.PresentationObjects; using Ringtoets.Common.Forms.TreeNodeInfos; using Ringtoets.Common.Forms.TypeConverters; using Ringtoets.Common.Forms.UpdateInfos; using Ringtoets.Common.Plugin; using Ringtoets.Common.Service; using Ringtoets.DuneErosion.Data; using Ringtoets.DuneErosion.Forms; using Ringtoets.DuneErosion.Forms.GuiServices; using Ringtoets.DuneErosion.Forms.PresentationObjects; using Ringtoets.DuneErosion.Forms.PropertyClasses; using Ringtoets.DuneErosion.Forms.Views; using Ringtoets.DuneErosion.IO; using Ringtoets.DuneErosion.Plugin.FileImporters; using Ringtoets.DuneErosion.Plugin.Properties; using Ringtoets.DuneErosion.Service; using RingtoetsCommonFormsResources = Ringtoets.Common.Forms.Properties.Resources; using RingtoetsCommonDataResources = Ringtoets.Common.Data.Properties.Resources; namespace Ringtoets.DuneErosion.Plugin { /// /// The plug-in for the . /// public class DuneErosionPlugin : PluginBase { private DuneLocationCalculationGuiService duneLocationCalculationGuiService; public override IEnumerable GetPropertyInfos() { yield return new PropertyInfo { CreateInstance = context => new DuneErosionFailureMechanismProperties(context.WrappedData, new DuneErosionFailureMechanismPropertyChangeHandler()) }; yield return new PropertyInfo { CreateInstance = context => new DuneLocationCalculationsProperties(context.WrappedData) }; yield return new PropertyInfo { CreateInstance = calculation => new DuneLocationCalculationProperties(calculation) }; } public override IEnumerable GetTreeNodeInfos() { yield return RingtoetsTreeNodeInfoFactory.CreateFailureMechanismContextTreeNodeInfo( FailureMechanismEnabledChildNodeObjects, FailureMechanismDisabledChildNodeObjects, FailureMechanismEnabledContextMenuStrip, FailureMechanismDisabledContextMenuStrip); yield return new TreeNodeInfo> { Text = context => RingtoetsCommonFormsResources.FailureMechanism_AssessmentResult_DisplayName, Image = context => RingtoetsCommonFormsResources.FailureMechanismSectionResultIcon, ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl) .AddOpenItem() .Build() }; yield return new TreeNodeInfo { Text = context => RingtoetsCommonDataResources.HydraulicBoundaryConditions_DisplayName, ForeColor = context => context.WrappedData.Any() ? Color.FromKnownColor(KnownColor.ControlText) : Color.FromKnownColor(KnownColor.GrayText), Image = context => RingtoetsCommonFormsResources.GeneralFolderIcon, ContextMenuStrip = DuneLocationCalculationsGroupContextMenuStrip, ChildNodeObjects = DuneLocationCalculationsGroupContextChildNodeObjects }; yield return new TreeNodeInfo { Text = context => RingtoetsPluginHelper.FormatCategoryBoundaryName(context.CategoryBoundaryName), Image = context => RingtoetsCommonFormsResources.GenericInputOutputIcon, ContextMenuStrip = DuneLocationCalculationsContextMenuStrip }; } public override IEnumerable GetViewInfos() { yield return new ViewInfo< FailureMechanismSectionResultContext, IObservableEnumerable, DuneErosionFailureMechanismResultView> { GetViewName = (view, context) => RingtoetsCommonFormsResources.FailureMechanism_AssessmentResult_DisplayName, Image = RingtoetsCommonFormsResources.FailureMechanismSectionResultIcon, CloseForData = CloseFailureMechanismResultViewForData, GetViewData = context => context.WrappedData, CreateInstance = context => new DuneErosionFailureMechanismResultView( context.WrappedData, (DuneErosionFailureMechanism) context.FailureMechanism) }; yield return new ViewInfo { GetViewName = (view, context) => context.WrappedData.Name, Image = RingtoetsCommonFormsResources.CalculationIcon, CloseForData = CloseFailureMechanismViewForData, CreateInstance = context => new DuneErosionFailureMechanismView(context.WrappedData, context.Parent), AdditionalDataCheck = context => context.WrappedData.IsRelevant }; yield return new ViewInfo, DuneLocationCalculationsView> { GetViewName = (view, context) => $"{RingtoetsCommonDataResources.HydraulicBoundaryConditions_DisplayName} - " + $"{RingtoetsPluginHelper.FormatCategoryBoundaryName(context.CategoryBoundaryName)}", Image = RingtoetsCommonFormsResources.GenericInputOutputIcon, GetViewData = context => context.WrappedData, CloseForData = CloseDuneLocationCalculationsViewForData, CreateInstance = context => new DuneLocationCalculationsView(context.WrappedData, context.FailureMechanism, context.AssessmentSection, context.GetNormFunc, context.CategoryBoundaryName), AfterCreate = (view, context) => { view.CalculationGuiService = duneLocationCalculationGuiService; }, AdditionalDataCheck = context => context.WrappedData.Any() }; } public override IEnumerable GetExportInfos() { yield return new ExportInfo { Name = RingtoetsCommonDataResources.HydraulicBoundaryConditions_DisplayName, CreateFileExporter = (context, filePath) => CreateDuneLocationCalculationsExporter(context.WrappedData .Select(calc => new ExportableDuneLocationCalculation( calc, context.GetNormFunc(), context.CategoryBoundaryName)).ToArray(), filePath), IsEnabled = context => context.WrappedData.Any(calculation => calculation.Output != null), FileFilterGenerator = new FileFilterGenerator( Resources.DuneErosionPlugin_GetExportInfos_Boundary_conditions_file_filter_Extension, Resources.DuneErosionPlugin_GetExportInfos_Boundary_conditions_file_filter_Description) }; yield return new ExportInfo { Name = RingtoetsCommonDataResources.HydraulicBoundaryConditions_DisplayName, CreateFileExporter = CreateDuneLocationCalculationsGroupContextFileExporter, IsEnabled = IsDuneLocationCalculationsGroupContextExportMenuItemEnabled, FileFilterGenerator = new FileFilterGenerator( Resources.DuneErosionPlugin_GetExportInfos_Boundary_conditions_file_filter_Extension, Resources.DuneErosionPlugin_GetExportInfos_Boundary_conditions_file_filter_Description) }; } public override IEnumerable GetUpdateInfos() { yield return RingtoetsUpdateInfoFactory.CreateFailureMechanismSectionsUpdateInfo< DuneErosionFailureMechanismSectionsContext, DuneErosionFailureMechanism, DuneErosionFailureMechanismSectionResult>( new DuneErosionFailureMechanismSectionResultUpdateStrategy()); } public override void Activate() { base.Activate(); if (Gui == null) { throw new InvalidOperationException("Gui cannot be null"); } duneLocationCalculationGuiService = new DuneLocationCalculationGuiService(Gui.MainWindow); } private static bool IsDuneLocationCalculationsGroupContextExportMenuItemEnabled(DuneLocationCalculationsGroupContext context) { return context.FailureMechanism.CalculationsForMechanismSpecificFactorizedSignalingNorm.Any(calculation => calculation.Output != null) || context.FailureMechanism.CalculationsForMechanismSpecificSignalingNorm.Any(calculation => calculation.Output != null) || context.FailureMechanism.CalculationsForMechanismSpecificLowerLimitNorm.Any(calculation => calculation.Output != null) || context.FailureMechanism.CalculationsForLowerLimitNorm.Any(calculation => calculation.Output != null) || context.FailureMechanism.CalculationsForFactorizedLowerLimitNorm.Any(calculation => calculation.Output != null); } private static IFileExporter CreateDuneLocationCalculationsGroupContextFileExporter(DuneLocationCalculationsGroupContext context, string filePath) { return CreateDuneLocationCalculationsExporter(DuneLocationCalculationsGroupContextChildNodeObjects(context) .Cast() .SelectMany(c => c.WrappedData.Select( calc => new ExportableDuneLocationCalculation( calc, c.GetNormFunc(), c.CategoryBoundaryName))), filePath); } private static DuneLocationCalculationsExporter CreateDuneLocationCalculationsExporter(IEnumerable exportableCalculations, string filePath) { return new DuneLocationCalculationsExporter(exportableCalculations, filePath, new NoProbabilityValueDoubleConverter()); } #region TreeNodeInfo #region FailureMechanismContext TreeNodeInfo private static object[] FailureMechanismEnabledChildNodeObjects(DuneErosionFailureMechanismContext failureMechanismContext) { DuneErosionFailureMechanism wrappedData = failureMechanismContext.WrappedData; IAssessmentSection assessmentSection = failureMechanismContext.Parent; return new object[] { new CategoryTreeFolder(RingtoetsCommonFormsResources.FailureMechanism_Inputs_DisplayName, GetInputs(wrappedData, assessmentSection), TreeFolderCategory.Input), new DuneLocationCalculationsGroupContext(failureMechanismContext.WrappedData.DuneLocations, failureMechanismContext.WrappedData, assessmentSection), new CategoryTreeFolder(RingtoetsCommonFormsResources.FailureMechanism_Outputs_DisplayName, GetOutputs(wrappedData, assessmentSection), TreeFolderCategory.Output) }; } private static IEnumerable GetInputs(DuneErosionFailureMechanism failureMechanism, IAssessmentSection assessmentSection) { return new object[] { new DuneErosionFailureMechanismSectionsContext(failureMechanism, assessmentSection), failureMechanism.InputComments }; } private static IEnumerable GetOutputs(DuneErosionFailureMechanism failureMechanism, IAssessmentSection assessmentSection) { return new object[] { new FailureMechanismAssemblyCategoriesContext(failureMechanism, assessmentSection, () => failureMechanism.GeneralInput.N), new FailureMechanismSectionResultContext( failureMechanism.SectionResults, failureMechanism), failureMechanism.OutputComments }; } private static object[] FailureMechanismDisabledChildNodeObjects(DuneErosionFailureMechanismContext failureMechanismContext) { return new object[] { failureMechanismContext.WrappedData.NotRelevantComments }; } private ContextMenuStrip FailureMechanismEnabledContextMenuStrip(DuneErosionFailureMechanismContext failureMechanismContext, object parentData, TreeViewControl treeViewControl) { var builder = new RingtoetsContextMenuBuilder(Gui.Get(failureMechanismContext, treeViewControl)); return builder.AddOpenItem() .AddSeparator() .AddToggleRelevancyOfFailureMechanismItem(failureMechanismContext, RemoveAllViewsForItem) .AddSeparator() .AddCustomItem(CreateCalculateAllItem(failureMechanismContext.WrappedData, failureMechanismContext.Parent)) .AddSeparator() .AddCollapseAllItem() .AddExpandAllItem() .AddSeparator() .AddPropertiesItem() .Build(); } private ContextMenuStrip FailureMechanismDisabledContextMenuStrip(DuneErosionFailureMechanismContext failureMechanismContext, object parentData, TreeViewControl treeViewControl) { var builder = new RingtoetsContextMenuBuilder(Gui.Get(failureMechanismContext, treeViewControl)); return builder.AddToggleRelevancyOfFailureMechanismItem(failureMechanismContext, RemoveAllViewsForItem) .AddSeparator() .AddCollapseAllItem() .AddExpandAllItem() .AddSeparator() .AddPropertiesItem() .Build(); } private void RemoveAllViewsForItem(DuneErosionFailureMechanismContext failureMechanismContext) { Gui.ViewCommands.RemoveAllViewsForItem(failureMechanismContext); } #endregion #region DuneLocationCalculationsGroupContext TreeNodeInfo private ContextMenuStrip DuneLocationCalculationsGroupContextMenuStrip(DuneLocationCalculationsGroupContext nodeData, object parentData, TreeViewControl treeViewControl) { return Gui.Get(nodeData, treeViewControl) .AddExportItem() .AddSeparator() .AddCustomItem(CreateCalculateAllItem(nodeData.FailureMechanism, nodeData.AssessmentSection)) .AddSeparator() .AddCollapseAllItem() .AddExpandAllItem() .Build(); } private static object[] DuneLocationCalculationsGroupContextChildNodeObjects(DuneLocationCalculationsGroupContext context) { return !context.WrappedData.Any() ? new object[0] : new object[] { new DuneLocationCalculationsContext( context.FailureMechanism.CalculationsForMechanismSpecificFactorizedSignalingNorm, context.FailureMechanism, context.AssessmentSection, () => context.FailureMechanism.GetNorm(context.AssessmentSection, FailureMechanismCategoryType.MechanismSpecificFactorizedSignalingNorm), RingtoetsCommonDataResources.FailureMechanismCategoryType_MechanismSpecificFactorizedSignalingNorm_DisplayName), new DuneLocationCalculationsContext( context.FailureMechanism.CalculationsForMechanismSpecificSignalingNorm, context.FailureMechanism, context.AssessmentSection, () => context.FailureMechanism.GetNorm(context.AssessmentSection, FailureMechanismCategoryType.MechanismSpecificSignalingNorm), RingtoetsCommonDataResources.FailureMechanismCategoryType_MechanismSpecificSignalingNorm_DisplayName), new DuneLocationCalculationsContext( context.FailureMechanism.CalculationsForMechanismSpecificLowerLimitNorm, context.FailureMechanism, context.AssessmentSection, () => context.FailureMechanism.GetNorm(context.AssessmentSection, FailureMechanismCategoryType.MechanismSpecificLowerLimitNorm), RingtoetsCommonDataResources.FailureMechanismCategoryType_MechanismSpecificLowerLimitNorm_DisplayName), new DuneLocationCalculationsContext( context.FailureMechanism.CalculationsForLowerLimitNorm, context.FailureMechanism, context.AssessmentSection, () => context.FailureMechanism.GetNorm(context.AssessmentSection, FailureMechanismCategoryType.LowerLimitNorm), RingtoetsCommonDataResources.FailureMechanismCategoryType_LowerLimitNorm_DisplayName), new DuneLocationCalculationsContext( context.FailureMechanism.CalculationsForFactorizedLowerLimitNorm, context.FailureMechanism, context.AssessmentSection, () => context.FailureMechanism.GetNorm(context.AssessmentSection, FailureMechanismCategoryType.FactorizedLowerLimitNorm), RingtoetsCommonDataResources.FailureMechanismCategoryType_FactorizedLowerLimitNorm_DisplayName) }; } #endregion #region DuneLocationCalculationsContext TreeNodeInfo private static string ValidateAllDataAvailableAndGetErrorMessage(IAssessmentSection assessmentSection, double norm) { string errorMessage = HydraulicBoundaryDatabaseConnectionValidator.Validate(assessmentSection.HydraulicBoundaryDatabase); if (string.IsNullOrEmpty(errorMessage)) { TargetProbabilityCalculationServiceHelper.ValidateTargetProbability(norm, logMessage => errorMessage = logMessage); } return errorMessage; } private ContextMenuStrip DuneLocationCalculationsContextMenuStrip(DuneLocationCalculationsContext context, object parent, TreeViewControl treeViewControl) { var calculateAllItem = new StrictContextMenuItem( RingtoetsCommonFormsResources.Calculate_All, RingtoetsCommonFormsResources.HydraulicLoads_Calculate_All_ToolTip, RingtoetsCommonFormsResources.CalculateAllIcon, (sender, args) => { if (duneLocationCalculationGuiService == null) { return; } duneLocationCalculationGuiService.Calculate(context.WrappedData, context.AssessmentSection, context.GetNormFunc(), context.CategoryBoundaryName); }); string validationText = ValidateAllDataAvailableAndGetErrorMessage(context.AssessmentSection, context.GetNormFunc()); if (!string.IsNullOrEmpty(validationText)) { calculateAllItem.Enabled = false; calculateAllItem.ToolTipText = validationText; } return Gui.Get(context, treeViewControl) .AddOpenItem() .AddSeparator() .AddExportItem() .AddSeparator() .AddCustomItem(calculateAllItem) .AddSeparator() .AddPropertiesItem() .Build(); } #endregion private StrictContextMenuItem CreateCalculateAllItem(DuneErosionFailureMechanism failureMechanism, IAssessmentSection assessmentSection) { var calculateAllItem = new StrictContextMenuItem( RingtoetsCommonFormsResources.Calculate_All, RingtoetsCommonFormsResources.HydraulicLoads_Calculate_All_ToolTip, RingtoetsCommonFormsResources.CalculateAllIcon, (sender, args) => { ActivityProgressDialogRunner.Run(Gui.MainWindow, DuneLocationCalculationActivityFactory.CreateCalculationActivities(failureMechanism, assessmentSection)); }); string validationText = HydraulicBoundaryDatabaseConnectionValidator.Validate(assessmentSection.HydraulicBoundaryDatabase); if (string.IsNullOrEmpty(validationText) && !failureMechanism.DuneLocations.Any()) { validationText = Resources.DuneErosionPlugin_CreateCalculateAllItem_No_calculatable_locations_present; } if (!string.IsNullOrEmpty(validationText)) { calculateAllItem.Enabled = false; calculateAllItem.ToolTipText = validationText; } return calculateAllItem; } #endregion #region ViewInfo #region DuneErosionFailureMechanismResultView ViewInfo private static bool CloseFailureMechanismResultViewForData(DuneErosionFailureMechanismResultView view, object o) { var assessmentSection = o as IAssessmentSection; var failureMechanism = o as DuneErosionFailureMechanism; var failureMechanismContext = o as IFailureMechanismContext; if (assessmentSection != null) { return assessmentSection .GetFailureMechanisms() .OfType() .Any(fm => ReferenceEquals(view.FailureMechanism.SectionResults, fm.SectionResults)); } if (failureMechanismContext != null) { failureMechanism = failureMechanismContext.WrappedData; } return failureMechanism != null && ReferenceEquals(view.FailureMechanism.SectionResults, failureMechanism.SectionResults); } #endregion #region DuneErosionFailureMechanismView ViewInfo private static bool CloseFailureMechanismViewForData(DuneErosionFailureMechanismView view, object data) { var assessmentSection = data as IAssessmentSection; var failureMechanism = data as DuneErosionFailureMechanism; return assessmentSection != null ? ReferenceEquals(view.AssessmentSection, assessmentSection) : ReferenceEquals(view.FailureMechanism, failureMechanism); } #endregion #region DuneLocationCalculationsView ViewInfo private static bool CloseDuneLocationCalculationsViewForData(DuneLocationCalculationsView view, object dataToCloseFor) { var failureMechanismContext = dataToCloseFor as DuneErosionFailureMechanismContext; var assessmentSection = dataToCloseFor as IAssessmentSection; var failureMechanism = dataToCloseFor as DuneErosionFailureMechanism; if (assessmentSection != null) { failureMechanism = ((IAssessmentSection) dataToCloseFor).GetFailureMechanisms().OfType().Single(); } if (failureMechanismContext != null) { failureMechanism = failureMechanismContext.WrappedData; } return failureMechanism != null && ReferenceEquals(failureMechanism, view.FailureMechanism); } #endregion #endregion } }