FEAT: Support new EmitCom API for 25R2, add node classes for all EMIT node types

doc/changelog.d/6068.added.md

@@ -0,0 +1 @@
+Support new emitcom api for 25r2, add node classes for all emit node types

src/ansys/aedt/core/emit.py

@@ -185,12 +185,6 @@ def __init__(
 
             self.__emit_api_enabled = True
 
-            # set the default units here to make sure the EmitApi level
-            # stays synced with pyaedt
-            unit_types = ["Power", "Frequency", "Length", "Time", "Voltage", "Data Rate", "Resistance"]
-            unit_values = ["dBm", "MHz", "meter", "ns", "mV", "bps", "Ohm"]
-            self.set_units(unit_types, unit_values)
-
     def _init_from_design(self, *args, **kwargs):
         self.__init__(*args, **kwargs)
 

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

@@ -56,37 +56,68 @@ def emit_api_python():
 
 
 def _init_enums(aedt_version):
-    ResultType.EMI = emit_api_python().result_type().emi
-    ResultType.DESENSE = emit_api_python().result_type().desense
-    ResultType.SENSITIVITY = emit_api_python().result_type().sensitivity
-    ResultType.POWER_AT_RX = emit_api_python().result_type().powerAtRx
-
-    TxRxMode.TX = emit_api_python().tx_rx_mode().tx
-    TxRxMode.RX = emit_api_python().tx_rx_mode().rx
-    TxRxMode.BOTH = emit_api_python().tx_rx_mode().both
-
-    InterfererType.TRANSMITTERS = emit_api_python().interferer_type().transmitters
-    InterfererType.EMITTERS = emit_api_python().interferer_type().emitters
-    InterfererType.TRANSMITTERS_AND_EMITTERS = emit_api_python().interferer_type().transmitters_and_emitters
-
-    UnitType.POWER = emit_api_python().unit_type().power
-    UnitType.FREQUENCY = emit_api_python().unit_type().frequency
-    UnitType.LENGTH = emit_api_python().unit_type().length
-    UnitType.TIME = emit_api_python().unit_type().time
-    UnitType.VOLTAGE = emit_api_python().unit_type().voltage
-    UnitType.DATA_RATE = emit_api_python().unit_type().dataRate
-    UnitType.RESISTANCE = emit_api_python().unit_type().resistance
-
     numeric_version = int(aedt_version[-3:])
-    if numeric_version >= 241:
-        emi_cat_filter = emit_api_python().emi_category_filter()
-        EmiCategoryFilter.IN_CHANNEL_TX_FUNDAMENTAL = emi_cat_filter.in_channel_tx_fundamental
-        EmiCategoryFilter.IN_CHANNEL_TX_HARMONIC_SPURIOUS = emi_cat_filter.in_channel_tx_harmonic_spurious
-        EmiCategoryFilter.IN_CHANNEL_TX_INTERMOD = emi_cat_filter.in_channel_tx_intermod
-        EmiCategoryFilter.IN_CHANNEL_TX_BROADBAND = emi_cat_filter.in_channel_tx_broadband
-        EmiCategoryFilter.OUT_OF_CHANNEL_TX_FUNDAMENTAL = emi_cat_filter.out_of_channel_tx_fundamental
-        EmiCategoryFilter.OUT_OF_CHANNEL_TX_HARMONIC_SPURIOUS = emi_cat_filter.out_of_channel_tx_harmonic_spurious
-        EmiCategoryFilter.OUT_OF_CHANNEL_TX_INTERMOD = emi_cat_filter.out_of_channel_tx_intermod
+
+    if numeric_version > 251:
+        ResultType.EMI = emit_api_python().result_type().emi
+        ResultType.DESENSE = emit_api_python().result_type().desense
+        ResultType.SENSITIVITY = emit_api_python().result_type().sensitivity
+        ResultType.POWER_AT_RX = emit_api_python().result_type().powerAtRx
+
+        TxRxMode.TX = emit_api_python().tx_rx_mode().tx
+        TxRxMode.RX = emit_api_python().tx_rx_mode().rx
+        TxRxMode.BOTH = emit_api_python().tx_rx_mode().both
+
+        InterfererType.TRANSMITTERS = emit_api_python().interferer_type().transmitters
+        InterfererType.EMITTERS = emit_api_python().interferer_type().emitters
+        InterfererType.TRANSMITTERS_AND_EMITTERS = emit_api_python().interferer_type().transmitters_and_emitters
+
+        UnitType.POWER = emit_api_python().unit_type().power
+        UnitType.FREQUENCY = emit_api_python().unit_type().frequency
+        UnitType.LENGTH = emit_api_python().unit_type().length
+        UnitType.TIME = emit_api_python().unit_type().time
+        UnitType.VOLTAGE = emit_api_python().unit_type().voltage
+        UnitType.DATA_RATE = emit_api_python().unit_type().dataRate
+        UnitType.RESISTANCE = emit_api_python().unit_type().resistance
+
+        EmiCategoryFilter.IN_CHANNEL_TX_FUNDAMENTAL = 0
+        EmiCategoryFilter.IN_CHANNEL_TX_HARMONIC_SPURIOUS = 1
+        EmiCategoryFilter.IN_CHANNEL_TX_INTERMOD = 2
+        EmiCategoryFilter.IN_CHANNEL_TX_BROADBAND = 3
+        EmiCategoryFilter.OUT_OF_CHANNEL_TX_FUNDAMENTAL = 4
+        EmiCategoryFilter.OUT_OF_CHANNEL_TX_HARMONIC_SPURIOUS = 5
+        EmiCategoryFilter.OUT_OF_CHANNEL_TX_INTERMOD = 6
+    else:
+        ResultType.EMI = emit_api_python().result_type().emi
+        ResultType.DESENSE = emit_api_python().result_type().desense
+        ResultType.SENSITIVITY = emit_api_python().result_type().sensitivity
+        ResultType.POWER_AT_RX = emit_api_python().result_type().powerAtRx
+
+        TxRxMode.TX = emit_api_python().tx_rx_mode().tx
+        TxRxMode.RX = emit_api_python().tx_rx_mode().rx
+        TxRxMode.BOTH = emit_api_python().tx_rx_mode().both
+
+        InterfererType.TRANSMITTERS = emit_api_python().interferer_type().transmitters
+        InterfererType.EMITTERS = emit_api_python().interferer_type().emitters
+        InterfererType.TRANSMITTERS_AND_EMITTERS = emit_api_python().interferer_type().transmitters_and_emitters
+
+        UnitType.POWER = emit_api_python().unit_type().power
+        UnitType.FREQUENCY = emit_api_python().unit_type().frequency
+        UnitType.LENGTH = emit_api_python().unit_type().length
+        UnitType.TIME = emit_api_python().unit_type().time
+        UnitType.VOLTAGE = emit_api_python().unit_type().voltage
+        UnitType.DATA_RATE = emit_api_python().unit_type().dataRate
+        UnitType.RESISTANCE = emit_api_python().unit_type().resistance
+
+        if numeric_version >= 241:
+            emi_cat_filter = emit_api_python().emi_category_filter()
+            EmiCategoryFilter.IN_CHANNEL_TX_FUNDAMENTAL = emi_cat_filter.in_channel_tx_fundamental
+            EmiCategoryFilter.IN_CHANNEL_TX_HARMONIC_SPURIOUS = emi_cat_filter.in_channel_tx_harmonic_spurious
+            EmiCategoryFilter.IN_CHANNEL_TX_INTERMOD = emi_cat_filter.in_channel_tx_intermod
+            EmiCategoryFilter.IN_CHANNEL_TX_BROADBAND = emi_cat_filter.in_channel_tx_broadband
+            EmiCategoryFilter.OUT_OF_CHANNEL_TX_FUNDAMENTAL = emi_cat_filter.out_of_channel_tx_fundamental
+            EmiCategoryFilter.OUT_OF_CHANNEL_TX_HARMONIC_SPURIOUS = emi_cat_filter.out_of_channel_tx_harmonic_spurious
+            EmiCategoryFilter.OUT_OF_CHANNEL_TX_INTERMOD = emi_cat_filter.out_of_channel_tx_intermod
 
 
 # need this as a function so that it can be set

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

@@ -76,14 +76,111 @@ class UnitType(MutableEnum):
 EMIT_VALID_UNITS = {
     "Power": ["mW", "W", "kW", "dBm", "dBW"],
     "Frequency": ["Hz", "kHz", "MHz", "GHz", "THz"],
-    "Length": ["pm", "nm", "um", "mm", "cm", "dm", "meter", "km", "mil", "in", "ft", "yd", "mile"],
+    "Length": ["pm", "nm", "um", "mm", "cm", "dm", "meter", "meters", "km", "mil", "in", "ft", "yd", "mile"],
     "Time": ["ps", "ns", "us", "ms", "s"],
-    "Voltage": ["mV", "V"],
+    "Voltage": ["nV", "uV", "mV", "V", "kV", "MegV"],
     "Data Rate": ["bps", "kbps", "Mbps", "Gbps"],
     "Resistance": ["uOhm", "mOhm", "Ohm", "kOhm", "megOhm", "GOhm"],
 }
 """Valid units for each unit type."""
 
+EMIT_INTERNAL_UNITS = {
+    "Power": "dBm",
+    "Freq": "Hz",
+    "Length": "meter",
+    "Time": "s",
+    "Voltage": "V",
+    "Data Rate": "bps",
+    "Resistance": "ohm",
+}
+"""Default units for each unit type."""
+
+EMIT_TO_AEDT_UNITS = {
+    "picometers": "pm",
+    "nanometers": "nm",
+    "micrometers": "um",
+    "millimeters": "mm",
+    "centimeters": "cm",
+    "decimeters": "dm",
+    "meters": "meter",
+    "kilometers": "km",
+    "inches": "in",
+    "mils": "mil",
+    "feet": "ft",
+    "yards": "yd",
+    "miles": "mile",
+    "hertz": "Hz",
+    "kilohertz": "kHz",
+    "megahertz": "MHz",
+    "gigahertz": "GHz",
+    "terahertz": "THz",
+    "picoseconds": "ps",
+    "nanoseconds": "ns",
+    "microseconds": "us",
+    "milliseconds": "ms",
+    "seconds": "s",
+    "microohms": "uOhm",
+    "milliohms": "mOhm",
+    "ohms": "ohm",
+    "kiloohms": "kOhm",
+    "megaohms": "megohm",
+    "gigaohms": "GOhm",
+    "dBm": "dBm",
+    "dBW": "dBW",
+    "watts": "W",
+    "milliwatts": "mW",
+    "kilowatts": "kW",
+    "nanovolts": "nV",
+    "microvolts": "uV",
+    "millivolts": "mV",
+    "volts": "V",
+    "kilovolts": "kV",
+    "megavolts": "MegV",
+    "bps": "bps",
+    "kbps": "kbps",
+    "Mbps": "Mbps",
+    "Gbps": "Gbps",
+}
+
+
+def data_rate_conv(value: float, units: str, to_internal: bool = True):
+    """Converts the data rate to (from) the internal units from the
+    specified units.
+
+    Args:
+        value (float): numeric value of the data rate
+        units (str): units to convert to (from)
+        to_internal (bool, optional): Converts from the specified units
+            to the internal units OR from the internal units to the
+            specified units. Defaults to True.
+
+    Returns:
+        value: data rate converted to/from the internal units
+    """
+    mult = 1.0
+
+    if units not in ("bps", "kbps", "Mbps", "Gbps"):
+        raise ValueError(f"{units} are not valid units for data rate.")
+    if to_internal:
+        if units == "bps":
+            mult = 1.0
+        elif units == "kbps":
+            mult = 1e-3
+        elif units == "Mbps":
+            mult = 1e-6
+        elif units == "Gbps":
+            mult = 1e-9
+    else:
+        if units == "bps":
+            mult = 1.0
+        elif units == "kbps":
+            mult = 1e3
+        elif units == "Mbps":
+            mult = 1e6
+        elif units == "Gbps":
+            mult = 1e9
+    return value * mult
+
 
 def emit_unit_type_string_to_enum(unit_string):
     EMIT_UNIT_TYPE_STRING_TO_ENUM = {
@@ -98,6 +195,19 @@ def emit_unit_type_string_to_enum(unit_string):
     return EMIT_UNIT_TYPE_STRING_TO_ENUM[unit_string]
 
 
+def emi_cat_enum_to_string(emi_cat_enum):
+    EMI_CAT_ENUM_TO_STR = {
+        EmiCategoryFilter.IN_CHANNEL_TX_FUNDAMENTAL: "In-Channel Tx Fundamental",
+        EmiCategoryFilter.IN_CHANNEL_TX_HARMONIC_SPURIOUS: "In-Channel Tx Harmonic/Spurious",
+        EmiCategoryFilter.IN_CHANNEL_TX_INTERMOD: "In-Channel Intermod",
+        EmiCategoryFilter.IN_CHANNEL_TX_BROADBAND: "In-Channel Broadband",
+        EmiCategoryFilter.OUT_OF_CHANNEL_TX_FUNDAMENTAL: "Out-of-Channel Tx Fundamental",
+        EmiCategoryFilter.OUT_OF_CHANNEL_TX_HARMONIC_SPURIOUS: "Out-of-Channel Tx Harmonic/Spurious",
+        EmiCategoryFilter.OUT_OF_CHANNEL_TX_INTERMOD: "Out-of-Channel Intermod",
+    }
+    return EMI_CAT_ENUM_TO_STR[emi_cat_enum]
+
+
 class EmiCategoryFilter(MutableEnum):
     IN_CHANNEL_TX_FUNDAMENTAL = None
     IN_CHANNEL_TX_HARMONIC_SPURIOUS = None