Fix all docstrings in generated EMIT classes

Author: bryankaylor

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

@@ -1,35 +1,11 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
-# SPDX-License-Identifier: MIT
-#
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
 from .amplifier import Amplifier
 from .antenna_node import AntennaNode
 from .antenna_passband import AntennaPassband
 from .band import Band
 from .band_folder import BandFolder
 from .band_trace_node import BandTraceNode
-from .cable import Cable
 from .cad_node import CADNode
+from .cable import Cable
 from .categories_view_node import CategoriesViewNode
 from .circulator import Circulator
 from .coupling_link_node import CouplingLinkNode
@@ -57,13 +33,44 @@
 from .profile_trace_node import ProfileTraceNode
 from .propagation_loss_coupling_node import PropagationLossCouplingNode
 from .radio_node import RadioNode
+from .result_plot_node import ResultPlotNode
+from .rx_meas_node import RxMeasNode
+from .rx_mixer_product_node import RxMixerProductNode
+from .rx_saturation_node import RxSaturationNode
+from .rx_selectivity_node import RxSelectivityNode
+from .rx_spur_node import RxSpurNode
+from .rx_susceptibility_prof_node import RxSusceptibilityProfNode
+from .sampling_node import SamplingNode
+from .scene_group_node import SceneGroupNode
+from .selectivity_trace_node import SelectivityTraceNode
+from .solution_coupling_node import SolutionCouplingNode
+from .solutions_node import SolutionsNode
+from .spur_trace_node import SpurTraceNode
+from .tr_switch import TR_Switch
+from .tr_switch_trace_node import TRSwitchTraceNode
+from .terminator import Terminator
+from .test_noise_trace_node import TestNoiseTraceNode
+from .top_level_simulation import TopLevelSimulation
+from .touchstone_coupling_node import TouchstoneCouplingNode
+from .tunable_trace_node import TunableTraceNode
+from .two_ray_path_loss_coupling_node import TwoRayPathLossCouplingNode
+from .two_tone_trace_node import TwoToneTraceNode
+from .tx_bb_emission_node import TxBbEmissionNode
+from .tx_harmonic_node import TxHarmonicNode
+from .tx_meas_node import TxMeasNode
+from .tx_nb_emission_node import TxNbEmissionNode
+from .tx_spectral_prof_emitter_node import TxSpectralProfEmitterNode
+from .tx_spectral_prof_node import TxSpectralProfNode
+from .tx_spur_node import TxSpurNode
+from .walfisch_coupling_node import WalfischCouplingNode
+from .waveform import Waveform
 from .read_only_amplifier import ReadOnlyAmplifier
 from .read_only_antenna_node import ReadOnlyAntennaNode
 from .read_only_antenna_passband import ReadOnlyAntennaPassband
 from .read_only_band import ReadOnlyBand
 from .read_only_band_folder import ReadOnlyBandFolder
-from .read_only_cable import ReadOnlyCable
 from .read_only_cad_node import ReadOnlyCADNode
+from .read_only_cable import ReadOnlyCable
 from .read_only_circulator import ReadOnlyCirculator
 from .read_only_coupling_link_node import ReadOnlyCouplingLinkNode
 from .read_only_couplings_node import ReadOnlyCouplingsNode
@@ -91,9 +98,9 @@
 from .read_only_scene_group_node import ReadOnlySceneGroupNode
 from .read_only_solution_coupling_node import ReadOnlySolutionCouplingNode
 from .read_only_solutions_node import ReadOnlySolutionsNode
+from .read_only_tr_switch import ReadOnlyTR_Switch
 from .read_only_terminator import ReadOnlyTerminator
 from .read_only_touchstone_coupling_node import ReadOnlyTouchstoneCouplingNode
-from .read_only_tr_switch import ReadOnlyTR_Switch
 from .read_only_two_ray_path_loss_coupling_node import ReadOnlyTwoRayPathLossCouplingNode
 from .read_only_tx_bb_emission_node import ReadOnlyTxBbEmissionNode
 from .read_only_tx_harmonic_node import ReadOnlyTxHarmonicNode
@@ -104,150 +111,119 @@
 from .read_only_tx_spur_node import ReadOnlyTxSpurNode
 from .read_only_walfisch_coupling_node import ReadOnlyWalfischCouplingNode
 from .read_only_waveform import ReadOnlyWaveform
-from .result_plot_node import ResultPlotNode
-from .rx_meas_node import RxMeasNode
-from .rx_mixer_product_node import RxMixerProductNode
-from .rx_saturation_node import RxSaturationNode
-from .rx_selectivity_node import RxSelectivityNode
-from .rx_spur_node import RxSpurNode
-from .rx_susceptibility_prof_node import RxSusceptibilityProfNode
-from .sampling_node import SamplingNode
-from .scene_group_node import SceneGroupNode
-from .selectivity_trace_node import SelectivityTraceNode
-from .solution_coupling_node import SolutionCouplingNode
-from .solutions_node import SolutionsNode
-from .spur_trace_node import SpurTraceNode
-from .terminator import Terminator
-from .test_noise_trace_node import TestNoiseTraceNode
-from .top_level_simulation import TopLevelSimulation
-from .touchstone_coupling_node import TouchstoneCouplingNode
-from .tr_switch import TR_Switch
-from .tr_switch_trace_node import TRSwitchTraceNode
-from .tunable_trace_node import TunableTraceNode
-from .two_ray_path_loss_coupling_node import TwoRayPathLossCouplingNode
-from .two_tone_trace_node import TwoToneTraceNode
-from .tx_bb_emission_node import TxBbEmissionNode
-from .tx_harmonic_node import TxHarmonicNode
-from .tx_meas_node import TxMeasNode
-from .tx_nb_emission_node import TxNbEmissionNode
-from .tx_spectral_prof_emitter_node import TxSpectralProfEmitterNode
-from .tx_spectral_prof_node import TxSpectralProfNode
-from .tx_spur_node import TxSpurNode
-from .walfisch_coupling_node import WalfischCouplingNode
-from .waveform import Waveform
 
 __all__ = [
-    "Amplifier",
-    "AntennaNode",
-    "AntennaPassband",
-    "Band",
-    "BandFolder",
-    "BandTraceNode",
-    "CADNode",
-    "Cable",
-    "CategoriesViewNode",
-    "Circulator",
-    "CouplingLinkNode",
-    "CouplingTraceNode",
-    "CouplingsNode",
-    "CustomCouplingNode",
-    "EmiPlotMarkerNode",
-    "EmitSceneNode",
-    "ErcegCouplingNode",
-    "Filter",
-    "FiveGChannelModel",
-    "HataCouplingNode",
-    "IndoorPropagationCouplingNode",
-    "Isolator",
-    "LogDistanceCouplingNode",
-    "MPlexBandTraceNode",
-    "Multiplexer",
-    "MultiplexerBand",
-    "OutboardTraceNode",
-    "ParametricCouplingTraceNode",
-    "PlotMarkerNode",
-    "PlotNode",
-    "PowerDivider",
-    "PowerTraceNode",
-    "ProfileTraceNode",
-    "PropagationLossCouplingNode",
-    "RadioNode",
-    "ResultPlotNode",
-    "RxMeasNode",
-    "RxMixerProductNode",
-    "RxSaturationNode",
-    "RxSelectivityNode",
-    "RxSpurNode",
-    "RxSusceptibilityProfNode",
-    "SamplingNode",
-    "SceneGroupNode",
-    "SelectivityTraceNode",
-    "SolutionCouplingNode",
-    "SolutionsNode",
-    "SpurTraceNode",
-    "TR_Switch",
-    "TRSwitchTraceNode",
-    "Terminator",
-    "TestNoiseTraceNode",
-    "TopLevelSimulation",
-    "TouchstoneCouplingNode",
-    "TunableTraceNode",
-    "TwoRayPathLossCouplingNode",
-    "TwoToneTraceNode",
-    "TxBbEmissionNode",
-    "TxHarmonicNode",
-    "TxMeasNode",
-    "TxNbEmissionNode",
-    "TxSpectralProfEmitterNode",
-    "TxSpectralProfNode",
-    "TxSpurNode",
-    "WalfischCouplingNode",
-    "Waveform",
-    "ReadOnlyAmplifier",
-    "ReadOnlyAntennaNode",
-    "ReadOnlyAntennaPassband",
-    "ReadOnlyBand",
-    "ReadOnlyBandFolder",
-    "ReadOnlyCADNode",
-    "ReadOnlyCable",
-    "ReadOnlyCirculator",
-    "ReadOnlyCouplingLinkNode",
-    "ReadOnlyCouplingsNode",
-    "ReadOnlyCustomCouplingNode",
-    "ReadOnlyEmitSceneNode",
-    "ReadOnlyErcegCouplingNode",
-    "ReadOnlyFilter",
-    "ReadOnlyFiveGChannelModel",
-    "ReadOnlyHataCouplingNode",
-    "ReadOnlyIndoorPropagationCouplingNode",
-    "ReadOnlyIsolator",
-    "ReadOnlyLogDistanceCouplingNode",
-    "ReadOnlyMultiplexer",
-    "ReadOnlyMultiplexerBand",
-    "ReadOnlyPowerDivider",
-    "ReadOnlyPropagationLossCouplingNode",
-    "ReadOnlyRadioNode",
-    "ReadOnlyRxMeasNode",
-    "ReadOnlyRxMixerProductNode",
-    "ReadOnlyRxSaturationNode",
-    "ReadOnlyRxSelectivityNode",
-    "ReadOnlyRxSpurNode",
-    "ReadOnlyRxSusceptibilityProfNode",
-    "ReadOnlySamplingNode",
-    "ReadOnlySceneGroupNode",
-    "ReadOnlySolutionCouplingNode",
-    "ReadOnlySolutionsNode",
-    "ReadOnlyTR_Switch",
-    "ReadOnlyTerminator",
-    "ReadOnlyTouchstoneCouplingNode",
-    "ReadOnlyTwoRayPathLossCouplingNode",
-    "ReadOnlyTxBbEmissionNode",
-    "ReadOnlyTxHarmonicNode",
-    "ReadOnlyTxMeasNode",
-    "ReadOnlyTxNbEmissionNode",
-    "ReadOnlyTxSpectralProfEmitterNode",
-    "ReadOnlyTxSpectralProfNode",
-    "ReadOnlyTxSpurNode",
-    "ReadOnlyWalfischCouplingNode",
-    "ReadOnlyWaveform",
+  'Amplifier',
+  'AntennaNode',
+  'AntennaPassband',
+  'Band',
+  'BandFolder',
+  'BandTraceNode',
+  'CADNode',
+  'Cable',
+  'CategoriesViewNode',
+  'Circulator',
+  'CouplingLinkNode',
+  'CouplingTraceNode',
+  'CouplingsNode',
+  'CustomCouplingNode',
+  'EmiPlotMarkerNode',
+  'EmitSceneNode',
+  'ErcegCouplingNode',
+  'Filter',
+  'FiveGChannelModel',
+  'HataCouplingNode',
+  'IndoorPropagationCouplingNode',
+  'Isolator',
+  'LogDistanceCouplingNode',
+  'MPlexBandTraceNode',
+  'Multiplexer',
+  'MultiplexerBand',
+  'OutboardTraceNode',
+  'ParametricCouplingTraceNode',
+  'PlotMarkerNode',
+  'PlotNode',
+  'PowerDivider',
+  'PowerTraceNode',
+  'ProfileTraceNode',
+  'PropagationLossCouplingNode',
+  'RadioNode',
+  'ResultPlotNode',
+  'RxMeasNode',
+  'RxMixerProductNode',
+  'RxSaturationNode',
+  'RxSelectivityNode',
+  'RxSpurNode',
+  'RxSusceptibilityProfNode',
+  'SamplingNode',
+  'SceneGroupNode',
+  'SelectivityTraceNode',
+  'SolutionCouplingNode',
+  'SolutionsNode',
+  'SpurTraceNode',
+  'TR_Switch',
+  'TRSwitchTraceNode',
+  'Terminator',
+  'TestNoiseTraceNode',
+  'TopLevelSimulation',
+  'TouchstoneCouplingNode',
+  'TunableTraceNode',
+  'TwoRayPathLossCouplingNode',
+  'TwoToneTraceNode',
+  'TxBbEmissionNode',
+  'TxHarmonicNode',
+  'TxMeasNode',
+  'TxNbEmissionNode',
+  'TxSpectralProfEmitterNode',
+  'TxSpectralProfNode',
+  'TxSpurNode',
+  'WalfischCouplingNode',
+  'Waveform',
+  'ReadOnlyAmplifier',
+  'ReadOnlyAntennaNode',
+  'ReadOnlyAntennaPassband',
+  'ReadOnlyBand',
+  'ReadOnlyBandFolder',
+  'ReadOnlyCADNode',
+  'ReadOnlyCable',
+  'ReadOnlyCirculator',
+  'ReadOnlyCouplingLinkNode',
+  'ReadOnlyCouplingsNode',
+  'ReadOnlyCustomCouplingNode',
+  'ReadOnlyEmitSceneNode',
+  'ReadOnlyErcegCouplingNode',
+  'ReadOnlyFilter',
+  'ReadOnlyFiveGChannelModel',
+  'ReadOnlyHataCouplingNode',
+  'ReadOnlyIndoorPropagationCouplingNode',
+  'ReadOnlyIsolator',
+  'ReadOnlyLogDistanceCouplingNode',
+  'ReadOnlyMultiplexer',
+  'ReadOnlyMultiplexerBand',
+  'ReadOnlyPowerDivider',
+  'ReadOnlyPropagationLossCouplingNode',
+  'ReadOnlyRadioNode',
+  'ReadOnlyRxMeasNode',
+  'ReadOnlyRxMixerProductNode',
+  'ReadOnlyRxSaturationNode',
+  'ReadOnlyRxSelectivityNode',
+  'ReadOnlyRxSpurNode',
+  'ReadOnlyRxSusceptibilityProfNode',
+  'ReadOnlySamplingNode',
+  'ReadOnlySceneGroupNode',
+  'ReadOnlySolutionCouplingNode',
+  'ReadOnlySolutionsNode',
+  'ReadOnlyTR_Switch',
+  'ReadOnlyTerminator',
+  'ReadOnlyTouchstoneCouplingNode',
+  'ReadOnlyTwoRayPathLossCouplingNode',
+  'ReadOnlyTxBbEmissionNode',
+  'ReadOnlyTxHarmonicNode',
+  'ReadOnlyTxMeasNode',
+  'ReadOnlyTxNbEmissionNode',
+  'ReadOnlyTxSpectralProfEmitterNode',
+  'ReadOnlyTxSpectralProfNode',
+  'ReadOnlyTxSpurNode',
+  'ReadOnlyWalfischCouplingNode',
+  'ReadOnlyWaveform',
 ]