//-----------------------------------------------------------------------
// <copyright file="FieldIdentification.cs" company="Deltares">
//  Copyright (c) 2009 Deltares. All rights reserved.
// </copyright>
// <author>B. Faassen</author>
// <email>barry.faassen@deltares.nl</email>
// <date>9-2-2009</date>
// <summary>
//  Contains a domain class that can be used to add file info meta data 
//  to a data transfer object
// </summary>
//-----------------------------------------------------------------------

using System;
using System.Reflection;

namespace Deltares.Standard
{
    /// <summary>
    /// This class contains general properties which can be used in the header of an xml file or in
    /// data transfer objects like <see cref="Deltares.CptInterpretation.CptDialogDocument"/> or <see cref="Deltares.GroundwaterFlow.WellCalcDoc"/>
    /// </summary>
    public class FileIdentification
    {
        public FileIdentification()
            : this(Assembly.GetCallingAssembly())
        {
        }

        public FileIdentification(Assembly assembly)
        {
            this.Application = assembly.GetName().Name;
            this.Version = assembly.GetName().Version.ToString();
            this.Company = "Deltares";
            this.Created = DateTime.UtcNow;
        }

        /// <summary>
        /// The name of the applcation where the xml data is coming from
        /// </summary>
        public string Application { get; set; }

        /// <summary>
        /// The version of the application or dll where this data is form
        /// </summary>
        public string Version { get; set; }

        /// <summary>
        /// The name of the company 
        /// </summary>
        public string Company { get; set; }

        /// <summary>
        /// The license of the application
        /// </summary>
        /// <remarks>This property is not required</remarks>
        public string License { get; set; }

        /// <summary>
        /// A general description of the application where the data belongs to
        /// </summary>
        /// <remarks>This property is not required</remarks>
        public string Description { get; set; }

        /// <summary>
        /// Date time stamp of the creation of the data data items
        /// </summary>
        public DateTime Created { get; set; }
    }
}