REFACTOR: FilterSolutions unit test improvements (#5987)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

Author: ramin4667

doc/changelog.d/5987.miscellaneous.md

@@ -0,0 +1 @@
+FilterSolutions unit test improvements

src/ansys/aedt/core/filtersolutions_core/attributes.py

@@ -49,9 +49,9 @@ def __init__(self):
 
     def _define_substrate_dll_functions(self):
         """Define C++ API DLL functions."""
-        self._dll.setDistributedSubstrateType.argtype = c_char_p
+        self._dll.setDistributedSubstrateType.argtype = c_int
         self._dll.setDistributedSubstrateType.restype = int
-        self._dll.getDistributedSubstrateType.argtypes = [c_char_p, c_int]
+        self._dll.getDistributedSubstrateType.argtype = POINTER(c_int)
         self._dll.getDistributedSubstrateType.restype = int
 
         self._dll.setDistributedEr.argtype = [c_char_p, c_int]
@@ -114,14 +114,17 @@ def substrate_type(self) -> SubstrateType:
         -------
         :enum:`SubstrateType`
         """
-        type_string = self._dll_interface.get_string(self._dll.getDistributedSubstrateType)
-        return self._dll_interface.string_to_enum(SubstrateType, type_string)
+        index = c_int()
+        substrate_type_list = list(SubstrateType)
+        status = self._dll.getDistributedSubstrateType(byref(index))
+        self._dll_interface.raise_error(status)
+        substrate_type = substrate_type_list[index.value]
+        return substrate_type
 
     @substrate_type.setter
     def substrate_type(self, substrate_type: SubstrateType):
-        if substrate_type:
-            string_value = self._dll_interface.enum_to_string(substrate_type)
-            self._dll_interface.set_string(self._dll.setDistributedSubstrateType, string_value)
+        status = self._dll.setDistributedSubstrateType(substrate_type.value)
+        self._dll_interface.raise_error(status)
 
     @property
     def substrate_er(self) -> Union[SubstrateType, str]:
@@ -153,7 +156,7 @@ def substrate_er(self, substrate_input):
             substrate_er_value = substrate_input
             substrate_er_index = -1
         else:
-            raise ValueError("Invalid substrate input. Must be a SubstrateEr enum member or a string.")
+            raise ValueError("Invalid substrate input. Must be a SubstrateEr enum member or a string")
 
         substrate_er_value_bytes = bytes(substrate_er_value, "ascii")
         status = self._dll.setDistributedEr(substrate_er_value_bytes, substrate_er_index)
@@ -190,7 +193,7 @@ def substrate_resistivity(self, substrate_input):
             substrate_resistivity_value = substrate_input
             substrate_resistivity_index = -1
         else:
-            raise ValueError("Invalid substrate input. Must be a SubstrateResistivity enum member or a string.")
+            raise ValueError("Invalid substrate input. Must be a SubstrateResistivity enum member or a string")
         substrate_resistivity_value_bytes = bytes(substrate_resistivity_value, "ascii")
         status = self._dll.setDistributedResistivity(substrate_resistivity_value_bytes, substrate_resistivity_index)
         self._dll_interface.raise_error(status)
@@ -226,7 +229,7 @@ def substrate_loss_tangent(self, substrate_input):
             substrate_loss_tangent_value = substrate_input
             substrate_loss_tangent_index = -1
         else:
-            raise ValueError("Invalid substrate input. Must be a SubstrateEr enum member or a string.")
+            raise ValueError("Invalid substrate input. Must be a SubstrateEr enum member or a string")
         substrate_loss_tangent_value_bytes = bytes(substrate_loss_tangent_value, "ascii")
         status = self._dll.setDistributedLossTangent(substrate_loss_tangent_value_bytes, substrate_loss_tangent_index)
         self._dll_interface.raise_error(status)

src/ansys/aedt/core/filtersolutions_core/distributed_substrate.py

@@ -140,6 +140,7 @@ def set_string(self, dll_function: Callable, string: str):
         bytes_value = bytes(string, "ascii")
         status = dll_function(bytes_value)
         self.raise_error(status)
+        return status
 
     def string_to_enum(self, enum_type: Enum, string: str) -> Enum:
         """Convert a string to a string defined by an enum.

src/ansys/aedt/core/filtersolutions_core/dll_interface.py

@@ -366,10 +366,16 @@ def _define_export_to_desktop_dll_functions(self):
         self._dll.getInterconnectGeometryOptimization.argtype = POINTER(c_bool)
         self._dll.getInterconnectGeometryOptimization.restype = c_int
 
-        self._dll.setSubstrateType.argtype = c_char_p
-        self._dll.setSubstrateType.restype = int
-        self._dll.getSubstrateType.argtypes = [c_char_p, c_int]
-        self._dll.getSubstrateType.restype = int
+        if self._dll_interface.api_version() >= "2025.2":
+            self._dll.setSubstrateType.argtype = c_int
+            self._dll.setSubstrateType.restype = c_int
+            self._dll.getSubstrateType.argtype = POINTER(c_int)
+            self._dll.getSubstrateType.restype = c_int
+        else:
+            self._dll.setSubstrateType.argtype = c_char_p
+            self._dll.setSubstrateType.restype = c_int
+            self._dll.getSubstrateType.argtypes = [c_char_p, c_int]
+            self._dll.getSubstrateType.restype = c_int
 
         self._dll.setEr.argtype = [c_char_p, c_int]
         self._dll.setEr.restype = c_int
@@ -871,7 +877,7 @@ def export_design(self, export_format=None, export_creation_mode=None, export_pa
             export_format = ExportFormat.DIRECT_TO_AEDT
         if export_creation_mode is None:
             export_creation_mode = ExportCreationMode.OVERWRITE
-        if export_path is None:
+        if not export_path:
             export_path = ""
         else:
             directory_path = os.path.dirname(export_path)
@@ -898,7 +904,7 @@ def import_tuned_variables(self):
 
     @property
     def part_libraries(self) -> PartLibraries:
-        """Part libraries selection. The default is ``LUMPED``.
+        """Part libraries selection. The default is ``LUMPED`` if not specified.
 
         The ``PartLibraries`` enum provides a list of all options.
 
@@ -1276,22 +1282,37 @@ def update_inductor_capacitor_tolerances(self):  # pragma: no cover
 
     @property
     def substrate_type(self) -> SubstrateType:
-        """Substrate type of the filter.
+        """Substrate type of the filter. The default is ``MICROSTRIP`` if not specified.
 
         The ``SubstrateType`` enum provides a list of all substrate types.
 
         Returns
         -------
         :enum:`SubstrateType`
         """
-        type_string = self._dll_interface.get_string(self._dll.getSubstrateType)
-        return self._dll_interface.string_to_enum(SubstrateType, type_string)
+        # The 25R2 DLL is updated to return the enum value directly
+        if self._dll_interface.api_version() >= "2025.2":
+            index = c_int()
+            substrate_type_list = list(SubstrateType)
+            status = self._dll.getSubstrateType(byref(index))
+            self._dll_interface.raise_error(status)
+            substrate_type = substrate_type_list[index.value]
+            return substrate_type
+        # The 25R1 DLL returns the substrate type as a string
+        else:
+            type_string = self._dll_interface.get_string(self._dll.getSubstrateType)
+            return self._dll_interface.string_to_enum(SubstrateType, type_string)
 
     @substrate_type.setter
     def substrate_type(self, substrate_type: SubstrateType):
-        if substrate_type:
+        if self._dll_interface.api_version() >= "2025.2":
+            # The 25R2 DLL is updated to accept the enum value directly
+            status = self._dll.setSubstrateType(substrate_type.value)
+        else:
+            # The 25R1 DLL accepts substrate type as a string
             string_value = self._dll_interface.enum_to_string(substrate_type)
-            self._dll_interface.set_string(self._dll.setSubstrateType, string_value)
+            status = self._dll_interface.set_string(self._dll.setSubstrateType, string_value)
+        self._dll_interface.raise_error(status)
 
     @property
     def substrate_er(self) -> Union[SubstrateType, str]:
@@ -1323,7 +1344,7 @@ def substrate_er(self, substrate_input):
             substrate_er_value = substrate_input
             substrate_er_index = -1
         else:
-            raise ValueError("Invalid substrate input. Must be a SubstrateEr enum member or a string.")
+            raise ValueError("Invalid substrate input. Must be a SubstrateEr enum member or a string")
         substrate_er_value_bytes = bytes(substrate_er_value, "ascii")
         status = self._dll.setEr(substrate_er_value_bytes, substrate_er_index)
         self._dll_interface.raise_error(status)
@@ -1357,7 +1378,7 @@ def substrate_resistivity(self, substrate_input):
             substrate_resistivity_value = substrate_input
             substrate_resistivity_index = -1
         else:
-            raise ValueError("Invalid substrate input. Must be a SubstrateResistivity enum member or a string.")
+            raise ValueError("Invalid substrate input. Must be a SubstrateResistivity enum member or a string")
         substrate_resistivity_value_bytes = bytes(substrate_resistivity_value, "ascii")
         status = self._dll.setResistivity(substrate_resistivity_value_bytes, substrate_resistivity_index)
         self._dll_interface.raise_error(status)
@@ -1391,7 +1412,7 @@ def substrate_loss_tangent(self, substrate_input):
             substrate_loss_tangent_value = substrate_input
             substrate_loss_tangent_index = -1
         else:
-            raise ValueError("Invalid substrate input. Must be a SubstrateEr enum member or a string.")
+            raise ValueError("Invalid substrate input. Must be a SubstrateEr enum member or a string")
         substrate_loss_tangent_value_bytes = bytes(substrate_loss_tangent_value, "ascii")
         status = self._dll.setLossTangent(substrate_loss_tangent_value_bytes, substrate_loss_tangent_index)
         self._dll_interface.raise_error(status)

src/ansys/aedt/core/filtersolutions_core/export_to_aedt.py

@@ -213,10 +213,10 @@ def _frequency_response_getter(self, column: FrequencyResponseColumn):
         """
         size = c_int()
         status = self._dll.getIdealFrequencyResponseSize(byref(size))
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         array = (c_double * size.value)()
         status = self._dll.getIdealFrequencyResponse(array, size.value, column.value)
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         values = [float(val) for val in array]
         return values
 
@@ -235,10 +235,10 @@ def _time_response_getter(self, column: TimeResponseColumn):
         """
         size = c_int()
         status = self._dll.getIdealTimeResponseSize(byref(size))
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         array = (c_double * size.value)()
         status = self._dll.getIdealTimeResponse(array, size.value, column.value)
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         values = [float(val) for val in array]
         return values
 
@@ -257,10 +257,10 @@ def _sparamaters_response_getter(self, column: SParametersResponseColumn):
         """
         size = c_int()
         status = self._dll.getIdealSParamatersResponseSize(byref(size))
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         array = (c_double * size.value)()
         status = self._dll.getIdealSParamatersResponse(array, size.value, column.value)
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         values = [float(val) for val in array]
         return values
 
@@ -280,10 +280,10 @@ def _pole_zeros_response_getter(self, column: PoleZerosResponseColumn):
         """
         size = c_int()
         status = self._dll.getIdealPoleZerosResponseSize(byref(size), column.value)
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         array = (c_double * size.value)()
         status = self._dll.getIdealPoleZerosResponse(array, size.value, column.value)
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         values = [float(val) for val in array]
         return values
 
@@ -302,7 +302,7 @@ def transfer_function_response(self):
         """
         size = c_int()
         status = self._dll.getIdealTransferFunctionResponseSize(byref(size))
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         transfer_function_response_string = self._dll_interface.get_string(
             self._dll.getIdealTransferFunctionResponse, max_size=size.value
         )
@@ -319,13 +319,13 @@ def vsg_analysis_enabled(self) -> bool:
 
         vsg_analysis_enabled = c_bool()
         status = self._dll.getVSGAnalsyis(byref(vsg_analysis_enabled))
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         return bool(vsg_analysis_enabled.value)
 
     @vsg_analysis_enabled.setter
     def vsg_analysis_enabled(self, filter_vsg_analysis_enabled: bool):
         status = self._dll.setVSGAnalsyis(filter_vsg_analysis_enabled)
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
 
     def frequency_response(
         self,

src/ansys/aedt/core/filtersolutions_core/ideal_response.py

@@ -194,13 +194,13 @@ def c_node_compensate(self) -> bool:
         """
         c_node_compensate = c_bool()
         status = self._dll.getLumpedCNodeLedComensate(byref(c_node_compensate))
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         return bool(c_node_compensate.value)
 
     @c_node_compensate.setter
     def c_node_compensate(self, c_node_compensate: bool):
         status = self._dll.setLumpedCNodeLedComensate(c_node_compensate)
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
 
     @property
     def l_node_compensate(self) -> bool:
@@ -212,10 +212,10 @@ def l_node_compensate(self) -> bool:
         """
         l_node_compensate = c_bool()
         status = self._dll.getLumpedLNodeLedComensate(byref(l_node_compensate))
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)
         return bool(l_node_compensate.value)
 
     @l_node_compensate.setter
     def l_node_compensate(self, l_node_compensate: bool):
         status = self._dll.setLumpedLNodeLedComensate(l_node_compensate)
-        ansys.aedt.core.filtersolutions_core._dll_interface().raise_error(status)
+        self._dll_interface.raise_error(status)