Files
GenericTeProgramLibrary/Source/TSRealLib/HAL/Interfaces/ISwitch/ISwitch.cs
2025-03-13 12:04:22 -07:00

85 lines
4.4 KiB
C#

// *******************************************************************************************
// ** **
// ** ISwitch.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;
namespace Raytheon.Instruments
{
/// <summary>
/// ISwitch - base interface to a switch device
/// </summary>
[UmsContract]
public interface ISwitch : IInstrument
{
/// <summary>
/// Connects the specified path.
/// </summary>
/// <param name="path">The path.</param>
[UmsCommand("ISwitch.Connect")]
void Connect(string path);
/// <summary>
/// Disconnects the specified path.
/// </summary>
/// <param name="path">The path.</param>
[UmsCommand("ISwitch.Disconnect")]
void Disconnect(string path);
/// <summary>
/// Disconnects all paths (opens all switches).
/// </summary>
[UmsCommand("ISwitch.DisconnectAll")]
void DisconnectAll();
/// <summary>
/// Gets a value indicating whether this instance is debounced.
/// </summary>
/// <value>
/// <c>true</c> if this instance is debounced; otherwise, <c>false</c>.
/// </value>
bool IsDebounced
{
[UmsCommand("ISwitch.GetIsDebounced")]
get;
}
//*** possible enhancements
//bool CanConnect(string path);
//string[] GetInputChannelNames();
//string[] GetOutputChannelNames();
}
}