updating to return Emit node instead of ID

Author: ramin4667

src/ansys/aedt/core/emit_core/emit_schematic.py

@@ -23,6 +23,7 @@
 # SOFTWARE.
 
 
+from ansys.aedt.core.emit_core.nodes.emit_node import EmitNode
 from ansys.aedt.core.generic.general_methods import pyaedt_function_handler
 
 
@@ -61,7 +62,7 @@ def _emit_com_module(self):
             raise RuntimeError(f"Failed to retrieve EmitCom module: {e}")
 
     @pyaedt_function_handler
-    def create_component(self, component_type: str, name: str = None, library: str = None) -> int:
+    def create_component(self, component_type: str, name: str = None, library: str = None) -> EmitNode:
         """Create a component.
 
         Parameters
@@ -75,8 +76,8 @@ def create_component(self, component_type: str, name: str = None, library: str =
 
         Returns
         -------
-        int
-            The ID of the created component.
+        EmitNode
+            The EmitNode of the created component.
 
         Raises
         ------
@@ -119,20 +120,22 @@ def create_component(self, component_type: str, name: str = None, library: str =
                     f"Using exact match component '{component.name}' from library '{component.component_library}"
                     "' for type '{component_type}'."
                 )
+            revision = self.emit_instance.results.get_revision()
 
             # Create the component using the EmitCom module
             new_component_id = self._emit_com_module.CreateEmitComponent(
                 name, component.name, component.component_library
             )
-            return new_component_id
+            component_node = revision._get_node(node_id=new_component_id)
+            return component_node
         except Exception as e:
             self.emit_instance.logger.error(f"Failed to create component '{name}' of type '{component_type}': {e}")
             raise RuntimeError(f"Failed to create component of type '{component_type}': {e}")
 
     @pyaedt_function_handler
     def create_radio_antenna(
         self, radio_type: str, radio_name: str = None, antenna_name: str = None, library: str = None
-    ) -> tuple[int, int]:
+    ) -> tuple[EmitNode, EmitNode]:
         """Create a new radio and antenna and connect them.
 
         Parameters
@@ -152,8 +155,8 @@ def create_radio_antenna(
 
         Returns
         -------
-        tuple
-            A tuple containing the IDs of the created radio and antenna.
+        tuple[EmitNode, EmitNode]
+            A tuple containing the EmitNode of the created radio and antenna.
 
         Raises
         ------
@@ -165,74 +168,38 @@ def create_radio_antenna(
         library = library or ""
 
         try:
-            new_radio_id = self.create_component(radio_type, radio_name, library)
-            new_antenna_id = self.create_component("Antenna", antenna_name, "Antennas")
-            if new_radio_id and new_antenna_id:
-                self.connect_components(new_antenna_id, new_radio_id)  # Connect antenna to radio
-            return new_radio_id, new_antenna_id
+            new_radio = self.create_component(radio_type, radio_name, library)
+            new_antenna = self.create_component("Antenna", antenna_name, "Antennas")
+            if new_radio and new_antenna:
+                self.connect_components(new_antenna.name, new_radio.name)  # Connect antenna to radio
+            return new_radio, new_antenna
         except Exception as e:
             self.emit_instance.logger.error(f"Failed to create radio of type '{radio_type}' or antenna: {e}")
             raise RuntimeError(f"Failed to create radio of type '{radio_type}' or antenna: {e}")
 
     @pyaedt_function_handler
-    def connect_components(self, component_id_1: int, component_id_2: int):
+    def connect_components(self, component_name_1: str, component_name_2: str) -> None:
         """Connect two components in the schematic.
 
         Parameters
         ----------
-        component_id_1 : str
-            ID of the first component.
-        component_id_2 : str
-            ID of the second component.
+        component_1 : str
+            Name of the first component.
+        component_2 : str
+            Name of the second component.
 
         Raises
         ------
         RuntimeError
             If the connection fails.
         """
         try:
-            component_name_1 = self.get_component_properties(component_id_1, "Name")
-            component_name_2 = self.get_component_properties(component_id_2, "Name")
             self.emit_instance._oeditor.PlaceComponent(component_name_1, component_name_2)
             self.emit_instance.logger.info(
                 f"Successfully connected components '{component_name_1}' and '{component_name_2}'."
             )
         except Exception as e:
             self.emit_instance.logger.error(
-                f"Failed to connect components '{component_id_1}' and '{component_id_2}': {e}"
+                f"Failed to connect components '{component_name_1}' and '{component_name_2}': {e}"
             )
-            raise RuntimeError(f"Failed to connect components '{component_id_1}' and '{component_id_2}': {e}")
-
-    @pyaedt_function_handler
-    def get_component_properties(self, component_id: int, property_key: str = None) -> dict:
-        """Get properties of a component.
-
-        Parameters
-        ----------
-        component_id : int
-            ID of the component.
-        property_key : str, optional
-            Specific property key to retrieve. If ``None``, all properties are returned.
-
-        Returns
-        -------
-        dict or str
-            Dictionary containing all properties of the component if `property_key` is ``None``.
-            Otherwise, the value of the specified property key.
-
-        Raises
-        ------
-        KeyError
-            If the specified property key is not found.
-        """
-        try:
-            props = self._emit_com_module.GetEmitNodeProperties(0, component_id, True)
-            props_dict = {prop.split("=", 1)[0]: prop.split("=", 1)[1] for prop in props}
-            if property_key is None:
-                return props_dict
-            if property_key in props_dict:
-                return props_dict[property_key]
-            raise KeyError(f"Property key '{property_key}' not found.")
-        except Exception as e:
-            self.emit_instance.logger.error(f"Failed to retrieve properties for component '{component_id}': {e}")
-            raise RuntimeError(f"Failed to retrieve properties for component '{component_id}': {e}")
+            raise RuntimeError(f"Failed to connect components '{component_name_1}' and '{component_name_2}': {e}")

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

@@ -358,7 +358,7 @@ def create_interface_port(self, name, location=None, angle=0):
         arg2 = ["NAME:Attributes", "Page:=", 1, "X:=", xpos, "Y:=", ypos, "Angle:=", angle, "Flip:=", False]
         comp_name = self.oeditor.CreateIPort(arg1, arg2)
 
-        id = int(comp_name.split(";")[1])
+        comp_id = int(comp_name.split(";")[1])
         self.add_id_to_component(id, comp_name)
         # return id, self.components[id].composed_name
         for el in self.components:
@@ -475,7 +475,7 @@ def create_gnd(self, location=None, angle=0, page=1):
             ["NAME:GroundProps"],
             ["NAME:Attributes", "Page:=", page, "X:=", xpos, "Y:=", ypos, "Angle:=", angle, "Flip:=", False],
         )
-        id = int(name.split(";")[1])
+        comp_id = int(name.split(";")[1])
         self.add_id_to_component(id, name)
         # return id, self.components[id].composed_name
         for el in self.components:
@@ -1389,12 +1389,12 @@ def refresh_all_ids(self):
         return len(self.components)
 
     @pyaedt_function_handler()
-    def add_id_to_component(self, id, name=None):
+    def add_id_to_component(self, comp_id, name=None):
         """Add an ID to a component.
 
         Parameters
         ----------
-        id : int
+        comp_id : int
             ID to assign to the component.
 
         Returns
@@ -1420,7 +1420,7 @@ def add_id_to_component(self, id, name=None):
         obj = self.oeditor.GetAllElements()
         for el in obj:
             name = el.split(";")
-            if len(name) > 1 and str(id) == name[1]:
+            if len(name) > 1 and str(comp_id) == name[1]:
                 o = CircuitComponent(self, tabname=self.tab_name)
                 o.name = name[0]
                 if len(name) > 2:

tests/system/solvers/test_26_emit.py

@@ -50,8 +50,8 @@
     from ansys.aedt.core.emit_core.emit_constants import ResultType
     from ansys.aedt.core.emit_core.emit_constants import TxRxMode
     from ansys.aedt.core.emit_core.nodes import generated
+    from ansys.aedt.core.emit_core.nodes.emit_node import EmitNode
 
-    # from ansys.aedt.core.emit_core.nodes.emit_node import EmitNode
     # from ansys.aedt.core.emit_core.nodes.generated import *
     # from ansys.aedt.core.emit_core.results.revision import Revision
     from ansys.aedt.core.modeler.circuits.primitives_emit import EmitAntennaComponent
@@ -1636,7 +1636,7 @@ def test_28_create_component(self, add_app):
         self.aedtapp = add_app(project_name="create_component", application=Emit)
         self.aedtapp.logger.info = MagicMock()
         new_radio = self.aedtapp.schematic.create_component("MICS")
-        assert new_radio == 3
+        assert isinstance(new_radio, EmitNode)
         self.aedtapp.logger.info.assert_called_with(
             r"Using component 'MICS' from library 'Radios\Commercial Unlicensed Systems\Medical' for type 'MICS'."
         )
@@ -1660,8 +1660,8 @@ def test_28_create_component(self, add_app):
     def test_29_create_radio_antenna(self, add_app):
         self.aedtapp = add_app(project_name="radio_antenna", application=Emit)
         new_radio, new_antenna = self.aedtapp.schematic.create_radio_antenna("MICS", "Radio", "Antenna")
-        assert new_radio == 3
-        assert new_antenna == 4
+        assert isinstance(new_radio, EmitNode)
+        assert isinstance(new_antenna, EmitNode)
         with pytest.raises(RuntimeError) as e:
             self.aedtapp.schematic.create_radio_antenna("WrongComponent", "Radio", "Antenna")
         assert "Failed to create radio of type 'WrongComponent'" in str(e.value)
@@ -1672,28 +1672,11 @@ def test_30_connect_components(self, add_app):
         self.aedtapp.logger.info = MagicMock()
         new_radio = self.aedtapp.schematic.create_component("MICS")
         new_antenna = self.aedtapp.schematic.create_component("Antenna")
-        self.aedtapp.schematic.connect_components(new_radio, new_antenna)
+        self.aedtapp.schematic.connect_components(new_radio.name, new_antenna.name)
         self.aedtapp.logger.info.assert_called_with("Successfully connected components 'MICS' and 'Antenna'.")
         with pytest.raises(RuntimeError) as e:
-            self.aedtapp.schematic.connect_components(new_radio, 6)
+            self.aedtapp.schematic.connect_components(new_radio.name, "WrongComponent")
         assert (
-            "Failed to connect components '3' and '6': Failed to retrieve properties for component '6': "
-            "Failed to execute gRPC AEDT command: GetEmitNodeProperties"
+            "Failed to connect components 'MICS' and 'WrongComponent': "
+            "Failed to execute gRPC AEDT command: PlaceComponent"
         ) in str(e.value)
-
-    @pytest.mark.skipif(config["desktopVersion"] < "2025.2", reason="Skipped on versions earlier than 2025 R2.")
-    def test_31_get_component_properties(self, add_app):
-        self.aedtapp = add_app(project_name="component_properties", application=Emit)
-        new_radio = self.aedtapp.schematic.create_component("MICS")
-        new_radio_props = self.aedtapp.schematic.get_component_properties(new_radio)
-        assert isinstance(new_radio_props, dict)
-        assert new_radio_props["Name"] == "MICS"
-        assert new_radio_props["Type"] == "RadioNode"
-        assert new_radio_props["IconAlias"] == ":Radio"
-        new_radio_name = self.aedtapp.schematic.get_component_properties(new_radio, "Name")
-        assert new_radio_name == "MICS"
-        with pytest.raises(RuntimeError) as e:
-            self.aedtapp.schematic.get_component_properties(new_radio, "WrongProp")
-        assert ("Failed to retrieve properties for component '3': \"Property key 'WrongProp' not found.\"") in str(
-            e.value
-        )