// Copyright (C) Stichting Deltares 2017. 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.

namespace Deltares.DamEngine.Data.General.Results
{
    /// <summary>
    /// Class holding the results for the Nwo (design) calculation
    /// </summary>
    public class NwoDesignResults
    {
        private string nwoId;
        private int resultIndex;
        private double? locationXrdStart;
        private double? locationYrdStart;
        private double? locationZrdStart;
        private double? locationXrdEnd;
        private double? locationYrdEnd;
        private double? locationZrdEnd;
        private int numberOfIterations;
        private double? safetyFactor;
        private double? zone1SafetyFactor;
        private double? localZone1EntryPointX;
        private double? localZone1ExitPointX;
        private double? zone2SafetyFactor;
        private double? localZone2EntryPointX;
        private double? localZone2ExitPointX;


        /// <summary>
        /// Gets or sets the nwo identifier.
        /// </summary>
        /// <value>
        /// The nwo identifier.
        /// </value>
        public string NwoId
        {
            get
            {
                return nwoId;
            }
            set
            {
                nwoId = value;
            }
        }

        /// <summary>
        /// Gets or sets the index of the result.
        /// </summary>
        /// <value>
        /// The index of the result.
        /// </value>
        public int ResultIndex
        {
            get
            {
                return resultIndex;
            }
            set
            {
                resultIndex = value;
            }
        }

        /// <summary>
        /// Gets or sets the location XRD start.
        /// </summary>
        /// <value>
        /// The location XRD start.
        /// </value>
        public double? LocationXrdStart
        {
            get
            {
                return locationXrdStart;
            }
            set
            {
                locationXrdStart = value;
            }
        }

        /// <summary>
        /// Gets or sets the location yrd start.
        /// </summary>
        /// <value>
        /// The location yrd start.
        /// </value>
        public double? LocationYrdStart
        {
            get
            {
                return locationYrdStart;
            }
            set
            {
                locationYrdStart = value;
            }
        }

        /// <summary>
        /// Gets or sets the location ZRD start.
        /// </summary>
        /// <value>
        /// The location ZRD start.
        /// </value>
        public double? LocationZrdStart
        {
            get
            {
                return locationZrdStart;
            }
            set
            {
                locationZrdStart = value;
            }
        }

        /// <summary>
        /// Gets or sets the location XRD end.
        /// </summary>
        /// <value>
        /// The location XRD end.
        /// </value>
        public double? LocationXrdEnd
        {
            get
            {
                return locationXrdEnd;
            }
            set
            {
                locationXrdEnd = value;
            }
        }

        /// <summary>
        /// Gets or sets the location yrd end.
        /// </summary>
        /// <value>
        /// The location yrd end.
        /// </value>
        public double? LocationYrdEnd
        {
            get
            {
                return locationYrdEnd;
            }
            set
            {
                locationYrdEnd = value;
            }
        }

        /// <summary>
        /// Gets or sets the location ZRD end.
        /// </summary>
        /// <value>
        /// The location ZRD end.
        /// </value>
        public double? LocationZrdEnd
        {
            get
            {
                return locationZrdEnd;
            }
            set
            {
                locationZrdEnd = value;
            }
        }

        /// <summary>
        /// Gets or sets the number of iterations.
        /// </summary>
        /// <value>
        /// The number of iterations.
        /// </value>
        public int NumberOfIterations
        {
            get
            {
                return numberOfIterations;
            }
            set
            {
                numberOfIterations = value;
            }
        }

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

        /// <summary>
        /// Gets or sets the zone1 safety factor stability.
        /// </summary>
        /// <value>
        /// The zone1 safety factor stability.
        /// </value>
        public double? Zone1SafetyFactor
        {
            get
            {
                return zone1SafetyFactor;
            }
            set
            {
                zone1SafetyFactor = value;
            }
        }

        /// <summary>
        /// Gets or sets the local zone1 entry point x.
        /// </summary>
        /// <value>
        /// The local zone1 entry point x.
        /// </value>
        public double? LocalZone1EntryPointX
        {
            get
            {
                return localZone1EntryPointX;
            }
            set
            {
                localZone1EntryPointX = value;
            }
        }

        /// <summary>
        /// Gets or sets the local zone1 exit point x.
        /// </summary>
        /// <value>
        /// The local zone1 exit point x.
        /// </value>
        public double? LocalZone1ExitPointX
        {
            get
            {
                return localZone1ExitPointX;
            }
            set
            {
                localZone1ExitPointX = value;
            }
        }

        /// <summary>
        /// Gets or sets the zone2 safety factor stability.
        /// </summary>
        /// <value>
        /// The zone2 safety factor stability.
        /// </value>
        public double? Zone2SafetyFactor
        {
            get
            {
                return zone2SafetyFactor;
            }
            set
            {
                zone2SafetyFactor = value;
            }
        }

        /// <summary>
        /// Gets or sets the local zone2 entry point x.
        /// </summary>
        /// <value>
        /// The local zone2 entry point x.
        /// </value>
        public double? LocalZone2EntryPointX
        {
            get
            {
                return localZone2EntryPointX;
            }
            set
            {
                localZone2EntryPointX = value;
            }
        }

        /// <summary>
        /// Gets or sets the local zone2 exit point x.
        /// </summary>
        /// <value>
        /// The local zone2 exit point x.
        /// </value>
        public double? LocalZone2ExitPointX
        {
            get
            {
                return localZone2ExitPointX;
            }
            set
            {
                localZone2ExitPointX = value;
            }
        }
    }
}