|
1 | 1 | using System; |
2 | | -using System.Collections.Generic; |
3 | | -using System.Linq; |
4 | | -using System.Text; |
5 | | -using System.Threading.Tasks; |
6 | 2 |
|
7 | 3 | namespace OpenEphys.Onix1 |
8 | 4 | { |
9 | 5 | /// <summary> |
10 | 6 | /// Specifies a device class as equivalent to another for data production |
11 | 7 | /// </summary> |
12 | 8 | /// <remarks> |
13 | | - /// This attribute must be used on the static classes that specify |
14 | | - /// the device IDs and name converters to mark it as equivalent to |
15 | | - /// another. |
16 | | - /// |
17 | | - /// This will be used only for data production and name converters |
18 | | - /// |
19 | | - /// The method <see cref="ContextHelper.CheckDeviceType(Type, Type)"/> |
20 | | - /// can be used to check for type or equivalent type matching |
| 9 | + /// This attribute can be used on a static class that specifies device constants (e.g. ID, register |
| 10 | + /// addresses, etc) to indicate that another device produces equivalent <see |
| 11 | + /// cref="oni.Frame">oni.Frames</see> and, therefore, that both devices a common (set of) production |
| 12 | + /// operator(s). This attribute is used by <see cref="DeviceNameConverter"/> to identify devices that can |
| 13 | + /// make use of a given data production operator. |
21 | 14 | /// </remarks> |
22 | 15 | [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)] |
23 | 16 | public sealed class EquivalentDataSource : Attribute |
24 | 17 | { |
| 18 | + internal Type BaseType { get; } |
| 19 | + |
25 | 20 | /// <summary> |
26 | | - /// The original type the tagged class is equivalent to |
| 21 | + /// Initializes a new instance of the <see cref="EquivalentDataSource"/> class. |
27 | 22 | /// </summary> |
28 | | - public Type BaseType { get; } |
29 | | - |
| 23 | + /// <param name="baseType">Device type that produces equivalent <see cref="oni.Frame">oni.Frames</see></param> |
30 | 24 | public EquivalentDataSource(Type baseType) |
31 | 25 | { |
32 | 26 | BaseType = baseType; |
|
0 commit comments