Major upgrade
This commit is contained in:
Duc
@@ -39,120 +39,122 @@ using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
namespace Raytheon.Instruments
|
||||
{
|
||||
/// <summary>
|
||||
/// Instrument manager interface.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// An instrument manager is responsible for loading all of the instrument plugins and providing an interface for retrieving those instruments.
|
||||
/// </remarks>
|
||||
[UmsContract]
|
||||
public interface IInstrumentManager
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets an instrument by name.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <returns>The instrument</returns>
|
||||
/// <remarks>This function cannot be named the same as the Generic method GetInstrument/<T/>
|
||||
/// because certain test executives do not support generics, and will throw an AmbiguousMatchException.</remarks>
|
||||
IInstrument GetGenericInstrument(string name);
|
||||
/// <summary>
|
||||
/// Instrument manager interface.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// An instrument manager is responsible for loading all of the instrument plugins and providing an interface for retrieving those instruments.
|
||||
/// </remarks>
|
||||
[UmsContract]
|
||||
public interface IInstrumentManager
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets an instrument by name.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <returns>The instrument</returns>
|
||||
/// <remarks>This function cannot be named the same as the Generic method GetInstrument/<T/>
|
||||
/// because certain test executives do not support generics, and will throw an AmbiguousMatchException.</remarks>
|
||||
IInstrument GetGenericInstrument(string name);
|
||||
|
||||
/// <summary>
|
||||
/// Gets an instrument by name.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <returns>The instrument</returns>
|
||||
T GetInstrument<T>(string name) where T : class;
|
||||
/// <summary>
|
||||
/// Gets an instrument by name.
|
||||
/// </summary>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <returns>The instrument</returns>
|
||||
T GetInstrument<T>(string name) where T : class;
|
||||
|
||||
/// <summary>
|
||||
/// Gets all instruments currently loaded.
|
||||
/// </summary>
|
||||
/// <returns>collection of all known instruments</returns>
|
||||
ICollection<object> GetInstruments();
|
||||
/// <summary>
|
||||
/// Gets all instruments currently loaded.
|
||||
/// </summary>
|
||||
/// <returns>collection of all known instruments</returns>
|
||||
ICollection<object> GetInstruments();
|
||||
|
||||
/// <summary>
|
||||
/// Gets all instruments currently loaded.
|
||||
/// </summary>
|
||||
/// <returns>array of all known instruments</returns>
|
||||
[UmsCommand("IInstrumentManager.GetInstrumentsArray")]
|
||||
object[] GetInstrumentsArray();
|
||||
/// <summary>
|
||||
/// Gets all instruments currently loaded.
|
||||
/// </summary>
|
||||
/// <returns>array of all known instruments</returns>
|
||||
[UmsCommand("IInstrumentManager.GetInstrumentsArray")]
|
||||
object[] GetInstrumentsArray();
|
||||
|
||||
/// <summary>
|
||||
/// Gets the instruments of the given type.
|
||||
/// </summary>
|
||||
/// <param name="type">The type.</param>
|
||||
/// <returns>all known instruments of a certain type</returns>
|
||||
ICollection<object> GetInstruments(Type type);
|
||||
/// <summary>
|
||||
/// Gets the instruments of the given type.
|
||||
/// </summary>
|
||||
/// <param name="type">The type.</param>
|
||||
/// <returns>all known instruments of a certain type</returns>
|
||||
ICollection<object> GetInstruments(Type type);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the instruments of the given type.
|
||||
/// </summary>
|
||||
/// <param name="type">The type.</param>
|
||||
/// <returns>array of instruments of the specified type</returns>
|
||||
object[] GetInstrumentsArray(Type type);
|
||||
/// <summary>
|
||||
/// Gets the instruments of the given type.
|
||||
/// </summary>
|
||||
/// <param name="type">The type.</param>
|
||||
/// <returns>array of instruments of the specified type</returns>
|
||||
object[] GetInstrumentsArray(Type type);
|
||||
|
||||
/// <summary>
|
||||
/// Initializes the instrument manager
|
||||
/// </summary>
|
||||
[UmsCommand("IInstrumentManager.Initialize")]
|
||||
void Initialize();
|
||||
/// <summary>
|
||||
/// Initializes the instrument manager
|
||||
/// </summary>
|
||||
[UmsCommand("IInstrumentManager.Initialize")]
|
||||
void Initialize();
|
||||
|
||||
/// <summary>
|
||||
/// Sets/Gets the part location
|
||||
/// Added Dec 2013 to better clarify where the part locations are loading from
|
||||
/// and to be able to set it before initialization
|
||||
/// </summary>
|
||||
string _partsLocation
|
||||
{
|
||||
get;
|
||||
set;
|
||||
}
|
||||
/// <summary>
|
||||
/// Sets/Gets the part location
|
||||
/// Added Dec 2013 to better clarify where the part locations are loading from
|
||||
/// and to be able to set it before initialization
|
||||
/// </summary>
|
||||
string _partsLocation { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Closes the instrument manager
|
||||
/// </summary>
|
||||
void Shutdown();
|
||||
/// <summary>
|
||||
/// ConfigLocation - where the configuration manager stores config files
|
||||
/// specifically Instruments.xml
|
||||
/// </summary>
|
||||
string _configLocation { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Returns a collection of instrument names loaded.
|
||||
/// </summary>
|
||||
/// <returns>all the known instrument's unique name</returns>
|
||||
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
|
||||
[UmsCommand("IInstrumentManager.GetInstrumentNames")]
|
||||
ICollection<string> GetInstrumentNames();
|
||||
/// <summary>
|
||||
/// Closes the instrument manager
|
||||
/// </summary>
|
||||
void Shutdown();
|
||||
|
||||
/// <summary>
|
||||
/// Returns a collection of instrument names loaded.
|
||||
/// </summary>
|
||||
/// <returns>all the known instrument names in array form</returns>
|
||||
[UmsCommand("IInstrumentManager.GetInstrumentNamesArray")]
|
||||
string[] GetInstrumentNamesArray();
|
||||
/// <summary>
|
||||
/// Returns a collection of instrument names loaded.
|
||||
/// </summary>
|
||||
/// <returns>all the known instrument's unique name</returns>
|
||||
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
|
||||
[UmsCommand("IInstrumentManager.GetInstrumentNames")]
|
||||
ICollection<string> GetInstrumentNames();
|
||||
|
||||
/// <summary>
|
||||
/// Initializes all of the instruments.
|
||||
/// </summary>
|
||||
[UmsCommand("IInstrumentManager.InitializeInstruments")]
|
||||
void InitializeInstruments();
|
||||
/// <summary>
|
||||
/// Returns a collection of instrument names loaded.
|
||||
/// </summary>
|
||||
/// <returns>all the known instrument names in array form</returns>
|
||||
[UmsCommand("IInstrumentManager.GetInstrumentNamesArray")]
|
||||
string[] GetInstrumentNamesArray();
|
||||
|
||||
/// <summary>
|
||||
/// Initializes the instrument.
|
||||
/// </summary>
|
||||
/// <param name="instName">Name of the inst.</param>
|
||||
[UmsCommand("IInstrumentManager.InitializeInstrument")]
|
||||
void InitializeInstrument(string instName);
|
||||
/// <summary>
|
||||
/// Initializes all of the instruments.
|
||||
/// </summary>
|
||||
[UmsCommand("IInstrumentManager.InitializeInstruments")]
|
||||
void InitializeInstruments();
|
||||
|
||||
/// <summary>
|
||||
/// Shuts down all of the instruments.
|
||||
/// </summary>
|
||||
[UmsCommand("IInstrumentManager.ShutdownInstruments")]
|
||||
void ShutdownInstruments();
|
||||
/// <summary>
|
||||
/// Initializes the instrument.
|
||||
/// </summary>
|
||||
/// <param name="instName">Name of the inst.</param>
|
||||
[UmsCommand("IInstrumentManager.InitializeInstrument")]
|
||||
void InitializeInstrument(string instName);
|
||||
|
||||
/// <summary>
|
||||
/// Shutdowns the instrument.
|
||||
/// </summary>
|
||||
/// <param name="instName">Name of the inst.</param>
|
||||
[UmsCommand("IInstrumentManager.ShutdownInstrument")]
|
||||
void ShutdownInstrument(string instName);
|
||||
/// <summary>
|
||||
/// Shuts down all of the instruments.
|
||||
/// </summary>
|
||||
[UmsCommand("IInstrumentManager.ShutdownInstruments")]
|
||||
void ShutdownInstruments();
|
||||
|
||||
}
|
||||
/// <summary>
|
||||
/// Shutdowns the instrument.
|
||||
/// </summary>
|
||||
/// <param name="instName">Name of the inst.</param>
|
||||
[UmsCommand("IInstrumentManager.ShutdownInstrument")]
|
||||
void ShutdownInstrument(string instName);
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user