From aa3f648560c4c1e6739a6371792c093a58d8187e Mon Sep 17 00:00:00 2001 From: Ramin Aghajafari <153928265+ramin4667@users.noreply.github.com> Date: Thu, 14 Nov 2024 02:11:53 -0500 Subject: [PATCH] FIX: FilterSolutions Sphinx Update (#5425) --- doc/source/API/Application.rst | 1 - doc/source/API/FilterSolutions.rst | 41 ++++++++++++++++++++++++++ doc/source/API/index.rst | 2 +- src/ansys/aedt/core/filtersolutions.py | 2 +- 4 files changed, 43 insertions(+), 3 deletions(-) create mode 100644 doc/source/API/FilterSolutions.rst diff --git a/doc/source/API/Application.rst b/doc/source/API/Application.rst index d7ad0ed6724..74951455342 100644 --- a/doc/source/API/Application.rst +++ b/doc/source/API/Application.rst @@ -27,7 +27,6 @@ Available PyAEDT apps are: ansys.aedt.core.maxwellcircuit.MaxwellCircuit ansys.aedt.core.emit.Emit ansys.aedt.core.twinbuilder.TwinBuilder - ansys.aedt.core.filtersolutions.FilterSolutions All other classes and methods are inherited into the app class. diff --git a/doc/source/API/FilterSolutions.rst b/doc/source/API/FilterSolutions.rst new file mode 100644 index 00000000000..d8b84f5a181 --- /dev/null +++ b/doc/source/API/FilterSolutions.rst @@ -0,0 +1,41 @@ +Filter solutions +========================== +The ``FilterSolutions`` module contains all classes needed to create and edit an object including. + + +* ``Attributes`` to defines attributes and parameters of filters. +* ``DllInterface`` to interface with the FilterSolutions DLL. +* ``GraphSetup`` to define the frequency and time limits of the exported responses. +* ``IdealResponse`` to return the data for available ideal filter responses. +* ``MultipleBandsTable`` to manipulate access to the entries of multiple bands table. +* ``TransmissionZeros`` to manipulates access to ratio and bandwidth entries in the transmission zeros table. +* ``LumpedTopology`` to define attributes and parameters of filters implemented with lumped topology. +* ``LumpedParasitics`` to define attributes of the lumped element parasitic values. +* ``LumpedNodesandLeads`` to define attributes of the lumped node capacitors and lead inductors. +* ``LumpedTerminationImpedance`` to manipulate access to the entries of source and load complex impedance table. +* ``ExportToAedt`` to define attributes and parameters of the export page for exporting to AEDT. +* ``OptimizationGoalsTable`` to manipulate access to the entries of the optimization goals table. + + + +They are accessible through: + + +.. currentmodule:: ansys.aedt.core.filtersolutions_core + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + attributes.Attributes + dll_interface.DllInterface + graph_setup.GraphSetup + ideal_response.IdealResponse + multiple_bands_table.MultipleBandsTable + transmission_zeros.TransmissionZeros + lumped_topology.LumpedTopology + lumped_parasitics.LumpedParasitics + lumped_nodes_and_leads.LumpedNodesandLeads + lumped_termination_impedance_table.LumpedTerminationImpedance + export_to_aedt.ExportToAedt + optimization_goals_table.OptimizationGoalsTable diff --git a/doc/source/API/index.rst b/doc/source/API/index.rst index 0d7dbde7ad4..c97cddcdc19 100644 --- a/doc/source/API/index.rst +++ b/doc/source/API/index.rst @@ -98,7 +98,7 @@ Example with ``Desktop`` class implicit initialization: Configuration SetupTemplates CableModeling - + FilterSolutions diff --git a/src/ansys/aedt/core/filtersolutions.py b/src/ansys/aedt/core/filtersolutions.py index 4b65297c319..df733dc0fae 100644 --- a/src/ansys/aedt/core/filtersolutions.py +++ b/src/ansys/aedt/core/filtersolutions.py @@ -40,7 +40,7 @@ class FilterSolutions: - """Provides the ``FilterSolutions`` application interface. + """Provides the FilterSolutions application interface. This class has access to ideal filter attributes and calculated output parameters.