// 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 Deltares.DamEngine.Data.General;
using Deltares.DamEngine.Data.Standard.Calculation;

namespace Deltares.DamEngine.Data.RegionalAssessmentResults
{
    /// <summary>
    /// Base class for regional results
    /// </summary>
    public class RegionalResult
    {
        private RegionalResultType regionalResultType = RegionalResultType.ProbabilityOfFailure;
        private double safetyFactor = -1;
        private double probabilityOfFailure = -1;
        private CalculationResult calculationResult = CalculationResult.NoRun;
        
        public const string ResultCategory = "Results";

        /// <summary>
        /// Gets or sets the type of the regional result.
        /// </summary>
        /// <value>
        /// The type of the regional result.
        /// </value>
        public virtual RegionalResultType RegionalResultType
        {
            get { return regionalResultType; }
            set { regionalResultType = value; }
        }

        /// <summary>
        /// Gets or sets the safety factor.
        /// </summary>
        /// <value>
        /// The safety factor.
        /// </value>
        public virtual double SafetyFactor
        {
            get { return safetyFactor; }
            set { safetyFactor = value; }
        }

        /// <summary>
        /// Gets or sets the probability of failure.
        /// </summary>
        /// <value>
        /// The probability of failure.
        /// </value>
        public virtual double ProbabilityOfFailure
        {
            get { return probabilityOfFailure; }
            set { probabilityOfFailure = value; }
        }

        /// <summary>
        /// Gets or sets the calculation result.
        /// </summary>
        /// <value>
        /// The calculation result.
        /// </value>
        public virtual CalculationResult CalculationResult
        {
            get { return calculationResult; }
            set { calculationResult = value; }
        }        
    }
}