FIX: emit properties cleanup

.github/workflows/ci_cd.yml

@@ -993,7 +993,7 @@ jobs:
         with:
           max_attempts: 2
           retry_on: error
-          timeout_minutes: 30
+          timeout_minutes: 40
           command: |
             .venv\Scripts\Activate.ps1
             pytest ${{ env.PYTEST_ARGUMENTS }} --timeout=600 -v -rA --color=yes -m emit

doc/changelog.d/6835.fixed.md

@@ -0,0 +1 @@
+Emit properties cleanup

ignore_words.txt

@@ -32,4 +32,8 @@ aline
 COM
 gRPC
 Toolkits
-Extensions
+Extensions
+Synopsys
+intermodulation
+intermod
+Intermod

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

@@ -182,7 +182,8 @@ def create_radio_antenna(
             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
+                return new_radio, new_antenna
+            raise RuntimeError(f"Failed to create radio of type '{radio_type}' or 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}")

src/ansys/aedt/core/emit_core/nodes/emit_node.py

@@ -91,6 +91,31 @@ def name(self) -> str:
         """
         return self._get_property("Name", True)
 
+    @name.setter
+    def name(self, requested_name: str):
+        """Renames the node/component.
+
+        Parameters
+        ----------
+        requested_name : str
+            New name for the node/component.
+
+        Raises
+        ------
+        ValueError
+            If the node is read-only or cannot be renamed.
+        """
+        if self._result_id > 0:
+            raise ValueError("This node is read-only for kept results.")
+
+        if self.get_is_component():
+            try:
+                self._emit_obj.oeditor.RenameComponent(self.name, requested_name)
+            except Exception:
+                raise ValueError(f"Failed to rename {self.name} to {requested_name}")
+        else:
+            _ = self._oRevisionData.RenameEmitNode(self._result_id, self._node_id, requested_name)
+
     @property
     def _node_type(self) -> str:
         """Type of the node.
@@ -239,7 +264,7 @@ def children(self):
         child_nodes = [self._get_node(child_id) for child_id in child_ids]
         return child_nodes
 
-    def _get_property(self, prop, skipChecks=False, isTable=False) -> Union[str, List[str]]:
+    def _get_property(self, prop, skipChecks: bool = False, isTable: bool = False) -> Union[str, List[str]]:
         """Fetch the value of a given property.
 
         Parameters
@@ -257,7 +282,7 @@ def _get_property(self, prop, skipChecks=False, isTable=False) -> Union[str, Lis
             kv_pairs = [prop.split("=") for prop in props]
             selected_kv_pairs = [kv for kv in kv_pairs if kv[0].rstrip() == prop]
             if len(selected_kv_pairs) < 1:
-                return ""
+                raise ValueError(f"Property {prop} not found or not available for {self._node_type} configuration.")
 
             selected_kv_pair = selected_kv_pairs[0]
             val = selected_kv_pair[1]
@@ -276,9 +301,9 @@ def _get_property(self, prop, skipChecks=False, isTable=False) -> Union[str, Lis
         except Exception:
             raise self._emit_obj.logger.aedt_messages.error_level[-1]
 
-    def _set_property(self, prop, value):
+    def _set_property(self, prop, value, skipChecks=False):
         try:
-            self._oRevisionData.SetEmitNodeProperties(self._result_id, self._node_id, [f"{prop}={value}"], True)
+            self._oRevisionData.SetEmitNodeProperties(self._result_id, self._node_id, [f"{prop}={value}"], skipChecks)
         except Exception:
             error_text = None
             if len(self._emit_obj.logger.messages.error_level) > 0:
@@ -288,7 +313,7 @@ def _set_property(self, prop, value):
                     f'Exception in SetEmitNodeProperties: Failed setting property "{prop}" to "{value}" for '
                     f'{self.properties["Type"]} node "{self.name}"'
                 )
-            raise Exception(error_text)
+            raise ValueError(error_text)
 
     @staticmethod
     def _string_to_value_units(value) -> tuple[float, str]:
@@ -408,6 +433,9 @@ def _delete(self):
     def _rename(self, requested_name: str) -> str:
         """Renames the node/component.
 
+        .. deprecated: 0.21.3
+            Use name property instead
+
         Parameters
         ----------
         requested_name : str
@@ -423,15 +451,10 @@ def _rename(self, requested_name: str) -> str:
         ValueError
             If the node is read-only and cannot be renamed.
         """
-        if self.get_is_component():
-            if self._result_id > 0:
-                raise ValueError("This node is read-only for kept results.")
-            self._emit_obj.oeditor.RenameComponent(self.name, requested_name)
-            new_name = requested_name
-        else:
-            new_name = self._oRevisionData.RenameEmitNode(self._result_id, self._node_id, requested_name)
+        warnings.warn("This property is deprecated in 0.21.3. Use the name property instead.", DeprecationWarning)
+        self.name = requested_name
 
-        return new_name
+        return self.name
 
     def _duplicate(self, new_name):
         raise NotImplementedError("This method is not implemented yet.")
@@ -446,8 +469,24 @@ def _import(self, file_path: str, import_type: str):
         import_type : str
             Type of import. Options are: CsvFile, TxMeasurement, RxMeasurement,
             SpectralData, TouchstoneCoupling, CAD.
+
+        Returns
+        -------
+        node: EmitNode
+            The node.
         """
-        self._oRevisionData.EmitNodeImport(self._result_id, self._node_id, file_path, import_type)
+        try:
+            node_id = self._oRevisionData.EmitNodeImport(self._result_id, self._node_id, file_path, import_type)
+        except Exception:
+            error_text = None
+            if len(self._emit_obj.logger.messages.error_level) > 0:
+                error_text = self._emit_obj.logger.aedt_messages.error_level[-1]
+            else:
+                error_text = (
+                    f'Exception in EmitNodeImport: Failed to import: "{file_path}" of node type: "{import_type}"'
+                )
+            raise Exception(error_text)
+        return self._get_node(node_id)
 
     def _export_model(self, file_path: str):
         """Exports an Emit node's model to a file.
@@ -514,6 +553,7 @@ def _get_table_data(self):
             The node's table data as a list of tuples.
             [(x1, y1, z1), (x2, y2, z2)]
         """
+        table = []
         try:
             if self._is_column_data_table():
                 # Column Data tables
@@ -529,6 +569,8 @@ def _get_table_data(self):
                 # with ';' separating rows and '|' separating columns
                 table_key = self._get_property("TableKey", True)
                 string_table = self._get_property(table_key, True, True)
+                if string_table == "":
+                    return table
 
                 def try_float(val):
                     try:
@@ -563,7 +605,7 @@ def _set_table_data(self, table):
                 # with ';' separating rows and '|' separating columns
                 table_key = self._get_property("TableKey", True)
                 data = ";".join("|".join(map(str, row)) for row in table)
-                self._set_property(table_key, data)
+                self._set_property(table_key, data, True)
         except Exception as e:
             print(f"Failed to set table data for node {self.name}. Error: {e}")
 

src/ansys/aedt/core/emit_core/nodes/emitter_node.py

@@ -51,8 +51,8 @@ class EmitterNode(EmitNode):
     """
 
     def __init__(self, emit_obj, result_id, node_id):
-        self._is_component = True
         EmitNode.__init__(self, emit_obj, result_id, node_id)
+        self._is_component = True
         self._radio_node = RadioNode(emit_obj, result_id, node_id)
 
         # create_component code provides the radio_id, but we also
@@ -66,6 +66,7 @@ def __init__(self, emit_obj, result_id, node_id):
                 ant_id = self._oRevisionData.GetChildNodeID(result_id, scene_node_id, ant)
                 self._antenna_node = AntennaNode(emit_obj, result_id, ant_id)
 
+    @property
     def node_type(self) -> str:
         """The type of this emit node"""
         return "EmitterNode"
@@ -106,6 +107,7 @@ def get_antenna(self) -> AntennaNode:
         """
         return self._antenna_node
 
+    @property
     def children(self):
         """Overridden to return the Waveforms
 

src/ansys/aedt/core/emit_core/nodes/generated/amplifier.py

@@ -23,25 +23,24 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-
 from ansys.aedt.core.emit_core.nodes.emit_node import EmitNode
 
 
 class Amplifier(EmitNode):
     def __init__(self, emit_obj, result_id, node_id):
-        self._is_component = True
         EmitNode.__init__(self, emit_obj, result_id, node_id)
+        self._is_component = True
 
     @property
     def node_type(self) -> str:
         """The type of this emit node."""
         return self._node_type
 
-    def rename(self, new_name: str):
+    def rename(self, new_name: str = ""):
         """Rename this node"""
         self._rename(new_name)
 
-    def duplicate(self, new_name: str):
+    def duplicate(self, new_name: str = ""):
         """Duplicate this node"""
         return self._duplicate(new_name)
 
@@ -64,19 +63,6 @@ def table_data(self):
     def table_data(self, value):
         self._set_table_data(value)
 
-    @property
-    def filename(self) -> str:
-        """Name of file defining the outboard component.
-
-        Value should be a full file path.
-        """
-        val = self._get_property("Filename")
-        return val
-
-    @filename.setter
-    def filename(self, value: str):
-        self._set_property("Filename", f"{value}")
-
     @property
     def noise_temperature(self) -> float:
         """System Noise temperature (K) of the component.

src/ansys/aedt/core/emit_core/nodes/generated/antenna_node.py

@@ -30,8 +30,8 @@
 
 class AntennaNode(EmitNode):
     def __init__(self, emit_obj, result_id, node_id):
-        self._is_component = False
         EmitNode.__init__(self, emit_obj, result_id, node_id)
+        self._is_component = True
 
     @property
     def parent(self):
@@ -47,11 +47,11 @@ def add_antenna_passband(self):
         """Add a New Passband to this Antenna"""
         return self._add_child_node("Antenna Passband")
 
-    def rename(self, new_name: str):
+    def rename(self, new_name: str = ""):
         """Rename this node"""
         self._rename(new_name)
 
-    def duplicate(self, new_name: str):
+    def duplicate(self, new_name: str = ""):
         """Duplicate this node"""
         return self._duplicate(new_name)
 
@@ -112,8 +112,8 @@ def relative_position(self, value):
         self._set_property("Relative Position", f"{value}")
 
     class OrientationModeOption(Enum):
-        ROLL_PITCH_YAW = "Roll-Pitch-Yaw"
-        AZ_EL_TWIST = "Az-El-Twist"
+        ROLL_PITCH_YAW = "rpyDeg"
+        AZ_EL_TWIST = "aetDeg"
 
     @property
     def orientation_mode(self) -> OrientationModeOption:
@@ -181,29 +181,29 @@ def antenna_temperature(self) -> float:
     def antenna_temperature(self, value: float):
         self._set_property("Antenna Temperature", f"{value}")
 
-    class TypeOption(Enum):
+    class SubTypeOption(Enum):
         ISOTROPIC = "Isotropic"
-        BY_FILE = "By File"
+        BY_FILE = "ByFile"
         HEMITROPIC = "Hemitropic"
-        SHORT_DIPOLE = "Short Dipole"
-        HALF_WAVE_DIPOLE = "Half-wave Dipole"
-        QUARTER_WAVE_MONOPOLE = "Quarter-wave Monopole"
-        WIRE_DIPOLE = "Wire Dipole"
-        WIRE_MONOPOLE = "Wire Monopole"
-        SMALL_LOOP = "Small Loop"
-        DIRECTIVE_BEAM = "Directive Beam"
-        PYRAMIDAL_HORN = "Pyramidal Horn"
+        SHORT_DIPOLE = "ShortDipole"
+        HALF_WAVE_DIPOLE = "HalfWaveDipole"
+        QUARTER_WAVE_MONOPOLE = "QuarterWaveMonopole"
+        WIRE_DIPOLE = "WireDipole"
+        WIRE_MONOPOLE = "WireMonopole"
+        SMALL_LOOP = "SmallLoop"
+        DIRECTIVE_BEAM = "DirectiveBeam"
+        PYRAMIDAL_HORN = "PyramidalHorn"
 
     @property
-    def type(self) -> TypeOption:
+    def subtype(self) -> SubTypeOption:
         """Defines the type of antenna."""
-        val = self._get_property("Type")
-        val = self.TypeOption[val.upper()]
+        val = self._get_property("SubType")
+        val = self.SubTypeOption[val.upper()]
         return val
 
-    @type.setter
-    def type(self, value: TypeOption):
-        self._set_property("Type", f"{value.value}")
+    @subtype.setter
+    def subtype(self, value: SubTypeOption):
+        self._set_property("SubType", f"{value.value}")
 
     @property
     def antenna_file(self) -> str:

src/ansys/aedt/core/emit_core/nodes/generated/antenna_passband.py

@@ -28,8 +28,8 @@
 
 class AntennaPassband(EmitNode):
     def __init__(self, emit_obj, result_id, node_id):
-        self._is_component = False
         EmitNode.__init__(self, emit_obj, result_id, node_id)
+        self._is_component = False
 
     @property
     def parent(self):
@@ -41,11 +41,11 @@ def node_type(self) -> str:
         """The type of this emit node."""
         return self._node_type
 
-    def rename(self, new_name: str):
+    def rename(self, new_name: str = ""):
         """Rename this node"""
         self._rename(new_name)
 
-    def duplicate(self, new_name: str):
+    def duplicate(self, new_name: str = ""):
         """Duplicate this node"""
         return self._duplicate(new_name)
 
@@ -56,7 +56,7 @@ def delete(self):
     @property
     def enabled(self) -> bool:
         """Enabled state for this node."""
-        return self._get_property("Enabled")
+        return self._get_property("Enabled") == "true"
 
     @enabled.setter
     def enabled(self, value: bool):