Index: DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculator.cs =================================================================== diff -u -r1674 -r1697 --- DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculator.cs (.../OperationalCalculator.cs) (revision 1674) +++ DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculator.cs (.../OperationalCalculator.cs) (revision 1697) @@ -42,6 +42,9 @@ namespace Deltares.DamEngine.Calculators.DikesOperational { + /// + /// Class for the Operational Calculator + /// public class OperationalCalculator { /// @@ -166,6 +169,7 @@ task.CalculationMessages); Debug.WriteLine("End calculation Location '{0}', soilprofile '{1}'", task.Location, task.SoiProfileProbability); } + private void CalculateOneTimeEntry(Location location, SoilGeometryProbability soiProfileProbability, string projectPath, string calculationMap, DamFailureMechanismeCalculationSpecification damFailureMechanismeCalculationSpecification, @@ -296,7 +300,12 @@ } } - public static string DateToTimeStamp(DateTime dateTime) + /// + /// Dates to time stamp. + /// + /// The date time. + /// + public static string DateToTimeStamp(DateTime dateTime) { // Following 2 lines is an example how to handle customization of this format. // TNO at the last moment decided they did not need this change so we change it back to @@ -305,6 +314,7 @@ // return dateTime.ToString(customFormat); return dateTime.ToString("s", DateTimeFormatInfo.InvariantInfo); } + private string DetermineOutputParameter(DamFailureMechanismeCalculationSpecification currentSpecification) { string parameter = ""; @@ -488,6 +498,7 @@ if (!firstSeriesEntries.Contains(key)) throw new OperationalCalculatorException("Invalid data in time series entries. Time entries (date time values) don't match"); } + /// /// Determines whether any of sensor values contains a missing value. /// Index: DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculatorException.cs =================================================================== diff -u -r1674 -r1697 --- DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculatorException.cs (.../OperationalCalculatorException.cs) (revision 1674) +++ DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculatorException.cs (.../OperationalCalculatorException.cs) (revision 1697) @@ -23,8 +23,16 @@ namespace Deltares.DamEngine.Calculators.DikesOperational { + /// + /// Exception class for the Operational Calculator + /// + /// public class OperationalCalculatorException : Exception { + /// + /// Initializes a new instance of the class. + /// + /// The message that describes the error. public OperationalCalculatorException(string message) : base(message) { } Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Segment.cs =================================================================== diff -u -r1642 -r1697 --- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Segment.cs (.../Segment.cs) (revision 1642) +++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Segment.cs (.../Segment.cs) (revision 1697) @@ -89,6 +89,11 @@ } } + /// + /// Gets the most probable soil geometry probability. + /// + /// Type of the segment failure mechanism. + /// public SoilGeometryProbability GetMostProbableSoilGeometryProbability(FailureMechanismSystemType? segmentFailureMechanismType) { IEnumerable spps = from SoilGeometryProbability spp in this.soilGeometryProbabilities Index: DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculatorTask.cs =================================================================== diff -u -r1644 -r1697 --- DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculatorTask.cs (.../OperationalCalculatorTask.cs) (revision 1644) +++ DamEngine/trunk/src/Deltares.DamEngine.Calculators/DikesOperational/OperationalCalculatorTask.cs (.../OperationalCalculatorTask.cs) (revision 1697) @@ -27,16 +27,73 @@ namespace Deltares.DamEngine.Calculators.DikesOperational { + /// + /// Class for the Operational Calculator Task + /// public class OperationalCalculatorTask { + /// + /// Gets or sets the location. + /// + /// + /// The location. + /// public Location Location { get; set; } + + /// + /// Gets or sets the soi profile probability. + /// + /// + /// The soi profile probability. + /// public SoilGeometryProbability SoiProfileProbability { get; set; } + + /// + /// Gets or sets the project path. + /// + /// + /// The project path. + /// public string ProjectPath { get; set; } + + /// + /// Gets or sets the calculation map. + /// + /// + /// The calculation map. + /// public string CalculationMap { get; set; } + + /// + /// Gets or sets the failure mechanisme calculation specification. + /// + /// + /// The failure mechanisme calculation specification. + /// public DamFailureMechanismeCalculationSpecification FailureMechanismeCalculationSpecification { get; set; } + + /// + /// Gets or sets the time serie entry. + /// + /// + /// The time serie entry. + /// public TimeSerieEntry TimeSerieEntry { get; set; } + + /// + /// Gets or sets the index of the time step. + /// + /// + /// The index of the time step. + /// public int TimeStepIndex { get; set; } - public CalculationResult CalculationResult { get; set; } + + /// + /// Gets or sets the calculation messages. + /// + /// + /// The calculation messages. + /// public List CalculationMessages { get; set; } } }