Refactor probe configuration properties for serialization and backward compatibility

Author: bparks13

OpenEphys.Onix1.Design/NeuropixelsV2eProbeConfigurationDialog.cs

@@ -60,10 +60,18 @@ public NeuropixelsV2eProbeConfigurationDialog(NeuropixelsV2ProbeConfiguration co
             {
                 [ProbeType.SingleShank] = configuration is NeuropixelsV2SingleShankProbeConfiguration
                     ? configuration.Clone()
-                    : new NeuropixelsV2SingleShankProbeConfiguration(configuration.Probe, NeuropixelsV2SingleShankReference.External),
+                    : new NeuropixelsV2SingleShankProbeConfiguration(configuration.Probe,
+                        NeuropixelsV2SingleShankReference.External,
+                        configuration.InvertPolarity,
+                        configuration.GainCalibrationFileName,
+                        configuration.ProbeInterfaceFileName),
                 [ProbeType.QuadShank] = configuration is NeuropixelsV2QuadShankProbeConfiguration
                     ? configuration.Clone()
-                    : new NeuropixelsV2QuadShankProbeConfiguration(configuration.Probe, NeuropixelsV2QuadShankReference.External)
+                    : new NeuropixelsV2QuadShankProbeConfiguration(configuration.Probe,
+                        NeuropixelsV2QuadShankReference.External,
+                        configuration.InvertPolarity,
+                        configuration.GainCalibrationFileName,
+                        configuration.ProbeInterfaceFileName)
             };
 
             var currentProbeType = GetCurrentProbeType(configuration);

OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs

@@ -78,10 +78,17 @@ public bool ShouldSerializeInvertPolarity()
         [Category(ConfigurationCategory)]
         [Description("Probe A configuration.")]
         [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eProbeConfigurationEditor, OpenEphys.Onix1.Design", typeof(UITypeEditor))]
-        [XmlElement(nameof(ProbeConfigurationA), typeof(NeuropixelsV2QuadShankProbeConfiguration))]
+        [XmlElement(nameof(ProbeConfigurationA), typeof(NeuropixelsV2QuadShankProbeConfiguration))] // NB: Needed for backward compatibility
         [TypeConverter(typeof(GenericPropertyConverter))]
         public NeuropixelsV2ProbeConfiguration ProbeConfigurationA { get; set; } = new NeuropixelsV2QuadShankProbeConfiguration(NeuropixelsV2Probe.ProbeA, NeuropixelsV2QuadShankReference.External);
 
+        /// <summary>
+        /// Prevent the <see cref="ProbeConfigurationA"/> property from being serialized.
+        /// </summary>
+        /// <returns>False</returns>
+        [Obsolete]
+        public bool ShouldSerializeProbeConfigurationA() => false;
+
         /// <summary>
         /// Gets or sets the path to the gain calibration file for this probe.
         /// </summary>
@@ -105,15 +112,36 @@ public bool ShouldSerializeGainCalibrationFileA()
         {
             return false;
         }
+        
+        /// <summary>
+        /// Gets or sets the <see cref="ProbeConfigurationA"/> property.
+        /// </summary>
+        /// <remarks>
+        /// [Obsolete]. Cannot tag this property with the Obsolete attribute due to https://github.com/dotnet/runtime/issues/100453
+        /// </remarks>
+        [Browsable(false)]
+        [Externalizable(false)]
+        public NeuropixelsV2ProbeConfiguration ConfigurationA
+        {
+            get => ProbeConfigurationA;
+            set => ProbeConfigurationA = value;
+        }
 
         /// <inheritdoc/>
         [Category(ConfigurationCategory)]
         [Description("Probe B configuration.")]
         [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eProbeConfigurationEditor, OpenEphys.Onix1.Design", typeof(UITypeEditor))]
-        [XmlElement(nameof(ProbeConfigurationB), typeof(NeuropixelsV2QuadShankProbeConfiguration))]
+        [XmlElement(nameof(ProbeConfigurationB), typeof(NeuropixelsV2QuadShankProbeConfiguration))] // NB: Needed for backward compatibility
         [TypeConverter(typeof(GenericPropertyConverter))]
         public NeuropixelsV2ProbeConfiguration ProbeConfigurationB { get; set; } = new NeuropixelsV2QuadShankProbeConfiguration(NeuropixelsV2Probe.ProbeB, NeuropixelsV2QuadShankReference.External);
 
+        /// <summary>
+        /// Prevent the <see cref="ProbeConfigurationB"/> property from being serialized.
+        /// </summary>
+        /// <returns>False</returns>
+        [Obsolete]
+        public bool ShouldSerializeProbeConfigurationB() => false;
+
         /// <summary>
         /// Gets or sets the path to the gain calibration file for this probe.
         /// </summary>
@@ -138,6 +166,20 @@ public bool ShouldSerializeGainCalibrationFileB()
             return false;
         }
 
+        /// <summary>
+        /// Gets or sets the <see cref="ProbeConfigurationB"/> property.
+        /// </summary>
+        /// <remarks>
+        /// [Obsolete]. Cannot tag this property with the Obsolete attribute due to https://github.com/dotnet/runtime/issues/100453
+        /// </remarks>
+        [Browsable(false)]
+        [Externalizable(false)]
+        public NeuropixelsV2ProbeConfiguration ConfigurationB
+        {
+            get => ProbeConfigurationB;
+            set => ProbeConfigurationB = value;
+        }
+
         /// <summary>
         /// Configures a NeuropixelsV2e device.
         /// </summary>

OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs

@@ -93,10 +93,17 @@ public bool ShouldSerializeInvertPolarity()
         [Category(ConfigurationCategory)]
         [Description("Probe A configuration.")]
         [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eProbeConfigurationEditor, OpenEphys.Onix1.Design", typeof(UITypeEditor))]
-        [XmlElement(nameof(ProbeConfigurationA), typeof(NeuropixelsV2QuadShankProbeConfiguration))]
+        [XmlElement(nameof(ProbeConfigurationA), typeof(NeuropixelsV2QuadShankProbeConfiguration))] // NB: Needed for backward compatibility
         [TypeConverter(typeof(GenericPropertyConverter))]
         public NeuropixelsV2ProbeConfiguration ProbeConfigurationA { get; set; } = new NeuropixelsV2QuadShankProbeConfiguration(NeuropixelsV2Probe.ProbeA, NeuropixelsV2QuadShankReference.External);
 
+        /// <summary>
+        /// Prevent the <see cref="ProbeConfigurationA"/> property from being serialized.
+        /// </summary>
+        /// <returns>False</returns>
+        [Obsolete]
+        public bool ShouldSerializeProbeConfigurationA() => false;
+
         /// <summary>
         /// Gets or sets the path to the gain calibration file for this probe.
         /// </summary>
@@ -121,14 +128,35 @@ public bool ShouldSerializeGainCalibrationFileA()
             return false;
         }
 
+        /// <summary>
+        /// Gets or sets the <see cref="ProbeConfigurationA"/> property.
+        /// </summary>
+        /// <remarks>
+        /// [Obsolete]. Cannot tag this property with the Obsolete attribute due to https://github.com/dotnet/runtime/issues/100453
+        /// </remarks>
+        [Browsable(false)]
+        [Externalizable(false)]
+        public NeuropixelsV2ProbeConfiguration ConfigurationA
+        {
+            get => ProbeConfigurationA;
+            set => ProbeConfigurationA = value;
+        }
+
         /// <inheritdoc/>
         [Category(ConfigurationCategory)]
         [Description("Probe B configuration.")]
         [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eProbeConfigurationEditor, OpenEphys.Onix1.Design", typeof(UITypeEditor))]
-        [XmlElement(nameof(ProbeConfigurationB), typeof(NeuropixelsV2QuadShankProbeConfiguration))]
+        [XmlElement(nameof(ProbeConfigurationB), typeof(NeuropixelsV2QuadShankProbeConfiguration))] // NB: Needed for backward compatibility
         [TypeConverter(typeof(GenericPropertyConverter))]
         public NeuropixelsV2ProbeConfiguration ProbeConfigurationB { get; set; } = new NeuropixelsV2QuadShankProbeConfiguration(NeuropixelsV2Probe.ProbeB, NeuropixelsV2QuadShankReference.External);
 
+        /// <summary>
+        /// Prevent the <see cref="ProbeConfigurationB"/> property from being serialized.
+        /// </summary>
+        /// <returns>False</returns>
+        [Obsolete]
+        public bool ShouldSerializeProbeConfigurationB() => false;
+
         /// <summary>
         /// Gets or sets the path to the gain calibration file for this probe.
         /// </summary>
@@ -153,6 +181,20 @@ public bool ShouldSerializeGainCalibrationFileB()
             return false;
         }
 
+        /// <summary>
+        /// Gets or sets the <see cref="ProbeConfigurationB"/> property.
+        /// </summary>
+        /// <remarks>
+        /// [Obsolete]. Cannot tag this property with the Obsolete attribute due to https://github.com/dotnet/runtime/issues/100453
+        /// </remarks>
+        [Browsable(false)]
+        [Externalizable(false)]
+        public NeuropixelsV2ProbeConfiguration ConfigurationB
+        {
+            get => ProbeConfigurationB;
+            set => ProbeConfigurationB = value;
+        }
+
         /// <summary>
         /// Configures a NeuropixelsV2eBeta device.
         /// </summary>

OpenEphys.Onix1/NeuropixelsV2ProbeConfiguration.cs

@@ -86,7 +86,7 @@ public abstract class NeuropixelsV2ProbeConfiguration
         /// </remarks>
         [Category(DeviceFactory.ConfigurationCategory)]
         [FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
-        [Description("Path to the gain calibration file for probe A.")]
+        [Description("Path to the gain calibration file for this probe.")]
         [Editor("Bonsai.Design.OpenFileNameEditor, Bonsai.Design", DesignTypes.UITypeEditor)]
         public string GainCalibrationFileName { get; set; }
 

OpenEphys.Onix1/NeuropixelsV2QuadShankProbeConfiguration.cs

@@ -47,7 +47,7 @@ public enum NeuropixelsV2QuadShankReference : uint
     [XmlType(TypeName = XmlTypeName, Namespace = Constants.XmlNamespace)]
     public class NeuropixelsV2QuadShankProbeConfiguration : NeuropixelsV2ProbeConfiguration
     {
-        internal const string XmlTypeName = "QuadShank";
+        internal const string XmlTypeName = nameof(NeuropixelsV2QuadShankProbeConfiguration);
 
         /// <summary>
         /// Initializes a default instance of the <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> class.
@@ -82,6 +82,29 @@ public NeuropixelsV2QuadShankProbeConfiguration(NeuropixelsV2QuadShankProbeConfi
             probeInterfaceFileName = probeConfiguration.probeInterfaceFileName;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> class with the given
+        /// values.
+        /// </summary>
+        /// <param name="probe">The <see cref="NeuropixelsV2Probe"/> for this probe.</param>
+        /// <param name="reference">The <see cref="NeuropixelsV2QuadShankReference"/> reference value.</param>
+        /// <param name="invertPolarity">Boolean defining if the signal polarity should be inverted.</param>
+        /// <param name="gainCalibrationFileName">String defining the path to the gain calibration file.</param>
+        /// <param name="probeInterfaceFileName">String defining the path to the ProbeInterface file.</param>
+        public NeuropixelsV2QuadShankProbeConfiguration(
+            NeuropixelsV2Probe probe,
+            NeuropixelsV2QuadShankReference reference,
+            bool invertPolarity,
+            string gainCalibrationFileName,
+            string probeInterfaceFileName)
+        {
+            Probe = probe;
+            Reference = reference;
+            InvertPolarity = invertPolarity;
+            GainCalibrationFileName = gainCalibrationFileName;
+            ProbeInterfaceFileName = probeInterfaceFileName;
+        }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> class with the given
         /// <see cref="NeuropixelsV2eQuadShankProbeGroup"/> channel configuration. 

OpenEphys.Onix1/NeuropixelsV2SingleShankProbeConfiguration.cs

@@ -35,7 +35,7 @@ public enum NeuropixelsV2SingleShankReference : uint
     [XmlType(TypeName = XmlTypeName, Namespace = Constants.XmlNamespace)]
     public class NeuropixelsV2SingleShankProbeConfiguration : NeuropixelsV2ProbeConfiguration
     {
-        internal const string XmlTypeName = "SingleShank";
+        internal const string XmlTypeName = nameof(NeuropixelsV2SingleShankProbeConfiguration);
 
         /// <summary>
         /// Initializes a default instance of the <see cref="NeuropixelsV2SingleShankProbeConfiguration"/> class.
@@ -68,6 +68,28 @@ public NeuropixelsV2SingleShankProbeConfiguration(NeuropixelsV2SingleShankProbeC
             probeInterfaceFileName = probeConfiguration.probeInterfaceFileName;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="NeuropixelsV2SingleShankProbeConfiguration"/> class with the given
+        /// values. 
+        /// </summary>
+        /// <param name="reference">The <see cref="NeuropixelsV2SingleShankReference"/> reference value.</param>
+        /// <param name="probe">The <see cref="NeuropixelsV2Probe"/> for this probe.</param>
+        /// <param name="invertPolarity">Boolean defining if the signal polarity should be inverted.</param>
+        /// <param name="gainCalibrationFileName">String defining the path to the gain calibration file.</param>
+        /// <param name="probeInterfaceFileName">String defining the path to the ProbeInterface file.</param>
+        public NeuropixelsV2SingleShankProbeConfiguration(NeuropixelsV2Probe probe,
+            NeuropixelsV2SingleShankReference reference,
+            bool invertPolarity,
+            string gainCalibrationFileName,
+            string probeInterfaceFileName)
+        {
+            Probe = probe;
+            Reference = reference;
+            InvertPolarity = invertPolarity;
+            GainCalibrationFileName = gainCalibrationFileName;
+            ProbeInterfaceFileName = probeInterfaceFileName;
+        }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="NeuropixelsV2SingleShankProbeConfiguration"/> class with the given
         /// <see cref="NeuropixelsV2eSingleShankProbeGroup"/> channel configuration.