// 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 Core.Common.Base.Service;
using Ringtoets.Common.Data.Hydraulics;
using Ringtoets.Common.Service.MessageProviders;
using Ringtoets.HydraRing.Calculation.Activities;
namespace Ringtoets.Common.Service
{
///
/// for running a water height calculation.
///
public class WaveHeightCalculationActivity : HydraRingActivityBase
{
private readonly WaveHeightCalculation waveHeightCalculation;
private readonly double norm;
private readonly string hydraulicBoundaryDatabaseFilePath;
private readonly string preprocessorDirectory;
private readonly ICalculationMessageProvider messageProvider;
private readonly WaveHeightCalculationService calculationService;
///
/// Creates a new instance of .
///
/// The to perform the calculation for.
/// The hydraulic boundary database file that should be used for performing the calculation.
/// The preprocessor directory.
/// The norm to use during the calculation.
/// The provider of the messages to use during the calculation.
/// Preprocessing is disabled when equals .
/// Thrown when ,
/// , or
/// is null.
public WaveHeightCalculationActivity(WaveHeightCalculation waveHeightCalculation,
string hydraulicBoundaryDatabaseFilePath,
string preprocessorDirectory,
double norm,
ICalculationMessageProvider messageProvider)
{
if (waveHeightCalculation == null)
{
throw new ArgumentNullException(nameof(waveHeightCalculation));
}
if (messageProvider == null)
{
throw new ArgumentNullException(nameof(messageProvider));
}
this.waveHeightCalculation = waveHeightCalculation;
this.messageProvider = messageProvider;
this.hydraulicBoundaryDatabaseFilePath = hydraulicBoundaryDatabaseFilePath;
this.preprocessorDirectory = preprocessorDirectory;
this.norm = norm;
Description = messageProvider.GetActivityDescription(waveHeightCalculation.Name);
calculationService = new WaveHeightCalculationService();
}
protected override bool Validate()
{
if (AlreadyCalculated)
{
State = ActivityState.Skipped;
return true;
}
return WaveHeightCalculationService.Validate(hydraulicBoundaryDatabaseFilePath, preprocessorDirectory);
}
protected override void PerformCalculation()
{
if (State != ActivityState.Skipped)
{
calculationService.Calculate(
waveHeightCalculation,
hydraulicBoundaryDatabaseFilePath,
preprocessorDirectory,
norm,
messageProvider);
}
}
protected override void OnCancel()
{
calculationService.Cancel();
}
protected override void OnFinish()
{
waveHeightCalculation.ObservableObject.NotifyObservers();
}
private bool AlreadyCalculated
{
get
{
return waveHeightCalculation.IsCalculated();
}
}
}
}