// *******************************************************************************************
// **                                                                                       **
// **      InvalidMeasurementRequestException.cs
// **      4/14/2023
// **                                                                                       **
// **      RAYTHEON PROPRIETARY: THIS DOCUMENT CONTAINS DATA OR INFORMATION                 **
// **      PROPRIETARY TO RAYTHEON COMPANY AND IS RESTRICTED TO USE ONLY BY PERSONS         **
// **      AUTHORIZED BY RAYTHEON COMPANY IN WRITING TO USE IT.DISCLOSURE TO                **
// **      UNAUTHORIZED PERSONS WOULD LIKELY CAUSE SUBSTANTIAL COMPETITIVE HARM TO          **
// **      RAYTHEON COMPANY'S BUSINESS POSITION. NEITHER SAID DOCUMENT NOR ITS              **
// **      CONTENTS SHALL BE FURNISHED OR DISCLOSED TO OR COPIED OR USED BY PERSONS         **
// **      OUTSIDE RAYTHEON COMPANY WITHOUT THE EXPRESS WRITTEN APPROVAL OF RAYTHEON        **
// **      COMPANY.                                                                         **
// **                                                                                       **
// **      THIS PROPRIETARY NOTICE IS NOT APPLICABLE IF DELIVERED TO THE U.S.               **
// **      GOVERNMENT.                                                                      **
// **                                                                                       **
// **      UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY 2023.
// **                                                                                       **
// **      WARNING: THIS DOCUMENT CONTAINS TECHNICAL DATA AND / OR TECHNOLOGY WHOSE         **
// **      EXPORT OR DISCLOSURE TO NON-U.S.PERSONS, WHEREVER LOCATED, IS RESTRICTED         **
// **      BY THE INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) (22 C.F.R.SECTION        **
// **      120-130) OR THE EXPORT ADMINISTRATION REGULATIONS(EAR) (15 C.F.R.SECTION         **
// **      730-774). THIS DOCUMENT CANNOT BE EXPORTED(E.G., PROVIDED TO A SUPPLIER          **
// **      OUTSIDE OF THE UNITED STATES) OR DISCLOSED TO A NON-U.S.PERSON, WHEREVER         **
// **      LOCATED, UNTIL A FINAL JURISDICTION AND CLASSIFICATION DETERMINATION HAS         **
// **      BEEN COMPLETED AND APPROVED BY RAYTHEON, AND ANY REQUIRED U.S.GOVERNMENT         **
// **      APPROVALS HAVE BEEN OBTAINED. VIOLATIONS ARE SUBJECT TO SEVERE CRIMINAL          **
// **      PENALTIES.                                                                       **
// **                                                                                       **
// **      CAPITAL EQUIPMENT/SOFTWARE: THIS TECHNICAL DATA WAS DEVELOPED OR ACQUIRED        **
// **      EXCLUSIVELY AT CONTRACTOR EXPENSE AND IS INTENDED FOR USE ON MULTIPLE            **
// **      PROJECTS/PROGRAMS.                                                               **
// **                                                                                       **
// *******************************************************************************************

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Runtime.Serialization;
using Raytheon.Instruments.Dmm;
using System.Diagnostics.CodeAnalysis;

namespace Raytheon.Instruments
{
    /// <summary>
    /// InvalidMeasurementRequestException - exception thrown when client attempts to take the not currently 
    ///                                      configured measurement
    /// </summary>
    [DataContract]
    [SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors")]
    public class InvalidMeasurementRequestException : InstrumentException
    {
        #region Public Exception Properties
        
        /// <summary>
        /// Gets the attempted measurement.
        /// </summary>
        /// <value>
        /// The attempted measurement type
        /// </value>
        [DataMember]
        public MeasurementFunction AttemptedMeasurementType { get; private set; }

        #endregion

        #region Constructors

        /// <summary>
        /// Initializes a new instance of the <see cref="InvalidMeasurementRequestException"/> class.
        /// with a NONE measurement type
        /// </summary>
        public InvalidMeasurementRequestException()
            : base()
        {
            AttemptedMeasurementType = MeasurementFunction.None;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="InvalidMeasurementRequestException"/> class.
        /// </summary>
        /// <param name="measurementFunction">The measurement function.</param>
        public InvalidMeasurementRequestException(MeasurementFunction measurementFunction)
            : base()
        {
            AttemptedMeasurementType = measurementFunction;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="InvalidMeasurementRequestException"/> class.
        /// </summary>
        /// <param name="measurementFunction">The measurement function.</param>
        /// <param name="message">The message.</param>
        public InvalidMeasurementRequestException(MeasurementFunction measurementFunction, string message)
            : base(message)
        {
            AttemptedMeasurementType = measurementFunction;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="InvalidMeasurementRequestException"/> class.
        /// </summary>
        /// <param name="measurementFunction">The measurement function.</param>
        /// <param name="message">The message.</param>
        /// <param name="innerException">The inner exception.</param>
        public InvalidMeasurementRequestException(MeasurementFunction measurementFunction, string message, Exception innerException)
            : base(message, innerException)
        {
            AttemptedMeasurementType = measurementFunction;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="InvalidMeasurementRequestException"/> class.
        /// </summary>
        /// <param name="measurementFunction">The measurement function.</param>
        /// <param name="info">The information.</param>
        /// <param name="context">The context.</param>
        public InvalidMeasurementRequestException(MeasurementFunction measurementFunction, SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
            AttemptedMeasurementType = measurementFunction;
        }

        #endregion
    }
}
