// Copyright (C) Stichting Deltares 2018. 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.General;
using Deltares.DamEngine.Data.General.TimeSeries;
using Deltares.DamEngine.Data.Standard.Calculation;
using Deltares.DamEngine.Data.Standard.Logging;

namespace Deltares.DamEngine.Calculators.DikesOperational
{
    /// <summary>
    /// Class for the Operational Calculator Task
    /// </summary>
    public class OperationalCalculatorTask
    {
        /// <summary>
        /// Gets or sets the location.
        /// </summary>
        /// <value>
        /// The location.
        /// </value>
        public Location Location { get; set; }

        /// <summary>
        /// Gets or sets the soi profile probability.
        /// </summary>
        /// <value>
        /// The soi profile probability.
        /// </value>
        public SoilGeometryProbability SoiProfileProbability { get; set; }

        /// <summary>
        /// Gets or sets the project path.
        /// </summary>
        /// <value>
        /// The project path.
        /// </value>
        public string ProjectPath { get; set; }

        /// <summary>
        /// Gets or sets the calculation map.
        /// </summary>
        /// <value>
        /// The calculation map.
        /// </value>
        public string CalculationMap { get; set; }

        /// <summary>
        /// Gets or sets the failure mechanisme calculation specification.
        /// </summary>
        /// <value>
        /// The failure mechanisme calculation specification.
        /// </value>
        public DamFailureMechanismeCalculationSpecification FailureMechanismeCalculationSpecification { get; set; }

        /// <summary>
        /// Gets or sets the time serie entry.
        /// </summary>
        /// <value>
        /// The time serie entry.
        /// </value>
        public TimeSerieEntry TimeSerieEntry { get; set; }

        /// <summary>
        /// Gets or sets the index of the time step.
        /// </summary>
        /// <value>
        /// The index of the time step.
        /// </value>
        public int TimeStepIndex { get; set; }

        /// <summary>
        /// Gets or sets the calculation messages.
        /// </summary>
        /// <value>
        /// The calculation messages.
        /// </value>
        public List<LogMessage> CalculationMessages { get; set; }
    }
}