// 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.IO;
using System.Linq;
using System.Windows.Forms;
using Core.Common.Controls.TreeView;
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.Data.FailureMechanism;
using Ringtoets.Common.Data.Probability;
using Ringtoets.Common.Forms.Helpers;
using Ringtoets.Common.Forms.PresentationObjects;
using Ringtoets.Common.Forms.TreeNodeInfos;
using Ringtoets.HeightStructures.Data;
using Ringtoets.HeightStructures.Forms.PresentationObjects;
using Ringtoets.HeightStructures.Forms.PropertyClasses;
using Ringtoets.HeightStructures.Forms.Views;
using Ringtoets.HeightStructures.Plugin.Properties;
using Ringtoets.HydraRing.Calculation.Activities;
using Ringtoets.HydraRing.Calculation.Data;
using Ringtoets.HydraRing.Calculation.Data.Input.Structures;
using Ringtoets.HydraRing.Calculation.Data.Output;
using Ringtoets.HydraRing.IO;
using RingtoetsCommonFormsResources = Ringtoets.Common.Forms.Properties.Resources;
using RingtoetsCommonDataResources = Ringtoets.Common.Data.Properties.Resources;
using HeightStructuresDataResources = Ringtoets.HeightStructures.Data.Properties.Resources;
using HeightStructuresFormsResources = Ringtoets.HeightStructures.Forms.Properties.Resources;
namespace Ringtoets.HeightStructures.Plugin
{
///
/// The GUI plug-in for the .
///
public class HeightStructuresGuiPlugin : GuiPlugin
{
public override IEnumerable GetPropertyInfos()
{
yield return new PropertyInfo();
yield return new PropertyInfo();
}
public override IEnumerable GetViewInfos()
{
yield return new ViewInfo<
FailureMechanismSectionResultContext,
IEnumerable,
HeightStructuresFailureMechanismResultView>
{
GetViewName = (v, o) => RingtoetsCommonDataResources.FailureMechanism_AssessmentResult_DisplayName,
Image = RingtoetsCommonFormsResources.FailureMechanismSectionResultIcon,
CloseForData = CloseFailureMechanismResultViewForData,
GetViewData = context => context.SectionResults,
AfterCreate = (view, context) => view.FailureMechanism = context.FailureMechanism
};
}
public override IEnumerable GetTreeNodeInfos()
{
yield return RingtoetsTreeNodeInfoFactory.CreateFailureMechanismContextTreeNodeInfo(
FailureMechanismEnabledChildNodeObjects,
FailureMechanismDisabledChildNodeObjects,
FailureMechanismEnabledContextMenuStrip,
FailureMechanismDisabledContextMenuStrip);
yield return RingtoetsTreeNodeInfoFactory.CreateCalculationGroupContextTreeNodeInfo(
CalculationGroupContextChildNodeObjects,
CalculationGroupContextContextMenuStrip,
CalculationGroupContextOnNodeRemoved);
yield return RingtoetsTreeNodeInfoFactory.CreateCalculationContextTreeNodeInfo(
HeightStructuresFormsResources.CalculationIcon,
CalculationContextChildNodeObjects,
CalculationContextContextMenuStrip,
CalculationContextOnNodeRemoved);
yield return new TreeNodeInfo
{
Text = inputContext => HeightStructuresFormsResources.HeightStructuresInputContext_NodeDisplayName,
Image = inputContext => RingtoetsCommonFormsResources.GenericInputOutputIcon,
ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl)
.AddImportItem()
.AddExportItem()
.AddSeparator()
.AddPropertiesItem()
.Build()
};
yield return new TreeNodeInfo
{
Text = output => RingtoetsCommonFormsResources.CalculationOutput_DisplayName,
Image = output => RingtoetsCommonFormsResources.GeneralOutputIcon,
ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl)
.AddExportItem()
.AddSeparator()
.AddPropertiesItem()
.Build()
};
yield return RingtoetsTreeNodeInfoFactory.CreateEmptyProbabilityAssessmentOutputTreeNodeInfo(
EmptyProbabilityAssessmentOutputContextMenuStrip);
yield return new TreeNodeInfo>
{
Text = context => RingtoetsCommonDataResources.FailureMechanism_AssessmentResult_DisplayName,
Image = context => RingtoetsCommonFormsResources.FailureMechanismSectionResultIcon,
ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl)
.AddOpenItem()
.Build()
};
}
private static ExceedanceProbabilityCalculationActivity CreateHydraRingExceedenceProbabilityCalculationActivity(FailureMechanismSection failureMechanismSection,
string hlcdDirectory,
HeightStructuresCalculation calculation)
{
var hydraulicBoundaryLocationId = (int) calculation.InputParameters.HydraulicBoundaryLocation.Id;
var sectionLength = failureMechanismSection.GetSectionLength();
var inputParameters = calculation.InputParameters;
return HydraRingActivityFactory.Create(
calculation.Name,
hlcdDirectory,
failureMechanismSection.Name, // TODO: Provide name of reference line instead
HydraRingTimeIntegrationSchemeType.FBC,
HydraRingUncertaintiesType.All,
new StructuresOvertoppingCalculationInput(hydraulicBoundaryLocationId,
new HydraRingSection(1, failureMechanismSection.Name, sectionLength, inputParameters.OrientationOfTheNormalOfTheStructure),
inputParameters.GravitationalAcceleration,
inputParameters.ModelFactorOvertoppingFlow.Mean, inputParameters.ModelFactorOvertoppingFlow.StandardDeviation,
inputParameters.LevelOfCrestOfStructure.Mean, inputParameters.LevelOfCrestOfStructure.StandardDeviation,
inputParameters.OrientationOfTheNormalOfTheStructure,
inputParameters.ModelFactorOvertoppingSuperCriticalFlow.Mean, inputParameters.ModelFactorOvertoppingSuperCriticalFlow.StandardDeviation,
inputParameters.AllowableIncreaseOfLevelForStorage.Mean, inputParameters.AllowableIncreaseOfLevelForStorage.StandardDeviation,
inputParameters.ModelFactorForStorageVolume.Mean, inputParameters.ModelFactorForStorageVolume.StandardDeviation,
inputParameters.StorageStructureArea.Mean, inputParameters.StorageStructureArea.StandardDeviation,
inputParameters.ModelFactorForIncomingFlowVolume,
inputParameters.FlowWidthAtBottomProtection.Mean, inputParameters.FlowWidthAtBottomProtection.StandardDeviation,
inputParameters.CriticalOvertoppingDischarge.Mean, inputParameters.CriticalOvertoppingDischarge.StandardDeviation,
inputParameters.FailureProbabilityOfStructureGivenErosion,
inputParameters.WidthOfFlowApertures.Mean, inputParameters.WidthOfFlowApertures.StandardDeviation,
inputParameters.DeviationOfTheWaveDirection,
inputParameters.StormDuration.Mean, inputParameters.StormDuration.StandardDeviation),
calculation.ClearOutput,
output => { ParseHydraRingOutput(calculation, output); });
}
private void CalculateAll(HeightStructuresFailureMechanism failureMechanism, IEnumerable calculations, IAssessmentSection assessmentSection)
{
// TODO: Remove "Where" filter when validation is implemented
ActivityProgressDialogRunner.Run(Gui.MainWindow, calculations.Where(calc => calc.InputParameters.HydraulicBoundaryLocation != null)
.Select(calc => CreateHydraRingExceedenceProbabilityCalculationActivity(
failureMechanism.Sections.First(), // TODO: Pass dike section based on cross section of structure with reference line
Path.GetDirectoryName(assessmentSection.HydraulicBoundaryDatabase.FilePath),
calc)).ToList());
}
private static string AllDataAvailable(IAssessmentSection assessmentSection, HeightStructuresFailureMechanism failureMechanism)
{
if (!failureMechanism.Sections.Any())
{
return Resources.HeightStructuresGuiPlugin_AllDataAvailable_No_failure_mechanism_sections_imported;
}
if (assessmentSection.HydraulicBoundaryDatabase == null)
{
return Resources.HeightStructuresGuiPlugin_AllDataAvailable_No_hydraulic_boundary_database_imported;
}
var validationProblem = HydraulicDatabaseHelper.ValidatePathForCalculation(assessmentSection.HydraulicBoundaryDatabase.FilePath);
if (!string.IsNullOrEmpty(validationProblem))
{
return string.Format(RingtoetsCommonFormsResources.GuiPlugin_VerifyHydraulicBoundaryDatabasePath_Hydraulic_boundary_database_connection_failed_0_, validationProblem);
}
return null;
}
private static void ParseHydraRingOutput(HeightStructuresCalculation calculation, ExceedanceProbabilityCalculationOutput output)
{
if (output != null)
{
calculation.NotifyObservers();
}
else
{
throw new InvalidOperationException(Resources.HeightStructuresGuiPlugin_Error_during_overtopping_calculation);
}
}
#region EmptyProbabilityAssessmentOutput TreeNodeInfo
private ContextMenuStrip EmptyProbabilityAssessmentOutputContextMenuStrip(EmptyProbabilityAssessmentOutput output, object parentData, TreeViewControl treeViewControl)
{
var builder = new RingtoetsContextMenuBuilder(Gui.Get(output, treeViewControl));
return builder.AddExportItem()
.AddSeparator()
.AddPropertiesItem()
.Build();
}
#endregion
#region HeightStructuresFailureMechanismResultView ViewInfo
private static bool CloseFailureMechanismResultViewForData(HeightStructuresFailureMechanismResultView view, object o)
{
var assessmentSection = o as IAssessmentSection;
var failureMechanism = o as HeightStructuresFailureMechanism;
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
#region HeightStructuresFailureMechanismContext TreeNodeInfo
private object[] FailureMechanismEnabledChildNodeObjects(HeightStructuresFailureMechanismContext context)
{
HeightStructuresFailureMechanism wrappedData = context.WrappedData;
return new object[]
{
new CategoryTreeFolder(RingtoetsCommonFormsResources.FailureMechanism_Inputs_DisplayName, GetInputs(wrappedData, context.Parent), TreeFolderCategory.Input),
new HeightStructuresCalculationGroupContext(wrappedData.CalculationsGroup, wrappedData, context.Parent),
new CategoryTreeFolder(RingtoetsCommonFormsResources.FailureMechanism_Outputs_DisplayName, GetOutputs(wrappedData), TreeFolderCategory.Output)
};
}
private static IList GetInputs(HeightStructuresFailureMechanism failureMechanism, IAssessmentSection assessmentSection)
{
return new ArrayList
{
new FailureMechanismSectionsContext(failureMechanism, assessmentSection),
new CommentContext(failureMechanism)
};
}
private static IList GetOutputs(HeightStructuresFailureMechanism failureMechanism)
{
return new ArrayList
{
new FailureMechanismSectionResultContext(failureMechanism.SectionResults, failureMechanism)
};
}
private object[] FailureMechanismDisabledChildNodeObjects(HeightStructuresFailureMechanismContext context)
{
return new object[]
{
new CommentContext(context.WrappedData)
};
}
private ContextMenuStrip FailureMechanismEnabledContextMenuStrip(HeightStructuresFailureMechanismContext context, object parentData, TreeViewControl treeViewControl)
{
var builder = new RingtoetsContextMenuBuilder(Gui.Get(context, treeViewControl));
return builder.AddOpenItem()
.AddSeparator()
.AddToggleRelevancyOfFailureMechanismItem(context, RemoveAllViewsForItem)
.AddSeparator()
.AddPerformAllCalculationsInFailureMechanismItem(context, CalculateAll, EnablePerformAllCalculationsInFailureMechanism)
.AddClearAllCalculationOutputInFailureMechanismItem(context.WrappedData)
.AddSeparator()
.AddImportItem()
.AddExportItem()
.AddSeparator()
.AddExpandAllItem()
.AddCollapseAllItem()
.AddSeparator()
.AddPropertiesItem()
.Build();
}
private void RemoveAllViewsForItem(HeightStructuresFailureMechanismContext context)
{
Gui.ViewCommands.RemoveAllViewsForItem(context);
}
private ContextMenuStrip FailureMechanismDisabledContextMenuStrip(HeightStructuresFailureMechanismContext context, object parentData, TreeViewControl treeViewControl)
{
var builder = new RingtoetsContextMenuBuilder(Gui.Get(context, treeViewControl));
return builder.AddToggleRelevancyOfFailureMechanismItem(context, null)
.AddSeparator()
.AddExpandAllItem()
.AddCollapseAllItem()
.Build();
}
private static string EnablePerformAllCalculationsInFailureMechanism(HeightStructuresFailureMechanismContext context)
{
return AllDataAvailable(context.Parent, context.WrappedData);
}
private void CalculateAll(HeightStructuresFailureMechanismContext context)
{
CalculateAll(context.WrappedData, context.WrappedData.Calculations.OfType(), context.Parent);
}
#endregion
#region HeightStructuresCalculationGroupContext TreeNodeInfo
private static object[] CalculationGroupContextChildNodeObjects(HeightStructuresCalculationGroupContext context)
{
var childNodeObjects = new List