// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU 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 General Public License for more details.
//
// You should have received a copy of the GNU 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;

namespace Ringtoets.Piping.Data
{
    /// <summary>
    /// This class holds the information for a calculation scenario.
    /// </summary>
    public class PipingCalculationScenario : PipingCalculation
    {
        /// <summary>
        /// Creates a new instance of <see cref="PipingCalculationScenario"/> with default values set for some of the parameters.
        /// </summary>
        /// <param name="generalInputParameters">General piping calculation parameters that
        /// are the same across all piping calculations.</param>
        /// <param name="semiProbabilisticInputParameters">General semi-probabilistic parameters that 
        /// are used in a semi-probabilistic piping assessment.</param>
        /// <exception cref="ArgumentNullException">When <paramref name="generalInputParameters"/> or 
        /// <paramref name="semiProbabilisticInputParameters"/> is <c>null</c>.</exception>
        public PipingCalculationScenario(GeneralPipingInput generalInputParameters, SemiProbabilisticPipingInput semiProbabilisticInputParameters)
            : base(generalInputParameters, semiProbabilisticInputParameters)
        {
            IsRelevant = true;
        }

        /// <summary>
        /// Gets  or sets whether this scenario is relevant or not.
        /// </summary>
        public bool IsRelevant { get; set; }

        /// <summary>
        /// Gets the contribution of the scenario.
        /// </summary>
        public double Contribution { get; set; }
    }
}