// 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.Linq;
using System.Windows.Forms;
using Core.Common.Base;
using Core.Common.Controls.DataGrid;
using Core.Common.Controls.Views;
using Core.Common.Util;
using Ringtoets.Common.Data.FailureMechanism;
using Ringtoets.Common.Forms.Properties;
namespace Ringtoets.Common.Forms.Views
{
///
/// The view for the .
///
/// The type of results which are presented by the .
public abstract partial class FailureMechanismResultView : UserControl, IView where T : FailureMechanismSectionResult
{
protected const int AssessmentLayerOneColumnIndex = 1;
private readonly List failureMechanismSectionResultObservers;
private readonly Observer failureMechanismObserver;
private IObservableEnumerable failureMechanismSectionResults;
private IFailureMechanism failureMechanism;
///
/// Creates a new instance of .
///
/// The collection of to
/// show in the view.
/// Thrown when
/// is null.
protected FailureMechanismResultView(IObservableEnumerable failureMechanismSectionResults)
{
if (failureMechanismSectionResults == null)
{
throw new ArgumentNullException(nameof(failureMechanismSectionResults));
}
InitializeComponent();
this.failureMechanismSectionResults = failureMechanismSectionResults;
failureMechanismObserver = new Observer(UpdateDataGridViewDataSource);
failureMechanismSectionResultObservers = new List();
}
///
/// Sets the failure mechanism.
///
public virtual IFailureMechanism FailureMechanism
{
protected get
{
return failureMechanism;
}
set
{
failureMechanism = value;
failureMechanismObserver.Observable = failureMechanism;
if (failureMechanism != null)
{
UpdateDataGridViewDataSource();
}
}
}
public object Data
{
get
{
return failureMechanismSectionResults;
}
set
{
FailureMechanismSectionResult = value as IObservableEnumerable;
if (failureMechanismSectionResults != null)
{
UpdateDataGridViewDataSource();
}
else
{
DataGridViewControl.SetDataSource(null);
}
}
}
protected DataGridViewControl DataGridViewControl { get; private set; }
protected override void OnLoad(EventArgs e)
{
base.OnLoad(e);
AddDataGridColumns();
}
///
/// Creates a display object for which is added to the
/// on the .
///
/// The for which to create a
/// display object.
/// A display object which can be added as a row to the .
protected abstract object CreateFailureMechanismSectionResultRow(T sectionResult);
protected override void Dispose(bool disposing)
{
FailureMechanism = null;
FailureMechanismSectionResult = null;
failureMechanismObserver?.Dispose();
if (disposing)
{
components?.Dispose();
}
base.Dispose(disposing);
}
///
/// Finds out whether the assessment section which is represented by the row at index
/// has passed the level 1 assessment.
///
/// The index of the row which has a section attached.
/// false if assessment level 1 has passed, true otherwise.
protected bool HasPassedLevelOne(int rowIndex)
{
return (AssessmentLayerOneState) DataGridViewControl.GetCell(rowIndex, AssessmentLayerOneColumnIndex).Value
== AssessmentLayerOneState.Sufficient;
}
///
/// Updates the data source of the data grid view with the current known failure mechanism section results.
///
protected void UpdateDataGridViewDataSource()
{
UpdateFailureMechanismSectionResultsObservers();
DataGridViewControl.EndEdit();
DataGridViewControl.SetDataSource(
failureMechanismSectionResults
.Select(CreateFailureMechanismSectionResultRow)
.Where(sr => sr != null)
.ToList()
);
}
///
/// Gets data that is visualized on the row a the given .
///
/// The position of the row in the data source.
/// The data bound to the row at index .
protected object GetDataAtRow(int rowIndex)
{
return DataGridViewControl.GetRowFromIndex(rowIndex).DataBoundItem;
}
///
/// Adds the columns section name and the assessment layer one in the view.
///
protected virtual void AddDataGridColumns()
{
DataGridViewControl.AddTextBoxColumn(
nameof(FailureMechanismSectionResultRow.Name),
Resources.FailureMechanismResultView_InitializeDataGridView_Section_name,
true);
EnumDisplayWrapper[] oneStateDataSource =
Enum.GetValues(typeof(AssessmentLayerOneState))
.OfType()
.Select(el => new EnumDisplayWrapper(el))
.ToArray();
DataGridViewControl.AddComboBoxColumn(
nameof(FailureMechanismSectionResultRow.AssessmentLayerOne),
Resources.FailureMechanismResultView_InitializeDataGridView_Assessment_layer_one,
oneStateDataSource,
nameof(EnumDisplayWrapper.Value),
nameof(EnumDisplayWrapper.DisplayName));
}
private IObservableEnumerable FailureMechanismSectionResult
{
set
{
failureMechanismSectionResults = value;
UpdateFailureMechanismSectionResultsObservers();
}
}
private void UpdateFailureMechanismSectionResultsObservers()
{
ClearSectionResultObservers();
if (failureMechanismSectionResults != null)
{
AddSectionResultObservers();
}
}
private void AddSectionResultObservers()
{
foreach (T sectionResult in failureMechanismSectionResults)
{
failureMechanismSectionResultObservers.Add(new Observer(DataGridViewControl.RefreshDataGridView)
{
Observable = sectionResult
});
}
}
private void ClearSectionResultObservers()
{
foreach (Observer observer in failureMechanismSectionResultObservers)
{
observer.Dispose();
}
failureMechanismSectionResultObservers.Clear();
}
}
}