using System;
using DTS.Common.Utilities;

namespace DTS.Common.DAS.Concepts
{
    ///
    /// <summary>
    /// Representation of data and metadata associated with a TSR event.
    /// </summary>
    /// 
    public abstract class TsrEvent : Exceptional, ICloneable
    {
        /// <summary>
        /// The 1-based <see cref="UInt64"/> identifier for this event.
        /// </summary>
        public virtual UInt64 EventId { get; protected set; }

        /// <summary>
        /// The <see cref="System.DateTime"/> containing the date and time of this event.
        /// </summary>
        public virtual DateTime TimeStamp { get; protected set; }

        /// <summary>
        /// The <see cref="string"/> serial number of the hardware that captured this event.
        /// </summary>
        public virtual string SerialNumber { get; protected set; }

        /// <summary>
        /// The <see cref="string"/> alternate serial number of the hardware that captured the event.
        /// </summary>
        public virtual string AlternateSerialNumber { get; protected set; }

        /// <summary>
        /// The <see cref="double"/> duration in seconds of this event.
        /// </summary>
        public virtual double DurationSeconds { get; protected set; }

        /// <summary>
        /// The <see cref="double"/> maximum sample rate for this event.
        /// </summary>
        public virtual double MaxSampleRate { get; protected set; }   // note this is the "highest" sample rate

        /// <summary>
        /// The <see cref="float"/> temperature (in C).
        /// </summary>
        public virtual float TemperatureC { get; protected set; }

        /// <summary>
        /// The <see cref="double"/> number of pre-trigger seconds.
        /// </summary>
        public virtual double PreTriggerSeconds { get; protected set; }

        ///
        /// <summary>
        /// Generate a shallow copy of this object.
        /// </summary>
        /// <returns>A shallow copy of this <see cref="object"/>.</returns>
        /// 
        public abstract object Clone();
    }
}