FEAT: Add function to emit to list all component types (#6210)

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

Author: 3 people

doc/changelog.d/6210.added.md

@@ -0,0 +1 @@
+Add function to emit to list all component types

src/ansys/aedt/core/modeler/circuits/primitives_circuit.py

@@ -1676,15 +1676,21 @@ def __getitem__(self, compname):
             Circuit Component Info.
 
         """
-        items = self.find_components("*" + compname)
-        if items and len(items) == 1:
-            return self.components[items[0]]
-        elif len(items) > 1:
-            self._component_manager._logger.warning("Multiple components found.")
-            return None
+        if self._component_manager.design_type == "EMIT":
+            items = self.find_components("*" + compname + "*")
+            # Return a list of components
+            return [self.components[item] for item in items] if items else []
         else:
-            self._component_manager._logger.warning("Component not found.")
-            return None
+            items = self.find_components("*" + compname)
+            # Return a single component or None
+            if items and len(items) == 1:
+                return self.components[items[0]]
+            elif len(items) > 1:
+                self._component_manager._logger.warning("Multiple components found.")
+                return None
+            else:
+                self._component_manager._logger.warning("Component not found.")
+                return None
 
     def __init__(self, component_manager):
         self._component_manager = component_manager

src/ansys/aedt/core/modeler/circuits/primitives_emit.py

@@ -28,6 +28,7 @@
 from ansys.aedt.core.emit_core import emit_constants as emit_consts
 import ansys.aedt.core.generic.constants as consts
 from ansys.aedt.core.generic.general_methods import pyaedt_function_handler
+from ansys.aedt.core.modeler.circuits.primitives_circuit import ComponentCatalog
 
 
 class EmitComponents(object):
@@ -170,6 +171,10 @@ def __getitem__(self, compname):
 
         return None
 
+    @property
+    def _logger(self):
+        return self._app.logger
+
     def __len__(self):
         return len(self.components)
 
@@ -181,7 +186,40 @@ def __init__(self, parent, modeler):
         self.modeler = modeler
         self._currentId = 0
         self.components = defaultdict(EmitComponent)
+        self.include_personal_lib = False
         self.refresh_all_ids()
+        self._components_catalog = None
+        self._app = modeler._app
+
+    @property
+    def include_personal_library(self, value=None):
+        """Include personal library."""
+        if value is not None:
+            self.include_personal_lib = value
+        return self.include_personal_lib
+
+    @include_personal_library.setter
+    def include_personal_library(self, value):
+        self.include_personal_lib = value
+
+    @property
+    def design_libray(self):
+        """Design library."""
+        if self.include_personal_lib:
+            return "PersonalLib"
+        return "EMIT Elements"
+
+    @property
+    def components_catalog(self):
+        """System library component catalog with all information.
+
+        Returns
+        -------
+        :class:`ansys.aedt.core.modeler.cad.primitivesCircuit.ComponentCatalog`
+        """
+        if not self._components_catalog:
+            self._components_catalog = ComponentCatalog(self)
+        return self._components_catalog
 
     @pyaedt_function_handler()
     def create_component(self, component_type, name=None, library=None):

tests/system/solvers/test_26_emit.py

@@ -1292,3 +1292,11 @@ def count_license_actions(license_file_path):
         expected_checkins = checkins_per_run * (number_of_runs + 1)
 
         assert checkouts == expected_checkouts and checkins == expected_checkins
+
+    @pytest.mark.skipif(config["desktopVersion"] < "2025.1", reason="Skipped on versions earlier than 2024 R2.")
+    def test_25_components_catalog(self, add_app):
+        self.aedtapp = add_app(project_name="catalog-list", application=Emit)
+        comp_list = self.aedtapp.modeler.components.components_catalog["LTE"]
+        assert len(comp_list) == 14
+        assert comp_list[12].name == "LTE BTS"
+        assert comp_list[13].name == "LTE Mobile Station"