// 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.Generic;
using System.Drawing;
using System.Globalization;
using System.Linq;
using System.Windows.Forms;
using Core.Common.Base;
using Core.Common.Base.Data;
using Core.Common.Controls.Views;
using Ringtoets.Common.Data.Calculation;
using Ringtoets.Common.Data.FailureMechanism;
using Ringtoets.Common.Forms.Properties;
using CoreCommonResources = Core.Common.Base.Properties.Resources;
namespace Ringtoets.Common.Forms.Views
{
///
/// The view for the .
///
public partial class FailureMechanismResultView : UserControl, IView
{
private const double tolerance = 1e-6;
private readonly Observer failureMechanismObserver;
private readonly RecursiveObserver, FailureMechanismSectionResult> failureMechanismSectionResultObserver;
private readonly RecursiveObserver calculationInputObserver;
private readonly RecursiveObserver calculationOutputObserver;
private readonly RecursiveObserver calculationGroupObserver;
private IEnumerable failureMechanismSectionResult;
private FailureMechanismBase failureMechanism;
private DataGridViewTextBoxColumn assessmentLayerTwoA;
private DataGridViewTextBoxColumn assessmentLayerTwoB;
private DataGridViewTextBoxColumn assessmentLayerThree;
///
/// Creates a new instance of .
///
public FailureMechanismResultView()
{
InitializeComponent();
InitializeDataGridView();
failureMechanismObserver = new Observer(UpdataDataGridViewDataSource);
failureMechanismSectionResultObserver = new RecursiveObserver, FailureMechanismSectionResult>(RefreshDataGridView, mechanism => mechanism.SectionResults);
// The concat is needed to observe the input of calculations in child groups.
calculationInputObserver = new RecursiveObserver(UpdataDataGridViewDataSource, cg => cg.Children.Concat(cg.Children.OfType().Select(c => c.GetObservableInput())));
calculationOutputObserver = new RecursiveObserver(UpdataDataGridViewDataSource, cg => cg.Children.Concat(cg.Children.OfType().Select(c => c.GetObservableOutput())));
calculationGroupObserver = new RecursiveObserver(UpdataDataGridViewDataSource, c => c.Children);
Load += OnLoad;
}
///
/// Gets or sets the failure mechanism.
///
public IFailureMechanism FailureMechanism
{
get
{
return failureMechanism;
}
set
{
failureMechanism = value as FailureMechanismBase;
failureMechanismObserver.Observable = failureMechanism;
failureMechanismSectionResultObserver.Observable = failureMechanism;
var calculatableFailureMechanism = failureMechanism as ICalculatableFailureMechanism;
CalculationGroup observableGroup = calculatableFailureMechanism != null ? calculatableFailureMechanism.CalculationsGroup : null;
calculationInputObserver.Observable = observableGroup;
calculationOutputObserver.Observable = observableGroup;
calculationGroupObserver.Observable = observableGroup;
}
}
public object Data
{
get
{
return failureMechanismSectionResult;
}
set
{
failureMechanismSectionResult = value as IEnumerable;
if (failureMechanismSectionResult != null)
{
UpdataDataGridViewDataSource();
}
else
{
dataGridView.DataSource = null;
}
}
}
protected override void Dispose(bool disposing)
{
FailureMechanism = null;
failureMechanismObserver.Dispose();
failureMechanismSectionResultObserver.Dispose();
calculationInputObserver.Dispose();
calculationOutputObserver.Dispose();
calculationGroupObserver.Dispose();
if (disposing && (components != null))
{
components.Dispose();
}
base.Dispose(disposing);
}
private void OnLoad(object sender, EventArgs e)
{
if (failureMechanismSectionResult != null && failureMechanismSectionResult.Any())
{
SetRowStyling();
}
}
private void InitializeDataGridView()
{
dataGridView.CurrentCellDirtyStateChanged += DataGridViewCurrentCellDirtyStateChanged;
dataGridView.CellValidating += DataGridViewCellValidating;
dataGridView.DataError += DataGridViewDataError;
dataGridView.CellFormatting += DataGridViewCellFormatting;
dataGridView.GotFocus += DataGridViewGotFocus;
var sectionName = new DataGridViewTextBoxColumn
{
DataPropertyName = "Name",
HeaderText = Resources.FailureMechanismResultView_InitializeDataGridView_Section_name,
Name = "column_Name"
};
var assessmentLayerOne = new DataGridViewCheckBoxColumn
{
DataPropertyName = "AssessmentLayerOne",
HeaderText = Resources.FailureMechanismResultView_InitializeDataGridView_Assessment_layer_one,
Name = "column_AssessmentLayerOne"
};
assessmentLayerTwoA = new DataGridViewTextBoxColumn
{
DataPropertyName = "AssessmentLayerTwoA",
HeaderText = Resources.FailureMechanismResultView_InitializeDataGridView_Assessment_layer_two_a,
Name = "column_AssessmentLayerTwoA",
ReadOnly = true
};
assessmentLayerTwoB = new DataGridViewTextBoxColumn
{
DataPropertyName = "AssessmentLayerTwoB",
HeaderText = Resources.FailureMechanismResultView_InitializeDataGridView_Assessment_layer_two_b,
Name = "column_AssessmentLayerTwoB"
};
assessmentLayerThree = new DataGridViewTextBoxColumn
{
DataPropertyName = "AssessmentLayerThree",
HeaderText = Resources.FailureMechanismResultView_InitializeDataGridView_Assessment_layer_three,
Name = "column_AssessmentLayerThree"
};
dataGridView.AutoGenerateColumns = false;
dataGridView.Columns.AddRange(sectionName, assessmentLayerOne, assessmentLayerTwoA, assessmentLayerTwoB, assessmentLayerThree);
foreach (var column in dataGridView.Columns.OfType())
{
column.AutoSizeMode = DataGridViewAutoSizeColumnMode.AllCells;
column.HeaderCell.Style.Alignment = DataGridViewContentAlignment.MiddleCenter;
}
}
private void UpdataDataGridViewDataSource()
{
dataGridView.DataSource = failureMechanismSectionResult.Select(sr => new FailureMechanismSectionResultRow(sr)).ToList();
SetRowStyling();
}
private void RefreshDataGridView()
{
dataGridView.Refresh();
dataGridView.AutoResizeColumns();
SetRowStyling();
}
private void SetRowStyling()
{
foreach (DataGridViewRow row in dataGridView.Rows)
{
var checkboxSelected = (bool) row.Cells[1].Value;
SetRowEditMode(row, checkboxSelected);
SetRowStyle(checkboxSelected, row);
}
}
private void SetRowEditMode(DataGridViewRow row, bool checkboxSelected)
{
row.Cells[assessmentLayerTwoB.Index].ReadOnly = checkboxSelected;
row.Cells[assessmentLayerThree.Index].ReadOnly = checkboxSelected;
}
private void SetRowStyle(bool checkboxSelected, DataGridViewRow row)
{
if (checkboxSelected)
{
SetCellStyle(row.Cells[assessmentLayerTwoA.Index], Color.FromKnownColor(KnownColor.DarkGray), Color.FromKnownColor(KnownColor.GrayText));
SetCellStyle(row.Cells[assessmentLayerTwoB.Index], Color.FromKnownColor(KnownColor.DarkGray), Color.FromKnownColor(KnownColor.GrayText));
SetCellStyle(row.Cells[assessmentLayerThree.Index], Color.FromKnownColor(KnownColor.DarkGray), Color.FromKnownColor(KnownColor.GrayText));
}
else
{
SetCellStyle(row.Cells[assessmentLayerTwoA.Index], Color.FromKnownColor(KnownColor.White), Color.FromKnownColor(KnownColor.ControlText));
SetCellStyle(row.Cells[assessmentLayerTwoB.Index], Color.FromKnownColor(KnownColor.White), Color.FromKnownColor(KnownColor.ControlText));
SetCellStyle(row.Cells[assessmentLayerThree.Index], Color.FromKnownColor(KnownColor.White), Color.FromKnownColor(KnownColor.ControlText));
}
}
private void SetCellStyle(DataGridViewCell cell, Color backgroundColor, Color textColor)
{
cell.Style.BackColor = backgroundColor;
cell.Style.ForeColor = textColor;
}
private void DataGridViewGotFocus(object sender, EventArgs eventArgs)
{
if (dataGridView.CurrentCell != null)
{
dataGridView.BeginEdit(true); // Always start editing after setting the focus (otherwise data grid view cell dirty events are no longer fired when using the keyboard...)
}
}
#region Nested types
private class FailureMechanismSectionResultRow
{
public FailureMechanismSectionResultRow(FailureMechanismSectionResult failureMechanismSectionResult)
{
FailureMechanismSectionResult = failureMechanismSectionResult;
}
public string Name
{
get
{
return FailureMechanismSectionResult.Section.Name;
}
}
public bool AssessmentLayerOne
{
get
{
return FailureMechanismSectionResult.AssessmentLayerOne;
}
set
{
FailureMechanismSectionResult.AssessmentLayerOne = value;
FailureMechanismSectionResult.NotifyObservers();
}
}
public string AssessmentLayerTwoA
{
get
{
var relevantScenarios = FailureMechanismSectionResult.CalculationScenarios.Where(cs => cs.IsRelevant).ToArray();
bool relevantScenarioAvailable = relevantScenarios.Length != 0;
if (relevantScenarioAvailable && Math.Abs(FailureMechanismSectionResult.TotalContribution - 1.0) > tolerance)
{
return double.NaN.ToString(CultureInfo.CurrentCulture);
}
if (!relevantScenarioAvailable
|| FailureMechanismSectionResult.CalculationScenarioStatus != CalculationScenarioStatus.Done)
{
return Resources.FailureMechanismSectionResultRow_AssessmentLayerTwoA_No_result_dash;
}
var layerTwoA = FailureMechanismSectionResult.AssessmentLayerTwoA;
return string.Format(CoreCommonResources.ProbabilityPerYearFormat, layerTwoA.Value);
}
}
public RoundedDouble AssessmentLayerTwoB
{
get
{
return FailureMechanismSectionResult.AssessmentLayerTwoB;
}
set
{
FailureMechanismSectionResult.AssessmentLayerTwoB = value;
}
}
public RoundedDouble AssessmentLayerThree
{
get
{
return FailureMechanismSectionResult.AssessmentLayerThree;
}
set
{
FailureMechanismSectionResult.AssessmentLayerThree = value;
}
}
public FailureMechanismSectionResult FailureMechanismSectionResult { get; private set; }
}
#endregion
#region Event handling
private void DataGridViewCurrentCellDirtyStateChanged(object sender, EventArgs e)
{
// Ensure checkbox values are directly committed
DataGridViewColumn currentColumn = dataGridView.Columns[dataGridView.CurrentCell.ColumnIndex];
if (currentColumn is DataGridViewCheckBoxColumn)
{
dataGridView.CommitEdit(DataGridViewDataErrorContexts.Commit);
}
}
private void DataGridViewCellValidating(object sender, DataGridViewCellValidatingEventArgs e)
{
dataGridView.Rows[e.RowIndex].ErrorText = String.Empty;
var cellEditValue = e.FormattedValue.ToString();
if (string.IsNullOrWhiteSpace(cellEditValue))
{
dataGridView.Rows[e.RowIndex].ErrorText = Resources.DataGridViewCellValidating_Text_may_not_be_empty;
}
}
private void DataGridViewDataError(object sender, DataGridViewDataErrorEventArgs e)
{
e.ThrowException = false;
e.Cancel = true;
if (string.IsNullOrWhiteSpace(dataGridView.Rows[e.RowIndex].ErrorText) && e.Exception != null)
{
dataGridView.Rows[e.RowIndex].ErrorText = e.Exception.Message;
}
}
private void DataGridViewCellFormatting(object sender, DataGridViewCellFormattingEventArgs e)
{
var currentDataGridViewRow = dataGridView.Rows[e.RowIndex];
var currentDataGridViewCell = currentDataGridViewRow.Cells[e.ColumnIndex];
FailureMechanismSectionResultRow resultRow = (FailureMechanismSectionResultRow) currentDataGridViewRow.DataBoundItem;
if (resultRow != null && e.ColumnIndex == assessmentLayerTwoA.Index)
{
FailureMechanismSectionResult rowObject = resultRow.FailureMechanismSectionResult;
var relevantScenarios = rowObject.CalculationScenarios.Where(cs => cs.IsRelevant).ToArray();
bool relevantScenarioAvailable = relevantScenarios.Length != 0;
if (rowObject.AssessmentLayerOne || !relevantScenarioAvailable)
{
currentDataGridViewCell.ErrorText = string.Empty;
return;
}
if (Math.Abs(rowObject.TotalContribution - 1.0) > tolerance)
{
currentDataGridViewCell.ErrorText = Resources.FailureMechanismResultView_DataGridViewCellFormatting_Scenario_contribution_for_this_section_not_100;
return;
}
var calculationScenarioStatus = rowObject.CalculationScenarioStatus;
if (calculationScenarioStatus == CalculationScenarioStatus.NotCalculated)
{
currentDataGridViewCell.ErrorText = Resources.FailureMechanismResultView_DataGridViewCellFormatting_Not_all_calculations_are_executed;
return;
}
if (calculationScenarioStatus == CalculationScenarioStatus.Failed)
{
currentDataGridViewCell.ErrorText = Resources.FailureMechanismResultView_DataGridViewCellFormatting_Not_all_calculations_have_valid_output;
return;
}
currentDataGridViewCell.ErrorText = string.Empty;
}
}
#endregion
}
}