FIX: emit properties cleanup

doc/changelog.d/6835.fixed.md

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

ignore_words.txt

@@ -32,4 +32,7 @@ aline
 COM
 gRPC
 Toolkits
-Extensions
+Extensions
+Synopsys
+intermodulation
+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,28 @@ 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():
+            self._emit_obj.oeditor.RenameComponent(self.name, 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 +261,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
@@ -276,9 +298,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:
@@ -408,6 +430,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 +448,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.")
@@ -563,7 +583,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:
@@ -183,27 +183,27 @@ def antenna_temperature(self, value: float):
 
     class TypeOption(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:
         """Defines the type of antenna."""
-        val = self._get_property("Type")
-        val = self.TypeOption[val.upper()]
+        val = self._get_property("Type", True)
+        val = self.TypeOption(val)
         return val
 
     @type.setter
     def type(self, value: TypeOption):
-        self._set_property("Type", f"{value.value}")
+        self._set_property("SubType", f"{value.value}", True)
 
     @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):

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

@@ -30,8 +30,8 @@
 
 class Band(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):
@@ -43,10 +43,30 @@ def node_type(self) -> str:
         """The type of this emit node."""
         return self._node_type
 
+    def duplicate(self, new_name: str = ""):
+        """Duplicate this node"""
+        return self._duplicate(new_name)
+
+    def delete(self):
+        """Delete this node"""
+        self._delete()
+
+    def rename(self, new_name: str = ""):
+        """Rename this node"""
+        self._rename(new_name)
+
+    def import_rx_measurement(self, file_name):
+        """Import a Measurement from a File..."""
+        return self._import(file_name, "RxMeasurement")
+
+    def import_tx_measurement(self, file_name):
+        """Import a Measurement from a File..."""
+        return self._import(file_name, "TxMeasurement")
+
     @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):
@@ -241,10 +261,10 @@ def freq_deviation(self, value: float | str):
     class PSKTypeOption(Enum):
         BPSK = "BPSK"
         QPSK = "QPSK"
-        PSK_8 = "PSK-8"
-        PSK_16 = "PSK-16"
-        PSK_32 = "PSK-32"
-        PSK_64 = "PSK-64"
+        PSK_8 = "8-PSK"
+        PSK_16 = "16-PSK"
+        PSK_32 = "32-PSK"
+        PSK_64 = "64-PSK"
 
     @property
     def psk_type(self) -> PSKTypeOption:
@@ -258,9 +278,9 @@ def psk_type(self, value: PSKTypeOption):
         self._set_property("PSK Type", f"{value.value}")
 
     class FSKTypeOption(Enum):
-        FSK_2 = "FSK-2"
-        FSK_4 = "FSK-4"
-        FSK_8 = "FSK-8"
+        FSK_2 = "2-FSK"
+        FSK_4 = "4-FSK"
+        FSK_8 = "8-FSK"
 
     @property
     def fsk_type(self) -> FSKTypeOption:
@@ -274,11 +294,11 @@ def fsk_type(self, value: FSKTypeOption):
         self._set_property("FSK Type", f"{value.value}")
 
     class QAMTypeOption(Enum):
-        QAM_4 = "QAM-4"
-        QAM_16 = "QAM-16"
-        QAM_64 = "QAM-64"
-        QAM_256 = "QAM-256"
-        QAM_1024 = "QAM-1024"
+        QAM_4 = "4-QAM"
+        QAM_16 = "16-QAM"
+        QAM_64 = "64-QAM"
+        QAM_256 = "256-QAM"
+        QAM_1024 = "1024-QAM"
 
     @property
     def qam_type(self) -> QAMTypeOption:
@@ -292,11 +312,11 @@ def qam_type(self, value: QAMTypeOption):
         self._set_property("QAM Type", f"{value.value}")
 
     class APSKTypeOption(Enum):
-        APSK_4 = "APSK-4"
-        APSK_16 = "APSK-16"
-        APSK_64 = "APSK-64"
-        APSK_256 = "APSK-256"
-        APSK_1024 = "APSK-1024"
+        APSK_4 = "4-APSK"
+        APSK_16 = "16-APSK"
+        APSK_64 = "64-APSK"
+        APSK_256 = "256-APSK"
+        APSK_1024 = "1024-APSK"
 
     @property
     def apsk_type(self) -> APSKTypeOption: