// 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 Deltares.DamEngine.Data.General.Results;
using Deltares.DamEngine.Data.General.TimeSeries;
using Deltares.DamEngine.Data.Standard.Validation;

namespace Deltares.DamEngine.Data.General
{
    /// <summary>
    /// Class holding LocationJob data
    /// </summary>
    /// <seealso cref="Deltares.DamEngine.Data.General.DamJob" />
    public class LocationJob : DamJob
    {
        private TimeSerie waterLevelTimeSerie = new TimeSerie();
        private LocationResult locationResult = new LocationResult();
        private static DamProjectType damProjectType = DamProjectType.Operational;

        /// <summary>
        /// Initializes a new instance of the <see cref="LocationJob"/> class.
        /// </summary>
        /// <param name="subject">The subject.</param>
        public LocationJob(object subject)
            : base(subject)
        {
        }

        /// <summary>
        /// Gets or sets the location.
        /// </summary>
        /// <value>
        /// The location.
        /// </value>
        [Validate]
        public Location Location
        {
            get
            {
                return Subject as Location;
            }
            set
            {
                Subject = value;
            }
        }

        /// <summary>
        /// Gets or sets the location result.
        /// </summary>
        /// <value>
        /// The location result.
        /// </value>
        public virtual LocationResult LocationResult
        {
            get { return locationResult; }
            set
            {
                locationResult = value;                
            }
        }

        /// <summary>
        /// Gets or sets the type of the dam project.
        /// </summary>
        /// <value>
        /// The type of the dam project.
        /// </value>
        public static DamProjectType DamProjectType
        {
            get { return damProjectType; }
            set { damProjectType = value; }
        }

        /// <summary>
        /// Returns a <see cref="System.String" /> that represents this instance.
        /// </summary>
        /// <returns>
        /// A <see cref="System.String" /> that represents this instance.
        /// </returns>
        public override string ToString()
        {
            return Location != null ? Location.ToString() : "";
        }        
    }
}