// 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.Standard.Calculation;

namespace Deltares.DamEngine.Data.RegionalAssessmentResults
{
    /// <summary>
    /// Class for results of all relevant regional scenarios
    /// </summary>
    public class RegionalScenariosResult
    {
        private IList<RegionalScenarioResult> regionalScenarioResults = new List<RegionalScenarioResult>();
        private CalculationResult calculationResult = CalculationResult.NoRun;

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

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

        /// <summary>
        /// Gets the regional scenario results.
        /// </summary>
        /// <value>
        /// The regional scenario results.
        /// </value>
        public IList<RegionalScenarioResult> RegionalScenarioResults
        {
            get { return regionalScenarioResults; }
            set { regionalScenarioResults = value; }
        }

        /// <summary>
        /// Gets the scenario result.
        /// </summary>
        /// <param name="scenarioType">Type of the scenario.</param>
        /// <returns></returns>
        public RegionalScenarioResult GetScenarioResult(ScenarioType scenarioType)
        {
            foreach (var scenarioResult in RegionalScenarioResults)
            {
                if (scenarioResult.ScenarioType == scenarioType)
                {
                    return scenarioResult;
                }
            }

            return null;
        }
    }  
}