// *******************************************************************************************
// **                                                                                       **
// **      IDmm.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 Raytheon.Communication;
using Raytheon.Instruments.Dmm;
using Raytheon.Units;
using System.Diagnostics.CodeAnalysis;

namespace Raytheon.Instruments
{
    /// <summary>
    /// IDmm - simple interface to a DMM device
    /// </summary>
    [UmsContract]
    public interface IDmm : IInstrument
    {
        /// <summary>
        /// Configures a voltage measurement.
        /// </summary>
        /// <param name="type">a valid voltage measurement type.</param>
        /// <param name="range">The measurement range.</param>
        /// <param name="resolution">The measurement resolution.</param>
        [UmsCommand("IDmm.ConfigureVoltageMeasurement")]
        void ConfigureVoltageMeasurement(MeasurementFunction type, Voltage range, Voltage resolution);

        /// <summary>
        /// Configures a current measurement.
        /// </summary>
        /// <param name="type">a valid current measurement type.</param>
        /// <param name="range">The measurement range.</param>
        /// <param name="resolution">The measurement resolution.</param>
        [UmsCommand("IDmm.ConfigureCurrentMeasurement")]
        void ConfigureCurrentMeasurement(MeasurementFunction type, Current range, Current resolution);

        /// <summary>
        /// Configures a resistance measurement.
        /// </summary>
        /// <param name="type">a valid resistance measurement type.</param>
        /// <param name="range">The measurement range.</param>
        /// <param name="resolution">The measurement resolution.</param>
        [UmsCommand("IDmm.ConfigureResistanceMeasurement")]
        void ConfigureResistanceMeasurement(MeasurementFunction type, Resistance range, Resistance resolution);

        /// <summary>
        /// Configures a Frequency measurement.
        /// </summary>
        /// <param name="type">a valid Frequency measurement type.</param>
        /// <param name="range">The measurement range.</param>
        /// <param name="resolution">The measurement resolution.</param>
        [UmsCommand("IDmm.ConfigureFrequencyMeasurement")]
        void ConfigureFrequencyMeasurement(MeasurementFunction type, Frequency range, Frequency resolution);

        /// <summary>
        /// Measure - Voltage measurement with current measurement configuration
        /// </summary>
        /// <param name="timeout">time to try operation before returning (milliseconds)</param>
        /// <returns>the measured voltage</returns>
        [UmsCommand("IDmm.MeasureVoltage")]
        Voltage MeasureVoltage(int timeout);

        /// <summary>
        /// Measure - Current measurement with current measurement configuration
        /// </summary>
        /// <param name="timeout">time to try operation before returning (milliseconds)</param>
        /// <returns>the measured current</returns>
        [UmsCommand("IDmm.MeasureCurrent")]
        Current MeasureCurrent(int timeout);

        /// <summary>
        /// Measure - Resistance measurement with current measurement configuration
        /// </summary>
        /// <param name="timeout">time to try operation before returning (milliseconds)</param>
        /// <returns>the measured resistance</returns>
        [UmsCommand("IDmm.MeasureResistance")]
        Resistance MeasureResistance(int timeout);

        /// <summary>
        /// Measure - frequency measurement with current measurement configuration
        /// </summary>
        /// <param name="timeout">time to try operation before returning (milliseconds)</param>
        /// <returns>the measured frequency</returns>
        [UmsCommand("IDmm.MeasureFrequency")]
        Frequency MeasureFrequency(int timeout);

        /// <summary>
        /// Gets the type of the measurement.
        /// </summary>
        /// <remarks>cannot set during a measurement</remarks>
        /// <value>
        /// The type of the measurement.
        /// </value>
        MeasurementFunction MeasurementType 
        { 
            [UmsCommand("IDmm.GetMeasurementType")]
            get; 
        }
    }
}
