Implement type-safe getters/setters for CustomPropertyEditor properties

SolidDna/CADBooster.SolidDna/Errors/SolidDnaErrorCode.cs

@@ -169,6 +169,11 @@ public enum SolidDnaErrorCode
         /// </summary>
         SolidWorksModelGetConfigurationError = 11014,
 
+        /// <summary>
+        /// Error occurred while trying to get a custom property value from a SolidWorks model
+        /// </summary>
+        SolidWorksModelGetPropertyError = 11030,
+
         #endregion
 
         #region SolidWorks Command Manager (12,000)

SolidDna/CADBooster.SolidDna/SolidWorks/CustomProperties/CustomPropertyEditor.cs

@@ -1,6 +1,8 @@
 using SolidWorks.Interop.sldworks;
 using SolidWorks.Interop.swconst;
+using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 
 namespace CADBooster.SolidDna
@@ -10,6 +12,12 @@ namespace CADBooster.SolidDna
     /// </summary>
     public class CustomPropertyEditor : SolidDnaObject<CustomPropertyManager>
     {
+        /// <summary>
+        /// Gets or sets whether type checking is enabled when getting property values
+        /// When enabled, methods will verify the property type matches the expected type
+        /// By default is <see langword="true"/>
+        /// </summary>
+        public bool IsTypeCheckEnabled { get; set; } = true;
         #region Constructor
 
         /// <summary>
@@ -26,7 +34,7 @@ public CustomPropertyEditor(CustomPropertyManager model) : base(model)
         /// Checks if a custom property exists
         /// </summary>
         /// <param name="name">The name of the custom property</param>
-        /// <returns></returns>
+        /// <returns>If the property exists <see langword="true"/>, <see langword="false"/> otherwise</returns>
         public bool CustomPropertyExists(string name)
         {
             // TODO: Add error checking and exception catching
@@ -39,18 +47,156 @@ public bool CustomPropertyExists(string name)
         /// </summary>
         /// <param name="name">The name of the custom property</param>
         /// <param name="resolve">True to resolve the custom property value</param>
-        /// <returns></returns>
+        /// <returns>The property value as a string</returns>
         public string GetCustomProperty(string name, bool resolve = false)
         {
             // TODO: Add error checking and exception catching
 
             // Get custom property
-            BaseObject.Get5(name, false, out var val, out var resolvedVal, out var wasResolved);
+            _ = BaseObject.Get5(name, false, out var val, out var resolvedVal, out _);
 
             // Return desired result
             return resolve ? resolvedVal : val;
         }
 
+        /// <summary>
+        /// Gets a string value from a custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <param name="resolve">Whether to resolve the value (evaluate equations/formulas)</param>
+        /// <returns>The string value of the property</returns>
+        /// <exception cref="SolidDnaException">Thrown if type checking is enabled and the property is not of text type</exception>        
+        public string GetStringCustomProperty(string name, bool resolve = false)
+        {
+            // TODO: Add error checking and exception catching
+
+            if (IsTypeCheckEnabled)
+                ThrowIfExpectedTypeMismatch(name, swCustomInfoType_e.swCustomInfoText, true);
+
+            _ = BaseObject.Get5(name, false, out var val, out var resolvedVal, out _);
+
+            return resolve ? resolvedVal : val;
+        }
+
+        /// <summary>
+        /// Gets a DateTime value from a date-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <returns>The parsed DateTime value</returns>
+        /// <exception cref="SolidDnaException">Thrown if type checking is enabled and the property is not of date type</exception>
+        public DateTime GetDateCustomProperty(string name)
+        {
+            // TODO: Add error checking and exception catching
+
+            if (IsTypeCheckEnabled)
+                ThrowIfExpectedTypeMismatch(name, swCustomInfoType_e.swCustomInfoDate);
+
+
+            _ = BaseObject.Get5(name, false, out _, out var resolvedVal, out _);
+
+            return DateTime.Parse(resolvedVal);
+        }
+
+        /// <summary>
+        /// Gets an integer value from a number-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <returns>The parsed integer value</returns>
+        /// <exception cref="SolidDnaException">Thrown if type checking is enabled and the property is not of number type</exception>
+        public int GetIntegerCustomProperty(string name)
+        {
+            // TODO: Add error checking and exception catching
+
+            if (IsTypeCheckEnabled)
+                ThrowIfExpectedTypeMismatch(name, swCustomInfoType_e.swCustomInfoNumber);
+
+
+            _ = BaseObject.Get5(name, false, out _, out var resolvedVal, out _);
+
+            return int.Parse(resolvedVal);
+        }
+
+        /// <summary>
+        /// Gets a double value from a number-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <returns>The parsed double value</returns>
+        /// <exception cref="SolidDnaException">Thrown if type checking is enabled and the property is not of number type</exception>
+        public double GetDoubleCustomProperty(string name)
+        {
+            // TODO: Add error checking and exception catching
+
+            if (IsTypeCheckEnabled)
+                ThrowIfExpectedTypeMismatch(name, swCustomInfoType_e.swCustomInfoNumber);
+
+
+            _ = BaseObject.Get5(name, false, out _, out var resolvedVal, out _);
+
+            return double.Parse(resolvedVal, CultureInfo.InvariantCulture);
+        }
+
+        /// <summary>
+        /// Gets a boolean value from a yes/no-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <returns>The boolean value (<see langword="true"/> for "Yes", <see langword="false"/> for "No")</returns>
+        /// <exception cref="SolidDnaException">Thrown if type checking is enabled and the property is not of yes/no type</exception>
+        public bool GetBooleanCustomProperty(string name)
+        {
+            // TODO: Add error checking and exception catching
+
+            if (IsTypeCheckEnabled)
+                ThrowIfExpectedTypeMismatch(name, swCustomInfoType_e.swCustomInfoYesOrNo);
+
+            _ = BaseObject.Get5(name, false, out _, out var resolvedVal, out _);
+
+            switch (resolvedVal)
+            {
+                case "Yes":
+                    return true;
+                case "No":
+                    return false;
+                default:
+                    throw new InvalidOperationException();
+            }
+        }
+
+        /// <summary>
+        /// Gets the raw equation text from an equation-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <returns>The raw equation text</returns>
+        /// <exception cref="SolidDnaException">Thrown if type checking is enabled and the property is not of equation type</exception>
+        public string GetRawEquationCustomProperty(string name)
+        {
+            // TODO: Add error checking and exception catching
+
+            if (IsTypeCheckEnabled)
+                ThrowIfExpectedTypeMismatch(name, swCustomInfoType_e.swCustomInfoEquation, true);
+
+            _ = BaseObject.Get5(name, false, out var val, out _, out _);
+
+            return val;
+        }
+
+        /// <summary>
+        /// Gets the evaluated result of an equation-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <returns>The evaluated numeric result</returns>
+        /// <exception cref="SolidDnaException">Thrown if type checking is enabled and the property is not of equation type</exception>
+        public double GetEvaluatedEquationCustomProperty(string name)
+        {
+            // TODO: Add error checking and exception catching
+
+            if (IsTypeCheckEnabled)
+                ThrowIfExpectedTypeMismatch(name, swCustomInfoType_e.swCustomInfoEquation);
+
+            _ = BaseObject.Get5(name, false, out _, out var resolvedVal, out _);
+
+            return double.Parse(resolvedVal, CultureInfo.InvariantCulture);
+        }
+
         /// <summary>
         /// Sets the value of a custom property by name
         /// </summary>
@@ -72,9 +218,57 @@ public void SetCustomProperty(string name, string value, swCustomInfoType_e type
             //
 
             // Set new one
-            BaseObject.Add3(name, (int)type, value, (int)swCustomPropertyAddOption_e.swCustomPropertyReplaceValue);
+            _ = BaseObject.Add3(name, (int)type, value, (int)swCustomPropertyAddOption_e.swCustomPropertyReplaceValue);
         }
 
+        /// <summary>
+        /// Sets a string value to a text-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <param name="value">The string value to set</param>
+        public void SetStringCustomProperty(string name, string value) 
+            => SetCustomProperty(name, value, swCustomInfoType_e.swCustomInfoText);
+
+        /// <summary>
+        /// Sets a date value to a date-type custom property, time data is ignored
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <param name="value">The date value to set</param>
+        public void SetDateCustomProperty(string name, DateTime value) 
+            => SetCustomProperty(name, value.Date.ToShortDateString(), swCustomInfoType_e.swCustomInfoDate);
+
+        /// <summary>
+        /// Sets an integer value to a number-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <param name="value">The integer value to set</param>
+        public void SetIntegerCustomProperty(string name, int value) 
+            => SetCustomProperty(name, value.ToString(), swCustomInfoType_e.swCustomInfoNumber);
+
+        /// <summary>
+        /// Sets a double value to a number-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <param name="value">The double value to set</param>
+        public void SetDoubleCustomProperty(string name, double value)
+            => SetCustomProperty(name, value.ToString(CultureInfo.InvariantCulture), swCustomInfoType_e.swCustomInfoDouble);
+
+        /// <summary>
+        /// Sets a boolean value to a yes/no-type custom property ("Yes" for <see langword="true"/>, "No" for <see langword="false"/>)
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <param name="value">The boolean value to set</param>
+        public void SetBooleanCustomProperty(string name, bool value) 
+            => SetCustomProperty(name, value ? "Yes" : "No", swCustomInfoType_e.swCustomInfoYesOrNo);
+
+        /// <summary>
+        /// Sets an equation/formula to an equation-type custom property
+        /// </summary>
+        /// <param name="name">The name of the custom property</param>
+        /// <param name="value">The equation text to set</param>
+        public void SetEquationCustomProperty(string name, string value)
+            => SetCustomProperty(name, value, swCustomInfoType_e.swCustomInfoEquation);
+
         /// <summary>
         /// Deletes a custom property by name
         /// </summary>
@@ -107,5 +301,27 @@ public List<CustomProperty> GetCustomProperties()
             // Return the list
             return list;
         }
+
+        /// <summary>
+        /// Throws an exception if the actual property type doesn't match the expected type
+        /// </summary>
+        /// <param name="name">The name of the property to check</param>
+        /// <param name="expectedType">The expected property type</param>
+        /// <param name="allowUnknown">Whether to allow unknown/untyped properties</param>
+        /// <exception cref="SolidDnaException">Thrown if the property type doesn't match the expected type</exception>
+        private void ThrowIfExpectedTypeMismatch(string name, swCustomInfoType_e expectedType, bool allowUnknown = false)
+        {
+            var type = (swCustomInfoType_e)BaseObject.GetType2(name);
+
+            if (allowUnknown && type == swCustomInfoType_e.swCustomInfoUnknown)
+                return;
+
+            if (type != expectedType)
+            {
+                throw new SolidDnaException(SolidDnaErrors.CreateError(
+                        SolidDnaErrorTypeCode.SolidWorksModel, SolidDnaErrorCode.SolidWorksModelError,
+                        $"Property has different type that expected. Received: {type}, expected: {expectedType}"));
+            }
+        }
     }
 }