Initial check-in

Source/Interfaces/IInstrument/IInstrumentProxyFactory.cs

@@ -0,0 +1,70 @@
+// ******************************************************************************************
+// **                                                                                       **
+// **      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 Raytheon.Communication;
+using Raytheon.Communication.Rpc;
+
+namespace Raytheon.Instruments
+{
+    /// <summary>
+    /// IInstrumentProxyFactory - interface to a proxy instrument factory, used to identify
+    ///                           the ums piece that will do the proxy'ing
+    /// </summary>
+    public interface IInstrumentProxyFactory
+    {
+        /// <summary>
+        /// Initialize - sets up the factory with the ums components it needs to distribute
+        ///              the proxy instruments
+        /// </summary>
+        /// <param name="umsHost">the port used to proxy</param>
+        /// <param name="umsClientFactory">the factory associated with port to create the clients</param>
+        void Initialize(IUms umsHost, IUmsClientFactory umsClientFactory);
+
+        /// <summary>
+        /// GetInstrument - get a proxy'd instrument
+        /// </summary>
+        /// <param name="name">unique name of the instrument</param>
+        /// <returns>null if the instrument does not exist and the instrument implementation if it does</returns>
+        IInstrument GetInstrument(string name);
+
+        /// <summary>
+        /// GetSupportedInterfaces - discovery about the factory to find out which instruments
+        ///                          it provides proxies to
+        /// </summary>
+        /// <returns>collection of supported interface names</returns>
+        ICollection<string> GetSupportedInterfaces();
+    }
+}