// 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.Collections;
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;
using Core.Common.Gui.ContextMenu;
using Core.Common.Gui.Forms.ProgressDialog;
using Core.Common.Gui.Plugin;
using Core.Common.Utils;
using Ringtoets.Common.Data;
using Ringtoets.Common.Data.AssessmentSection;
using Ringtoets.Common.Data.Calculation;
using Ringtoets.Common.Data.FailureMechanism;
using Ringtoets.Common.Data.Structures;
using Ringtoets.Common.Forms;
using Ringtoets.Common.Forms.ChangeHandlers;
using Ringtoets.Common.Forms.ExportInfos;
using Ringtoets.Common.Forms.Helpers;
using Ringtoets.Common.Forms.ImportInfos;
using Ringtoets.Common.Forms.PresentationObjects;
using Ringtoets.Common.Forms.PropertyClasses;
using Ringtoets.Common.Forms.TreeNodeInfos;
using Ringtoets.Common.IO.FileImporters.MessageProviders;
using Ringtoets.Common.IO.Structures;
using Ringtoets.Common.Service;
using Ringtoets.Common.Utils;
using Ringtoets.HeightStructures.Data;
using Ringtoets.HeightStructures.Forms.PresentationObjects;
using Ringtoets.HeightStructures.Forms.PropertyClasses;
using Ringtoets.HeightStructures.Forms.Views;
using Ringtoets.HeightStructures.IO;
using Ringtoets.HeightStructures.IO.Configurations;
using Ringtoets.HeightStructures.Plugin.FileImporters;
using Ringtoets.HeightStructures.Service;
using RingtoetsCommonFormsResources = Ringtoets.Common.Forms.Properties.Resources;
using RingtoetsCommonDataResources = Ringtoets.Common.Data.Properties.Resources;
using RingtoetsCommonIOResources = Ringtoets.Common.IO.Properties.Resources;
namespace Ringtoets.HeightStructures.Plugin
{
///
/// The plug-in for the .
///
public class HeightStructuresPlugin : PluginBase
{
public override IEnumerable GetPropertyInfos()
{
yield return new PropertyInfo
{
CreateInstance = context => new HeightStructuresFailureMechanismProperties(
context.WrappedData,
new FailureMechanismPropertyChangeHandler())
};
yield return new PropertyInfo();
yield return new PropertyInfo>
{
CreateInstance = context => new StructureCollectionProperties(context.WrappedData)
};
yield return new PropertyInfo
{
CreateInstance = context => new HeightStructuresInputContextProperties(
context,
new ObservablePropertyChangeHandler(context.Calculation, context.WrappedData))
};
}
public override IEnumerable GetImportInfos()
{
yield return new ImportInfo
{
Name = RingtoetsCommonFormsResources.StructuresImporter_DisplayName,
Category = RingtoetsCommonFormsResources.Ringtoets_Category,
Image = RingtoetsCommonFormsResources.StructuresIcon,
IsEnabled = IsHeightStructuresImportEnabled,
FileFilterGenerator = CreateHeightStructureFileFilter(),
CreateFileImporter = (context, filePath) => CreateHeightStructuresImporter(
context, filePath, new ImportMessageProvider(), new HeightStructureReplaceDataStrategy(context.FailureMechanism)),
VerifyUpdates = context =>
VerifyStructuresShouldUpdate(
context.FailureMechanism,
RingtoetsCommonIOResources.VerifyStructuresShouldUpdate_When_importing_Calculation_with_Structure_data_output_will_be_cleared_confirm)
};
yield return RingtoetsImportInfoFactory.CreateCalculationConfigurationImportInfo(
(context, filePath) => new HeightStructuresCalculationConfigurationImporter(
filePath,
context.WrappedData,
context.AvailableHydraulicBoundaryLocations,
context.AvailableForeshoreProfiles,
context.AvailableStructures,
context.FailureMechanism));
}
public override IEnumerable GetUpdateInfos()
{
yield return new UpdateInfo
{
Name = RingtoetsCommonDataResources.StructureCollection_TypeDescriptor,
Category = RingtoetsCommonFormsResources.Ringtoets_Category,
Image = RingtoetsCommonFormsResources.StructuresIcon,
IsEnabled = context => context.WrappedData.SourcePath != null,
FileFilterGenerator = CreateHeightStructureFileFilter(),
CreateFileImporter = (context, filePath) => CreateHeightStructuresImporter(
context, filePath, new UpdateMessageProvider(), new HeightStructureUpdateDataStrategy(context.FailureMechanism)),
CurrentPath = context => context.WrappedData.SourcePath,
VerifyUpdates = context =>
VerifyStructuresShouldUpdate(
context.FailureMechanism,
RingtoetsCommonIOResources.VerifyStructuresShouldUpdate_When_updating_Calculation_with_Structure_data_output_will_be_cleared_confirm)
};
}
public override IEnumerable GetExportInfos()
{
yield return RingtoetsExportInfoFactory.CreateCalculationGroupConfigurationExportInfo(
(context, filePath) => new HeightStructuresCalculationConfigurationExporter(context.WrappedData.Children, filePath),
context => context.WrappedData.Children.Any());
yield return RingtoetsExportInfoFactory.CreateCalculationConfigurationExportInfo(
(context, filePath) => new HeightStructuresCalculationConfigurationExporter(new[]
{
context.WrappedData
}, filePath));
}
public override IEnumerable GetViewInfos()
{
yield return new ViewInfo
{
GetViewName = (view, mechanism) => mechanism.WrappedData.Name,
Image = RingtoetsCommonFormsResources.CalculationIcon,
CloseForData = CloseHeightStructuresFailureMechanismViewForData,
AdditionalDataCheck = context => context.WrappedData.IsRelevant
};
yield return new ViewInfo<
HeightStructuresScenariosContext,
CalculationGroup,
HeightStructuresScenariosView>
{
GetViewData = context => context.WrappedData,
GetViewName = (view, calculationGroup) => RingtoetsCommonFormsResources.Scenarios_DisplayName,
AfterCreate = (view, context) => view.FailureMechanism = context.ParentFailureMechanism,
CloseForData = CloseScenariosViewForData,
Image = RingtoetsCommonFormsResources.ScenariosIcon
};
yield return new ViewInfo<
FailureMechanismSectionResultContext,
IEnumerable,
HeightStructuresFailureMechanismResultView>
{
GetViewName = (view, results) => 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(
CalculationGroupContextChildNodeObjects,
CalculationGroupContextContextMenuStrip,
CalculationGroupContextOnNodeRemoved);
yield return RingtoetsTreeNodeInfoFactory.CreateCalculationContextTreeNodeInfo(
CalculationContextChildNodeObjects,
CalculationContextContextMenuStrip,
CalculationContextOnNodeRemoved);
yield return new TreeNodeInfo
{
Text = inputContext => RingtoetsCommonFormsResources.FailureMechanism_Inputs_DisplayName,
Image = inputContext => RingtoetsCommonFormsResources.GenericInputOutputIcon,
ContextMenuStrip = (nodeData, parentData, treeViewControl) => Gui.Get(nodeData, treeViewControl)
.AddPropertiesItem()
.Build()
};
yield return new TreeNodeInfo
{
Text = context => RingtoetsCommonFormsResources.StructuresCollection_DisplayName,
Image = context => RingtoetsCommonFormsResources.GeneralFolderIcon,
ForeColor = context => context.WrappedData.Any()
? Color.FromKnownColor(KnownColor.ControlText)
: Color.FromKnownColor(KnownColor.GrayText),
ChildNodeObjects = context => context.WrappedData.Cast