// 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.Collections.Generic;
using Ringtoets.HydraRing.Data;

namespace Ringtoets.Integration.Forms.Commands
{
    /// <summary>
    /// Interface for <see cref="HydraulicBoundaryLocation.DesignWaterLevel"/> and 
    /// <see cref="HydraulicBoundaryLocation.WaveHeight"/> calculations.
    /// </summary>
    public interface IHydraulicBoundaryLocationCalculationCommandHandler
    {
        /// <summary>
        /// Performs the <see cref="HydraulicBoundaryLocation.DesignWaterLevel"/> calculation for all <paramref name="locations"/>.
        /// </summary>
        /// <param name="locations">The <see cref="HydraulicBoundaryLocation"/> objects to calculate 
        /// the <see cref="HydraulicBoundaryLocation.DesignWaterLevel"/> for.</param>
        void CalculateDesignWaterLevels(IEnumerable<HydraulicBoundaryLocation> locations);

        /// <summary>
        /// Performs the <see cref="HydraulicBoundaryLocation.WaveHeight"/> calculation for all <paramref name="locations"/>.
        /// </summary>
        /// <param name="locations">The <see cref="HydraulicBoundaryLocation"/> objects to calculate 
        /// the <see cref="HydraulicBoundaryLocation.WaveHeight"/> for.</param>
        void CalculateWaveHeights(IEnumerable<HydraulicBoundaryLocation> locations);
    }
}