Big changes

Source/TSRealLib/HAL/Interfaces/Common/IInstrument/State.cs

@@ -0,0 +1,88 @@
+// ******************************************************************************************
+// **                                                                                       **
+// **      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 System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Runtime.Serialization;
+
+namespace Raytheon.Instruments
+{
+    /// <summary>
+    /// State - enumeration for the states a instrument could be in
+    /// </summary>
+    [DataContract]
+    public enum State
+    {
+        /// <summary>
+        /// State.Ready - the up and running waiting on instructions
+        /// </summary>
+        [EnumMember]
+        Ready,
+
+        /// <summary>
+        /// State.Busy - the instrument cannot be tasked it is already processing
+        ///              some command or instruction that cannot be interrupted
+        /// </summary>
+        [EnumMember]
+        Busy,
+
+        /// <summary>
+        /// State.CommunicationFailure - the instrument is in error right now and the
+        ///                              software component has lost connection with
+        ///                              the instrument
+        /// </summary>
+        [EnumMember]
+        CommunicationFailure,
+
+        /// <summary>
+        /// State.HardwareFailure - the hardware has failed and cannot recover from some
+        ///                         error
+        /// </summary>
+        [EnumMember]
+        HardwareFailure,
+
+        /// <summary>
+        /// State.InternalError - driver error internal to the software
+        /// </summary>
+        [EnumMember]
+        InternalError,
+
+        /// <summary>
+        /// State.Uninitialized - an unknown state as the instrument must be initialized to 
+        ///                       understand it's current state.
+        /// </summary>
+        [EnumMember]
+        Uninitialized,
+    }
+}