Index: Ringtoets/Piping/src/Ringtoets.Piping.Service/PipingCalculationService.cs
===================================================================
diff -u -r65ea41e01d41d77df1e30bf8e850a44de46e870f -r89488cc05b12fd5720cd28a4eeeb001dc9b1456d
--- Ringtoets/Piping/src/Ringtoets.Piping.Service/PipingCalculationService.cs (.../PipingCalculationService.cs) (revision 65ea41e01d41d77df1e30bf8e850a44de46e870f)
+++ Ringtoets/Piping/src/Ringtoets.Piping.Service/PipingCalculationService.cs (.../PipingCalculationService.cs) (revision 89488cc05b12fd5720cd28a4eeeb001dc9b1456d)
@@ -37,14 +37,18 @@
public static class PipingCalculationService
{
private static readonly ILog pipingCalculationLogger = LogManager.GetLogger(typeof(PipingCalculation));
+
+ ///
+ /// The to use for creating piping sub calculators.
+ ///
public static IPipingSubCalculatorFactory SubCalculatorFactory = new PipingSubCalculatorFactory();
///
/// Performs validation over the values on the given . Error and status information is logged during
/// the execution of the operation.
///
/// The for which to validate the values.
- /// False if contains validation errors; True otherwise.
+ /// False if contains validation errors; True otherwise.
public static bool Validate(PipingCalculation calculation)
{
pipingCalculationLogger.Info(String.Format(Resources.Validation_Subject_0_started_Time_1_,
@@ -104,7 +108,7 @@
///
/// Calculates the thickness of the coverage layer based on the values of the .
///
- /// The thickness of the coverage layer, or -1 if the thickness could not be calculated.
+ /// The thickness of the coverage layer, or NaN if the thickness could not be calculated.
public static double CalculateThicknessCoverageLayer(PipingInput input)
{
try
@@ -147,6 +151,10 @@
);
}
+ ///
+ /// Calculates the piezometric head at the exit point based on the values of the .
+ ///
+ /// The piezometric head at the exit point.
public static double CalculatePiezometricHeadAtExit(PipingInput input)
{
return new PipingCalculator(CreateInputFromData(input), SubCalculatorFactory).CalculatePiezometricHeadAtExit();