// 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;
using System.Collections.Generic;
using Core.Common.Base;
using Ringtoets.Common.Data.Calculation;

namespace Ringtoets.Common.Data.FailureMechanism
{
    /// <summary>
    /// Defines a failure mechanism.
    /// </summary>
    public interface IFailureMechanism : ICommentable, IObservable
    {
        /// <summary>
        /// Gets or sets the amount of contribution as a percentage [0, 100] for the <see cref="IFailureMechanism"/>
        /// as part of the overall verdict.
        /// </summary>
        /// <exception cref="ArgumentException">Thrown when the <paramref name="value"/> is not in the interval [0, 100].</exception>
        double Contribution { get; set; }

        /// <summary>
        /// Gets the name of the <see cref="IFailureMechanism"/>.
        /// </summary>
        string Name { get; }

        /// <summary>
        /// Gets the code of the <see cref="IFailureMechanism"/>.
        /// </summary>
        string Code { get; }

        /// <summary>
        /// Gets the comments associated with the input of the data object.
        /// </summary>
        Commentable InputComments { get; }
        
        /// <summary>
        /// Gets the comments associated with the output of the data object.
        /// </summary>
        Commentable OutputComments { get; }

        /// <summary>
        /// Gets the comments associated when the failure mechanism is set to be not relevant.
        /// </summary>
        Commentable NotRelevantComments { get; }

        /// <summary>
        /// Gets or sets a value indicating whether this failure mechanism is relevant.
        /// </summary>
        bool IsRelevant { get; set; }

        /// <summary>
        /// Gets an <see cref="IEnumerable{T}"/> of all the <see cref="ICalculation"/> instances added to
        /// the failure mechanism.
        /// </summary>
        IEnumerable<ICalculation> Calculations { get; }

        /// <summary>
        /// Gets the sections that define areas for which a calculation could determine
        /// a representative result. Cannot return <c>null</c>.
        /// </summary>
        IEnumerable<FailureMechanismSection> Sections { get; }

        /// <summary>
        /// Adds a <see cref="FailureMechanismSection"/> to <see cref="Sections"/>.
        /// </summary>
        /// <param name="section">The new section.</param>
        /// <exception cref="ArgumentException">Thrown when <paramref name="section"/> cannot
        /// be connected to elements already defined in <see cref="Sections"/>.</exception>
        void AddSection(FailureMechanismSection section);

        /// <summary>
        /// Clears all sections from <see cref="Sections"/>.
        /// </summary>
        void ClearAllSections();
    }
}