// 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; using System.Collections; using System.Collections.Generic; using System.Drawing; using System.Linq; using System.Windows.Forms; using Core.Common.Base; using Core.Common.Controls.TreeView; using Core.Common.Gui.ContextMenu; using Core.Common.Gui.Plugin; using log4net; using Ringtoets.Common.Data; using Ringtoets.Common.Data.AssessmentSection; using Ringtoets.Common.Forms.GuiServices; using Ringtoets.Common.Forms.PresentationObjects; using Ringtoets.Common.Forms.TreeNodeInfos; using Ringtoets.Common.IO; using Ringtoets.GrassCoverErosionOutwards.Data; using Ringtoets.GrassCoverErosionOutwards.Forms.PresentationObjects; using Ringtoets.GrassCoverErosionOutwards.Forms.PropertyClasses; using Ringtoets.GrassCoverErosionOutwards.Forms.Views; using Ringtoets.GrassCoverErosionOutwards.Plugin.Properties; using Ringtoets.GrassCoverErosionOutwards.Service.MessageProviders; using RingtoetsGrassCoverErosionOutwardsFormsResources = Ringtoets.GrassCoverErosionOutwards.Forms.Properties.Resources; using RingtoetsCommonDataResources = Ringtoets.Common.Data.Properties.Resources; using RingtoetsCommonFormsResources = Ringtoets.Common.Forms.Properties.Resources; using RingtoetsCommonIoResources = Ringtoets.Common.IO.Properties.Resources; namespace Ringtoets.GrassCoverErosionOutwards.Plugin { /// /// The plug-in for the . /// public class GrassCoverErosionOutwardsPlugin : PluginBase { private static readonly ILog log = LogManager.GetLogger(typeof(GrassCoverErosionOutwardsPlugin)); private IHydraulicBoundaryLocationCalculationGuiService hydraulicBoundaryLocationCalculationGuiService; public override IEnumerable GetPropertyInfos() { yield return new PropertyInfo { GetObjectPropertiesData = context => context.WrappedData }; yield return new PropertyInfo { GetObjectPropertiesData = context => context.WrappedData }; yield return new PropertyInfo { GetObjectPropertiesData = context => context.WrappedData }; } public override IEnumerable GetViewInfos() { yield return new ViewInfo< FailureMechanismSectionResultContext, IEnumerable, GrassCoverErosionOutwardsFailureMechanismResultView> { 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 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, Image = context => RingtoetsCommonFormsResources.GeneralFolderIcon, ChildNodeObjects = nodeData => GetHydraulicBoundariesGroupContextChildNodeObjects(nodeData), ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl) .AddExportItem() .AddSeparator() .AddExpandAllItem() .AddCollapseAllItem() .Build() }; yield return new TreeNodeInfo { Text = context => RingtoetsGrassCoverErosionOutwardsFormsResources.GrassCoverErosionOutwardsWaterLevelLocationsContext_DisplayName, Image = context => RingtoetsCommonFormsResources.GenericInputOutputIcon, ForeColor = context => context.AssessmentSection.HydraulicBoundaryDatabase == null ? Color.FromKnownColor(KnownColor.GrayText) : Color.FromKnownColor(KnownColor.ControlText), ContextMenuStrip = GrassCoverErosionOutwardsDesignWaterLevelLocationsContextMenuStrip }; yield return new TreeNodeInfo { Text = context => RingtoetsGrassCoverErosionOutwardsFormsResources.GrassCoverErosionOutwardsWaveHeightLocationsContext_DisplayName, Image = context => RingtoetsCommonFormsResources.GenericInputOutputIcon, ForeColor = context => context.AssessmentSection.HydraulicBoundaryDatabase == null ? Color.FromKnownColor(KnownColor.GrayText) : Color.FromKnownColor(KnownColor.ControlText), ContextMenuStrip = GrassCoverErosionOutwardsWaveHeightLocationsContextMenuStrip }; } public override IEnumerable GetExportInfos() { yield return new ExportInfo { CreateFileExporter = (context, filePath) => new HydraulicBoundaryLocationsExporter(context.WrappedData.GrassCoverErosionOutwardsHydraulicBoundaryLocations, filePath, Resources.DesignWaterLevel_Description, Resources.WaveHeight_Description), IsEnabled = context => context.WrappedData.GrassCoverErosionOutwardsHydraulicBoundaryLocations.Count > 0, FileFilter = RingtoetsCommonIoResources.DataTypeDisplayName_shape_file_filter }; } public override void Activate() { base.Activate(); if (Gui == null) { throw new InvalidOperationException("Gui cannot be null"); } hydraulicBoundaryLocationCalculationGuiService = new HydraulicBoundaryLocationCalculationGuiService(Gui.MainWindow); } #region ViewInfos #region GrassCoverErosionOutwardsFailureMechanismResultView ViewInfo private static bool CloseFailureMechanismResultViewForData(GrassCoverErosionOutwardsFailureMechanismResultView view, object o) { var assessmentSection = o as IAssessmentSection; var failureMechanism = o as GrassCoverErosionOutwardsFailureMechanism; var failureMechanismContext = o as IFailureMechanismContext; if (assessmentSection != null) { return assessmentSection .GetFailureMechanisms() .OfType() .Any(fm => ReferenceEquals(view.Data, fm.SectionResults)); } if (failureMechanismContext != null) { failureMechanism = failureMechanismContext.WrappedData; } return failureMechanism != null && ReferenceEquals(view.Data, failureMechanism.SectionResults); } #endregion #endregion #region TreeNodeInfos #region GrassCoverErosionOutwardsFailureMechanismContext TreeNodeInfo private object[] FailureMechanismEnabledChildNodeObjects(GrassCoverErosionOutwardsFailureMechanismContext failureMechanismContext) { GrassCoverErosionOutwardsFailureMechanism failureMechanism = failureMechanismContext.WrappedData; return new object[] { new CategoryTreeFolder(RingtoetsCommonFormsResources.FailureMechanism_Inputs_DisplayName, GetInputs(failureMechanism, failureMechanismContext.Parent), TreeFolderCategory.Input), new HydraulicBoundariesGroupContext(failureMechanism, failureMechanismContext.Parent), new CategoryTreeFolder(RingtoetsCommonFormsResources.FailureMechanism_Outputs_DisplayName, GetOutputs(failureMechanism), TreeFolderCategory.Output) }; } private object[] FailureMechanismDisabledChildNodeObjects(GrassCoverErosionOutwardsFailureMechanismContext failureMechanismContext) { return new object[] { new CommentContext(failureMechanismContext.WrappedData) }; } private static IList GetInputs(GrassCoverErosionOutwardsFailureMechanism failureMechanism, IAssessmentSection assessmentSection) { return new ArrayList { new FailureMechanismSectionsContext(failureMechanism, assessmentSection), new ForeshoreProfilesContext(failureMechanism.ForeshoreProfiles, assessmentSection), new CommentContext(failureMechanism) }; } private static IList GetOutputs(GrassCoverErosionOutwardsFailureMechanism failureMechanism) { return new ArrayList { new FailureMechanismSectionResultContext(failureMechanism.SectionResults, failureMechanism) }; } private ContextMenuStrip FailureMechanismEnabledContextMenuStrip(GrassCoverErosionOutwardsFailureMechanismContext grassCoverErosionOutwardsFailureMechanismContext, object parentData, TreeViewControl treeViewControl) { var builder = new RingtoetsContextMenuBuilder(Gui.Get(grassCoverErosionOutwardsFailureMechanismContext, treeViewControl)); return builder.AddToggleRelevancyOfFailureMechanismItem(grassCoverErosionOutwardsFailureMechanismContext, RemoveAllViewsForItem) .AddSeparator() .AddExpandAllItem() .AddCollapseAllItem() .AddSeparator() .AddPropertiesItem() .Build(); } private void RemoveAllViewsForItem(GrassCoverErosionOutwardsFailureMechanismContext failureMechanismContext) { Gui.ViewCommands.RemoveAllViewsForItem(failureMechanismContext); } private ContextMenuStrip FailureMechanismDisabledContextMenuStrip(GrassCoverErosionOutwardsFailureMechanismContext grassCoverErosionOutwardsFailureMechanismContext, object parentData, TreeViewControl treeViewControl) { var builder = new RingtoetsContextMenuBuilder(Gui.Get(grassCoverErosionOutwardsFailureMechanismContext, treeViewControl)); return builder.AddToggleRelevancyOfFailureMechanismItem(grassCoverErosionOutwardsFailureMechanismContext, null) .AddSeparator() .AddExpandAllItem() .AddCollapseAllItem() .Build(); } private object[] GetHydraulicBoundariesGroupContextChildNodeObjects(HydraulicBoundariesGroupContext hydraulicBoundariesGroupContext) { IAssessmentSection assessmentSection = hydraulicBoundariesGroupContext.AssessmentSection; ObservableList locations = hydraulicBoundariesGroupContext.WrappedData.GrassCoverErosionOutwardsHydraulicBoundaryLocations; return new object[] { new GrassCoverErosionOutwardsDesignWaterLevelLocationsContext(locations, assessmentSection), new GrassCoverErosionOutwardsWaveHeightLocationsContext(locations, assessmentSection) }; } #endregion #region GrassCoverErosionOutwardsDesignWaterLevelLocationsContext TreeNodeInfo private ContextMenuStrip GrassCoverErosionOutwardsDesignWaterLevelLocationsContextMenuStrip(GrassCoverErosionOutwardsDesignWaterLevelLocationsContext nodeData, object parentData, TreeViewControl treeViewControl) { var designWaterLevelItem = new StrictContextMenuItem( RingtoetsGrassCoverErosionOutwardsFormsResources.GrassCoverErosionOutwardsWaterLevelLocation_Calculate_All, nodeData.AssessmentSection.HydraulicBoundaryDatabase != null ? RingtoetsGrassCoverErosionOutwardsFormsResources.GrassCoverErosionOutwardsWaterLevelLocation_Calculate_All_ToolTip : RingtoetsGrassCoverErosionOutwardsFormsResources.GrassCoverErosionOutwardsWaterLevelLocation_No_HRD_To_Calculate, RingtoetsCommonFormsResources.CalculateAllIcon, (sender, args) => { if (hydraulicBoundaryLocationCalculationGuiService == null) { return; } IAssessmentSection assessmentSection = nodeData.AssessmentSection; GrassCoverErosionOutwardsFailureMechanism failureMechanism = assessmentSection.GetFailureMechanisms().OfType().FirstOrDefault(); if (failureMechanism == null) { return; } if (!(failureMechanism.Contribution > 0)) { log.Info(Resources.GrassCoverErosionOutwardsPlugin_CalculateDesignWaterLevel_Cannot_calculate_when_Contribution_is_zero); return; } var correctedNormFactor = assessmentSection.FailureMechanismContribution.Norm/ (failureMechanism.Contribution/100)* failureMechanism.GeneralInput.N; bool successfulCalculation = hydraulicBoundaryLocationCalculationGuiService.CalculateDesignWaterLevels( assessmentSection.HydraulicBoundaryDatabase.FilePath, nodeData.WrappedData, assessmentSection.Id, correctedNormFactor, new GrassCoverErosionOutwardsDesignWaterLevelCalculationMessageProvider()); if (successfulCalculation) { nodeData.WrappedData.NotifyObservers(); } }); if (nodeData.AssessmentSection.HydraulicBoundaryDatabase == null) { designWaterLevelItem.Enabled = false; } return Gui.Get(nodeData, treeViewControl) .AddCustomItem(designWaterLevelItem) .AddSeparator() .AddPropertiesItem() .Build(); } #endregion #region GrassCoverErosionOutwardsWaveHeightLocationsContext TreeNodeInfo private ContextMenuStrip GrassCoverErosionOutwardsWaveHeightLocationsContextMenuStrip(GrassCoverErosionOutwardsWaveHeightLocationsContext nodeData, object parentData, TreeViewControl treeViewControl) { var waveHeightItem = new StrictContextMenuItem( RingtoetsCommonFormsResources.Calculate_all, nodeData.AssessmentSection.HydraulicBoundaryDatabase == null ? RingtoetsGrassCoverErosionOutwardsFormsResources.GrassCoverErosionOutwards_WaveHeight_No_HRD_To_Calculate : RingtoetsGrassCoverErosionOutwardsFormsResources.GrassCoverErosionOutwards_WaveHeight_Calculate_All_ToolTip, RingtoetsCommonFormsResources.CalculateAllIcon, (sender, args) => { if (hydraulicBoundaryLocationCalculationGuiService == null) { return; } IAssessmentSection assessmentSection = nodeData.AssessmentSection; GrassCoverErosionOutwardsFailureMechanism failureMechanism = assessmentSection.GetFailureMechanisms().OfType().FirstOrDefault(); if (failureMechanism == null) { return; } if (!(failureMechanism.Contribution > 0)) { log.Info(Resources.GrassCoverErosionOutwardsPlugin_CalculateWaveHeights_Cannot_calculate_when_Contribution_is_zero); return; } var correctedNormFactor = assessmentSection.FailureMechanismContribution.Norm/ (failureMechanism.Contribution/100)* failureMechanism.GeneralInput.N; bool successfulCalculation = hydraulicBoundaryLocationCalculationGuiService.CalculateWaveHeights( assessmentSection.HydraulicBoundaryDatabase.FilePath, nodeData.WrappedData, assessmentSection.Id, correctedNormFactor, new GrassCoverErosionOutwardsWaveHeightCalculationMessageProvider()); if (successfulCalculation) { nodeData.WrappedData.NotifyObservers(); } }); if (nodeData.AssessmentSection.HydraulicBoundaryDatabase == null) { waveHeightItem.Enabled = false; } return Gui.Get(nodeData, treeViewControl) .AddCustomItem(waveHeightItem) .AddSeparator() .AddPropertiesItem() .Build(); } #endregion #endregion } }