// ******************************************************************************************
// **                                                                                       **
// **      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.                                   **
// **                                                                                       **
// **      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 System.Runtime.Serialization;

namespace Raytheon.Instruments
{
	[DataContract]
	public enum SpecAnAveragingType
	{
		[EnumMember]
		RMS,
		[EnumMember]
		LOG,
		[EnumMember]
		NONE
	};

	/// <summary>
	/// An interface for Spectrum Analyzers to implement.
	/// </summary>
	[UmsContract]
	public interface ISpecAnalyzer : IInstrument
	{
		/// <summary>
		/// 
		/// </summary>
		/// <param name="type"></param>
		/// <param name="numOfAverages"></param>
		[UmsCommand("ISpecAnalyzer.ConfigureAveraging")]
		void ConfigureAveraging(SpecAnAveragingType type, int numOfAverages);

		/// <summary>
		/// 
		/// </summary>
		/// <param name="rbw">-99 represents auto[TBR]</param>
		/// <param name="vbw">-99 represents auto[TBR]<</param>
		[UmsCommand("ISpecAnalyzer.ConfigureBandwidth")]
		void ConfigureBandwidth(int rbw, int vbw);

		[UmsCommand("ISpecAnalyzer.ConfigureFrequency")]
		void ConfigureFrequency(int centerFreq, int span);

		/// <summary>
		/// 
		/// </summary>
		/// <param name="attenuation">-99 represents auto[TBR]</param>
		[UmsCommand("ISpecAnalyzer.ConfigurePowerLevel")]
		void ConfigurePowerLevel(int attenuation);

		[UmsCommand("ISpecAnalyzer.IOQuery")]
		string IOQuery(string command, int timeout = 10000);

		[UmsCommand("ISpecAnalyzer.IOWrite")]
		void IOWrite(string command, bool shallWeCheckForError = true);

		[UmsCommand("ISpecAnalyzer.MeasurePeakAmplitude")]
		double MeasurePeakAmplitude();

		[UmsCommand("ISpecAnalyzer.MeasurePeakFrequency")]
		double MeasurePeakFrequency();
	}
}
