// Copyright (C) Stichting Deltares 2024. All rights reserved.
// 
// This file is part of the Dam Engine.
// 
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
// 
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
// 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.Collections.Generic;
using Deltares.DamEngine.Data.Geometry;
using Deltares.DamEngine.Data.Geotechnics;

namespace Deltares.DamEngine.Data.General.Results;

/// <summary>
/// Class holding the results for the Stability design calculation
/// </summary>
public class StabilityDesignResults
{
    /// <summary>
    /// Gets or sets the number of iterations.
    /// </summary>
    /// <value>
    /// The number of iterations.
    /// </value>
    public int? NumberOfIterations { get; set; }

    /// <summary>
    /// Gets or sets the result message.
    /// </summary>
    /// <value>
    /// The result message.
    /// </value>
    public string ResultMessage { get; set; } = "";

    /// <summary>
    /// Gets or sets the stability safety factor.
    /// </summary>
    /// <value>
    /// The stability safety factor.
    /// </value>
    public double? SafetyFactor { get; set; }

    /// <summary>
    /// Gets or sets the local entry point x.
    /// </summary>
    /// <value>
    /// The local entry point x.
    /// </value>
    public double? LocalEntryPointX { get; set; }

    /// <summary>
    /// Gets or sets the local exit point x.
    /// </summary>
    /// <value>
    /// The local exit point x.
    /// </value>
    public double? LocalExitPointX { get; set; }

    /// <summary>
    /// Gets or sets the uplift situation.
    /// </summary>
    /// <value>
    /// The uplift situation.
    /// </value>
    public UpliftSituation? UpliftSituation { get; set; }

    /// <summary>
    /// Gets or sets the redesigned surface line stability.
    /// </summary>
    /// <value>
    /// The redesigned surface line stability.
    /// </value>
    public SurfaceLine2 RedesignedSurfaceLine { get; set; }

    /// <summary>
    /// Gets or sets the type of the stability model.
    /// </summary>
    /// <value>
    /// The type of the stability model.
    /// </value>
    public StabilityModelType? StabilityModelType { get; set; }

    /// <summary>
    /// Gets or sets the location (X,Z) of the center point of the active slip circle.
    /// </summary>
    /// <value>
    /// The location (X,Z) of the center point of the active slip circle.
    /// </value>
    public Point2D ActiveCenterPoint { get; set; }

    /// <summary>
    /// Gets or sets the radius of the active slip circle.
    /// </summary>
    /// <value>
    /// The radius of the active slip circle.
    /// </value>
    public double ActiveCenterPointRadius { get; set; }

    /// <summary>
    /// Gets or sets the location (X,Z) of the center point of the passive slip circle.
    /// </summary>
    /// <value>
    /// The location (X,Z) of the center point of the passive slip circle.
    /// </value>
    public Point2D PassiveCenterPoint { get; set; }

    /// <summary>
    /// Gets or sets the radius of the passive slip circle.
    /// </summary>
    /// <value>
    /// The radius of the passive slip circle.
    /// </value>
    public double PassiveCenterPointRadius { get; set; }

    /// <summary>
    /// Gets or sets the result slices.
    /// </summary>
    /// <value>
    /// The result slices.
    /// </value>
    public List<StabilityResultSlice> ResultSlices { get; set; }
}