From c0e3c297a552588761845e87ea004c1450f751d9 Mon Sep 17 00:00:00 2001 From: SMoraisAnsys <146729917+SMoraisAnsys@users.noreply.github.com> Date: Mon, 11 Dec 2023 19:27:38 +0100 Subject: [PATCH] D335: Open sourcing process: use ansys-api-edb (#334) * REFACT: remove proto files * REFACT: update build deps and use ansys-api-edb * MISC: update project name and description * REFACT: architecture renaming Changes: - use ansys.edb.core instead of ansys.edb - use ansys.api.edb instead of files from local protos * MISC: update licence year * MISC: set optional dependencies in pyproject.toml Changes: - remove all requirements files - add project.optional-dependencies : notebook, tests, doc - update README.rest, tox.ini and ci_cd.yml accordingly * MISC: update pre-commit config Changes: - use newer repo revisions - add common pyansys repo * MISC: fix codespell pre-commit Changes are to leverage common pyansys file directory structure * CI: add twine install to build job * MISC: disable licence pre-commit * MISC: exclude notebooks from codespell hook * MISC: pass pre-commit hooks Changes: - sort imports - format using black - format to match flake8 - format some docstring to match pydocstyle - trim trailing whitespace (and exclude files) * CI: fix workflows The main issue we had was to retrieve `ansys-api-edb`. It is now accessible through private pypi. Changes: - use PIP_EXTRA_INDEX_URL to leverage private pypi - remove python3.7 from CI and tox.ini - fix doc-build deps - fix tox.ini by installing with .[tests] - change project extra deps to be compatible with private pypi * CI: update new doc cname --- .github/workflows/ci_cd.yml | 51 ++- .pre-commit-config.yaml | 65 ++-- LICENSE | 2 +- README.rst | 20 +- doc/make.bat | 2 +- doc/source/_templates/sidebar-nav-bs.html | 2 +- doc/source/api/database.rst | 2 +- doc/source/api/definition.rst | 2 +- doc/source/api/geometry.rst | 4 +- doc/source/api/glossary.rst | 22 +- doc/source/api/hierarchy.rst | 6 +- doc/source/api/layer.rst | 4 +- doc/source/api/layout.rst | 6 +- doc/source/api/layout_instance.rst | 2 +- doc/source/api/net.rst | 4 +- doc/source/api/primitive.rst | 2 +- doc/source/api/session.rst | 2 +- doc/source/api/simulation_setup.rst | 2 +- doc/source/api/terminal.rst | 4 +- doc/source/api/utility.rst | 2 +- doc/source/conf.py | 2 +- doc/source/index.rst | 2 +- doc/styles/{Ansys => Vocab/ANSYS}/accept.txt | 0 doc/styles/{Ansys => Vocab/ANSYS}/reject.txt | 0 notebooks/3d_comp_placement.ipynb | 2 +- notebooks/helpers/example_setup.ipynb | 26 +- protos/README.rst | 7 - protos/ansys/api/edb/v1/VERSION | 1 - protos/ansys/api/edb/v1/__init__.py | 1 - protos/ansys/api/edb/v1/_version.py | 2 - protos/ansys/api/edb/v1/arc_data.proto | 67 ---- protos/ansys/api/edb/v1/board_bend_def.proto | 37 --- protos/ansys/api/edb/v1/bondwire.proto | 165 ---------- protos/ansys/api/edb/v1/bondwire_def.proto | 89 ------ protos/ansys/api/edb/v1/bundle_term.proto | 14 - protos/ansys/api/edb/v1/cell.proto | 141 --------- protos/ansys/api/edb/v1/cell_instance.proto | 58 ---- protos/ansys/api/edb/v1/circle.proto | 53 ---- protos/ansys/api/edb/v1/component_def.proto | 43 --- protos/ansys/api/edb/v1/component_group.proto | 48 --- protos/ansys/api/edb/v1/component_model.proto | 35 --- protos/ansys/api/edb/v1/component_pin.proto | 30 -- .../ansys/api/edb/v1/component_property.proto | 33 -- protos/ansys/api/edb/v1/connectable.proto | 54 ---- protos/ansys/api/edb/v1/database.proto | 120 ------- protos/ansys/api/edb/v1/dataset_def.proto | 28 -- protos/ansys/api/edb/v1/debye_model.proto | 44 --- protos/ansys/api/edb/v1/definition_obj.proto | 18 -- protos/ansys/api/edb/v1/die_property.proto | 55 ---- .../edb/v1/dielectric_material_model.proto | 13 - .../ansys/api/edb/v1/differential_pair.proto | 33 -- .../api/edb/v1/djordjecvic_sarkar_model.proto | 31 -- protos/ansys/api/edb/v1/edb_defs.proto | 64 ---- protos/ansys/api/edb/v1/edb_messages.proto | 216 ------------- protos/ansys/api/edb/v1/edge_term.proto | 73 ----- protos/ansys/api/edb/v1/extended_net.proto | 34 -- protos/ansys/api/edb/v1/group.proto | 49 --- .../api/edb/v1/hfss_simulation_settings.proto | 223 ------------- .../api/edb/v1/hfss_simulation_setup.proto | 58 ---- protos/ansys/api/edb/v1/hierarchy_obj.proto | 56 ---- .../api/edb/v1/ic_component_property.proto | 27 -- protos/ansys/api/edb/v1/inst_array.proto | 43 --- .../api/edb/v1/io_component_property.proto | 23 -- protos/ansys/api/edb/v1/layer.proto | 213 ------------- .../ansys/api/edb/v1/layer_collection.proto | 189 ----------- protos/ansys/api/edb/v1/layer_map.proto | 43 --- protos/ansys/api/edb/v1/layout.proto | 91 ------ protos/ansys/api/edb/v1/layout_instance.proto | 54 ---- .../api/edb/v1/layout_instance_context.proto | 26 -- protos/ansys/api/edb/v1/layout_obj.proto | 67 ---- .../api/edb/v1/layout_obj_instance.proto | 33 -- .../v1/layout_obj_instance_2d_geometry.proto | 20 -- .../v1/layout_obj_instance_3d_geometry.proto | 23 -- .../edb/v1/layout_obj_instance_geometry.proto | 19 -- protos/ansys/api/edb/v1/material_def.proto | 152 --------- .../material_property_thermal_modifier.proto | 26 -- protos/ansys/api/edb/v1/mcad_model.proto | 98 ------ protos/ansys/api/edb/v1/model.proto | 21 -- .../api/edb/v1/multipole_debye_model.proto | 27 -- protos/ansys/api/edb/v1/net.proto | 33 -- protos/ansys/api/edb/v1/netclass.proto | 42 --- protos/ansys/api/edb/v1/netlist_model.proto | 13 - protos/ansys/api/edb/v1/package_def.proto | 65 ---- protos/ansys/api/edb/v1/padstack_def.proto | 35 --- .../ansys/api/edb/v1/padstack_def_data.proto | 241 -------------- .../ansys/api/edb/v1/padstack_inst_term.proto | 33 -- .../ansys/api/edb/v1/padstack_instance.proto | 180 ----------- protos/ansys/api/edb/v1/path.proto | 154 --------- protos/ansys/api/edb/v1/pin_group.proto | 44 --- protos/ansys/api/edb/v1/pin_group_term.proto | 37 --- protos/ansys/api/edb/v1/pin_pair_model.proto | 27 -- protos/ansys/api/edb/v1/point_3d_data.proto | 45 --- protos/ansys/api/edb/v1/point_data.proto | 70 ----- protos/ansys/api/edb/v1/point_term.proto | 35 --- protos/ansys/api/edb/v1/polygon.proto | 35 --- protos/ansys/api/edb/v1/polygon_data.proto | 133 -------- .../edb/v1/port_post_processing_prop.proto | 17 - protos/ansys/api/edb/v1/port_property.proto | 25 -- protos/ansys/api/edb/v1/primitive.proto | 106 ------- protos/ansys/api/edb/v1/r_tree.proto | 68 ---- .../edb/v1/raptor_x_simulation_settings.proto | 121 ------- protos/ansys/api/edb/v1/rectangle.proto | 69 ---- protos/ansys/api/edb/v1/refs.proto | 33 -- protos/ansys/api/edb/v1/rlc.proto | 17 - .../api/edb/v1/rlc_component_property.proto | 19 -- .../api/edb/v1/simulation_settings.proto | 107 ------- .../ansys/api/edb/v1/simulation_setup.proto | 48 --- .../v1/siwave_dcir_simulation_settings.proto | 53 ---- .../edb/v1/siwave_simulation_settings.proto | 207 ------------ .../api/edb/v1/solder_ball_property.proto | 39 --- .../ansys/api/edb/v1/sparameter_model.proto | 21 -- protos/ansys/api/edb/v1/spice_model.proto | 32 -- protos/ansys/api/edb/v1/stackup_layer.proto | 172 ---------- protos/ansys/api/edb/v1/structure3d.proto | 55 ---- protos/ansys/api/edb/v1/term.proto | 138 -------- protos/ansys/api/edb/v1/term_inst.proto | 25 -- protos/ansys/api/edb/v1/term_inst_term.proto | 27 -- protos/ansys/api/edb/v1/text.proto | 42 --- protos/ansys/api/edb/v1/transform.proto | 55 ---- protos/ansys/api/edb/v1/transform3d.proto | 58 ---- protos/ansys/api/edb/v1/value.proto | 21 -- protos/ansys/api/edb/v1/variable_server.proto | 63 ---- protos/ansys/api/edb/v1/via_group.proto | 45 --- protos/ansys/api/edb/v1/via_layer.proto | 37 --- .../ansys/api/edb/v1/voltage_regulator.proto | 78 ----- protos/requirements/requirements_build.txt | 5 - protos/setup.py | 97 ------ pyproject.toml | 58 +++- requirements/requirements_build.txt | 3 - requirements/requirements_doc.txt | 4 - requirements/requirements_notebook.txt | 3 - requirements/requirements_tests.txt | 4 - requirements/requirements_tox.txt | 3 - src/ansys/edb/__init__.py | 8 - src/ansys/edb/core/__init__.py | 12 +- src/ansys/edb/{ => core}/database.py | 56 ++-- src/ansys/edb/core/definition/__init__.py | 46 +++ .../edb/{ => core}/definition/bondwire_def.py | 38 +-- .../{ => core}/definition/component_def.py | 24 +- .../{ => core}/definition/component_model.py | 8 +- .../{ => core}/definition/component_pin.py | 12 +- .../definition/component_property.py | 19 +- .../edb/{ => core}/definition/dataset_def.py | 18 +- .../edb/{ => core}/definition/debye_model.py | 6 +- .../edb/{ => core}/definition/die_property.py | 8 +- .../definition/dielectric_material_model.py | 4 +- .../definition/djordjecvic_sarkar_model.py | 6 +- .../definition/ic_component_property.py | 6 +- .../definition/io_component_property.py | 6 +- .../edb/{ => core}/definition/material_def.py | 27 +- .../material_property_thermal_modifier.py | 18 +- .../definition/multipole_debye_model.py | 6 +- .../edb/{ => core}/definition/package_def.py | 30 +- .../edb/{ => core}/definition/padstack_def.py | 18 +- .../definition/padstack_def_data.py | 54 ++-- .../{ => core}/definition/port_property.py | 12 +- .../definition/rlc_component_property.py | 6 +- .../definition/solder_ball_property.py | 18 +- src/ansys/edb/{ => core}/edb_defs.py | 0 src/ansys/edb/core/geometry/__init__.py | 8 + src/ansys/edb/{ => core}/geometry/arc_data.py | 16 +- .../edb/{ => core}/geometry/point3d_data.py | 8 +- .../edb/{ => core}/geometry/point_data.py | 32 +- .../edb/{ => core}/geometry/polygon_data.py | 46 +-- src/ansys/edb/{ => core}/geometry/r_tree.py | 10 +- .../{ => core}/geometry/triangle3d_data.py | 0 src/ansys/edb/core/hierarchy/__init__.py | 14 + .../edb/{ => core}/hierarchy/cell_instance.py | 35 ++- .../{ => core}/hierarchy/component_group.py | 22 +- src/ansys/edb/{ => core}/hierarchy/group.py | 16 +- .../edb/{ => core}/hierarchy/hierarchy_obj.py | 27 +- .../edb/{ => core}/hierarchy/inst_array.py | 30 +- src/ansys/edb/{ => core}/hierarchy/model.py | 4 +- .../edb/{ => core}/hierarchy/netlist_model.py | 6 +- .../edb/{ => core}/hierarchy/pin_group.py | 23 +- .../{ => core}/hierarchy/pin_pair_model.py | 10 +- .../{ => core}/hierarchy/sparameter_model.py | 6 +- .../edb/{ => core}/hierarchy/spice_model.py | 6 +- .../edb/{ => core}/hierarchy/structure3d.py | 12 +- .../edb/{ => core}/hierarchy/via_group.py | 24 +- src/ansys/edb/core/inner/__init__.py | 8 + src/ansys/edb/core/{ => inner}/base.py | 0 src/ansys/edb/core/{ => inner}/conn_obj.py | 35 ++- src/ansys/edb/core/{ => inner}/decorators.py | 0 src/ansys/edb/core/{ => inner}/edb_logging.py | 4 +- src/ansys/edb/core/{ => inner}/exceptions.py | 0 src/ansys/edb/core/{ => inner}/factory.py | 14 +- .../edb/core/{ => inner}/interceptors.py | 2 +- src/ansys/edb/core/{ => inner}/layout_obj.py | 20 +- src/ansys/edb/core/{ => inner}/messages.py | 6 +- src/ansys/edb/core/{ => inner}/parser.py | 2 +- src/ansys/edb/core/{ => inner}/utils.py | 0 .../edb/core/{ => inner}/variable_server.py | 48 +-- src/ansys/edb/core/layer/__init__.py | 17 + src/ansys/edb/{ => core}/layer/layer.py | 16 +- .../edb/{ => core}/layer/layer_collection.py | 20 +- .../edb/{ => core}/layer/stackup_layer.py | 17 +- src/ansys/edb/{ => core}/layer/via_layer.py | 4 +- src/ansys/edb/core/layout/__init__.py | 6 + src/ansys/edb/{ => core}/layout/cell.py | 52 ++-- src/ansys/edb/{ => core}/layout/layout.py | 75 ++--- src/ansys/edb/{ => core}/layout/mcad_model.py | 22 +- .../{ => core}/layout/voltage_regulator.py | 26 +- .../edb/core/layout_instance/__init__.py | 12 + .../layout_instance/layout_instance.py | 24 +- .../layout_instance_context.py | 12 +- .../layout_instance/layout_obj_instance.py | 41 ++- .../layout_obj_instance_2d_geometry.py | 8 +- .../layout_obj_instance_3d_geometry.py | 19 +- .../layout_obj_instance_geometry.py | 6 +- src/ansys/edb/core/net/__init__.py | 6 + .../edb/{ => core}/net/differential_pair.py | 20 +- src/ansys/edb/{ => core}/net/extended_net.py | 12 +- src/ansys/edb/{ => core}/net/net.py | 50 +-- src/ansys/edb/{ => core}/net/net_class.py | 16 +- .../edb/{ => core}/primitive/__init__.py | 2 +- .../edb/{ => core}/primitive/primitive.py | 294 +++++++++--------- src/ansys/edb/{ => core}/session.py | 6 +- .../{ => core}/simulation_setup/__init__.py | 26 +- .../simulation_setup/adaptive_solutions.py | 0 .../hfss_simulation_settings.py | 6 +- .../simulation_setup/hfss_simulation_setup.py | 12 +- .../simulation_setup/mesh_operation.py | 0 .../raptor_x_simulation_settings.py | 6 +- .../raptor_x_simulation_setup.py | 6 +- .../simulation_setup/simulation_settings.py | 6 +- .../simulation_setup/simulation_setup.py | 8 +- .../siwave_dcir_simulation_settings.py | 6 +- .../siwave_dcir_simulation_setup.py | 8 +- .../siwave_simulation_settings.py | 6 +- .../siwave_simulation_setup.py | 6 +- src/ansys/edb/{ => core}/terminal/__init__.py | 2 +- .../edb/{ => core}/terminal/terminals.py | 14 +- src/ansys/edb/{ => core}/typing/__init__.py | 4 +- src/ansys/edb/core/utility/__init__.py | 14 + .../edb/{ => core}/utility/conversions.py | 6 +- src/ansys/edb/{ => core}/utility/heat_sink.py | 2 +- .../{ => core}/utility/hfss_extent_info.py | 16 +- src/ansys/edb/{ => core}/utility/layer_map.py | 4 +- ...terial_property_thermal_modifier_params.py | 2 +- .../utility/port_post_processing_prop.py | 2 +- src/ansys/edb/{ => core}/utility/rlc.py | 2 +- .../utility/temperature_settings.py | 2 +- src/ansys/edb/{ => core}/utility/transform.py | 22 +- .../edb/{ => core}/utility/transform3d.py | 8 +- src/ansys/edb/{ => core}/utility/value.py | 11 +- src/ansys/edb/definition/__init__.py | 44 --- src/ansys/edb/geometry/__init__.py | 8 - src/ansys/edb/hierarchy/__init__.py | 14 - src/ansys/edb/layer/__init__.py | 17 - src/ansys/edb/layout/__init__.py | 6 - src/ansys/edb/layout_instance/__init__.py | 8 - src/ansys/edb/net/__init__.py | 6 - src/ansys/edb/utility/__init__.py | 14 - tests/e2e/conftest.py | 10 +- tests/e2e/integration_tests/test_padstack.py | 4 +- .../integration_tests/test_spiral_inductor.py | 30 +- tests/e2e/scratch/sim_setup_scratch.py | 8 +- tests/e2e/scratch/test_board_bend_def.py | 14 +- tests/e2e/scratch/test_component_property.py | 12 +- tests/e2e/scratch/test_power_module.py | 6 +- tests/e2e/scratch/test_value.py | 14 +- tests/mock/test_arc_data.py | 2 +- tests/mock/test_database.py | 6 +- tests/mock/test_metadata.py | 2 +- tests/mock/test_point_data.py | 4 +- tests/mock/test_terminals.py | 10 +- tests/mock/utils/fixtures.py | 6 +- tests/mock/utils/test_utils.py | 2 +- tox.ini | 24 +- 270 files changed, 1287 insertions(+), 7557 deletions(-) rename doc/styles/{Ansys => Vocab/ANSYS}/accept.txt (100%) rename doc/styles/{Ansys => Vocab/ANSYS}/reject.txt (100%) delete mode 100644 protos/README.rst delete mode 100644 protos/ansys/api/edb/v1/VERSION delete mode 100644 protos/ansys/api/edb/v1/__init__.py delete mode 100644 protos/ansys/api/edb/v1/_version.py delete mode 100644 protos/ansys/api/edb/v1/arc_data.proto delete mode 100644 protos/ansys/api/edb/v1/board_bend_def.proto delete mode 100644 protos/ansys/api/edb/v1/bondwire.proto delete mode 100644 protos/ansys/api/edb/v1/bondwire_def.proto delete mode 100644 protos/ansys/api/edb/v1/bundle_term.proto delete mode 100644 protos/ansys/api/edb/v1/cell.proto delete mode 100644 protos/ansys/api/edb/v1/cell_instance.proto delete mode 100644 protos/ansys/api/edb/v1/circle.proto delete mode 100644 protos/ansys/api/edb/v1/component_def.proto delete mode 100644 protos/ansys/api/edb/v1/component_group.proto delete mode 100644 protos/ansys/api/edb/v1/component_model.proto delete mode 100644 protos/ansys/api/edb/v1/component_pin.proto delete mode 100644 protos/ansys/api/edb/v1/component_property.proto delete mode 100644 protos/ansys/api/edb/v1/connectable.proto delete mode 100644 protos/ansys/api/edb/v1/database.proto delete mode 100644 protos/ansys/api/edb/v1/dataset_def.proto delete mode 100644 protos/ansys/api/edb/v1/debye_model.proto delete mode 100644 protos/ansys/api/edb/v1/definition_obj.proto delete mode 100644 protos/ansys/api/edb/v1/die_property.proto delete mode 100644 protos/ansys/api/edb/v1/dielectric_material_model.proto delete mode 100644 protos/ansys/api/edb/v1/differential_pair.proto delete mode 100644 protos/ansys/api/edb/v1/djordjecvic_sarkar_model.proto delete mode 100644 protos/ansys/api/edb/v1/edb_defs.proto delete mode 100644 protos/ansys/api/edb/v1/edb_messages.proto delete mode 100644 protos/ansys/api/edb/v1/edge_term.proto delete mode 100644 protos/ansys/api/edb/v1/extended_net.proto delete mode 100644 protos/ansys/api/edb/v1/group.proto delete mode 100644 protos/ansys/api/edb/v1/hfss_simulation_settings.proto delete mode 100644 protos/ansys/api/edb/v1/hfss_simulation_setup.proto delete mode 100644 protos/ansys/api/edb/v1/hierarchy_obj.proto delete mode 100644 protos/ansys/api/edb/v1/ic_component_property.proto delete mode 100644 protos/ansys/api/edb/v1/inst_array.proto delete mode 100644 protos/ansys/api/edb/v1/io_component_property.proto delete mode 100644 protos/ansys/api/edb/v1/layer.proto delete mode 100644 protos/ansys/api/edb/v1/layer_collection.proto delete mode 100644 protos/ansys/api/edb/v1/layer_map.proto delete mode 100644 protos/ansys/api/edb/v1/layout.proto delete mode 100644 protos/ansys/api/edb/v1/layout_instance.proto delete mode 100644 protos/ansys/api/edb/v1/layout_instance_context.proto delete mode 100644 protos/ansys/api/edb/v1/layout_obj.proto delete mode 100644 protos/ansys/api/edb/v1/layout_obj_instance.proto delete mode 100644 protos/ansys/api/edb/v1/layout_obj_instance_2d_geometry.proto delete mode 100644 protos/ansys/api/edb/v1/layout_obj_instance_3d_geometry.proto delete mode 100644 protos/ansys/api/edb/v1/layout_obj_instance_geometry.proto delete mode 100644 protos/ansys/api/edb/v1/material_def.proto delete mode 100644 protos/ansys/api/edb/v1/material_property_thermal_modifier.proto delete mode 100644 protos/ansys/api/edb/v1/mcad_model.proto delete mode 100644 protos/ansys/api/edb/v1/model.proto delete mode 100644 protos/ansys/api/edb/v1/multipole_debye_model.proto delete mode 100644 protos/ansys/api/edb/v1/net.proto delete mode 100644 protos/ansys/api/edb/v1/netclass.proto delete mode 100644 protos/ansys/api/edb/v1/netlist_model.proto delete mode 100644 protos/ansys/api/edb/v1/package_def.proto delete mode 100644 protos/ansys/api/edb/v1/padstack_def.proto delete mode 100644 protos/ansys/api/edb/v1/padstack_def_data.proto delete mode 100644 protos/ansys/api/edb/v1/padstack_inst_term.proto delete mode 100644 protos/ansys/api/edb/v1/padstack_instance.proto delete mode 100644 protos/ansys/api/edb/v1/path.proto delete mode 100644 protos/ansys/api/edb/v1/pin_group.proto delete mode 100644 protos/ansys/api/edb/v1/pin_group_term.proto delete mode 100644 protos/ansys/api/edb/v1/pin_pair_model.proto delete mode 100644 protos/ansys/api/edb/v1/point_3d_data.proto delete mode 100644 protos/ansys/api/edb/v1/point_data.proto delete mode 100644 protos/ansys/api/edb/v1/point_term.proto delete mode 100644 protos/ansys/api/edb/v1/polygon.proto delete mode 100644 protos/ansys/api/edb/v1/polygon_data.proto delete mode 100644 protos/ansys/api/edb/v1/port_post_processing_prop.proto delete mode 100644 protos/ansys/api/edb/v1/port_property.proto delete mode 100644 protos/ansys/api/edb/v1/primitive.proto delete mode 100644 protos/ansys/api/edb/v1/r_tree.proto delete mode 100644 protos/ansys/api/edb/v1/raptor_x_simulation_settings.proto delete mode 100644 protos/ansys/api/edb/v1/rectangle.proto delete mode 100644 protos/ansys/api/edb/v1/refs.proto delete mode 100644 protos/ansys/api/edb/v1/rlc.proto delete mode 100644 protos/ansys/api/edb/v1/rlc_component_property.proto delete mode 100644 protos/ansys/api/edb/v1/simulation_settings.proto delete mode 100644 protos/ansys/api/edb/v1/simulation_setup.proto delete mode 100644 protos/ansys/api/edb/v1/siwave_dcir_simulation_settings.proto delete mode 100644 protos/ansys/api/edb/v1/siwave_simulation_settings.proto delete mode 100644 protos/ansys/api/edb/v1/solder_ball_property.proto delete mode 100644 protos/ansys/api/edb/v1/sparameter_model.proto delete mode 100644 protos/ansys/api/edb/v1/spice_model.proto delete mode 100644 protos/ansys/api/edb/v1/stackup_layer.proto delete mode 100644 protos/ansys/api/edb/v1/structure3d.proto delete mode 100644 protos/ansys/api/edb/v1/term.proto delete mode 100644 protos/ansys/api/edb/v1/term_inst.proto delete mode 100644 protos/ansys/api/edb/v1/term_inst_term.proto delete mode 100644 protos/ansys/api/edb/v1/text.proto delete mode 100644 protos/ansys/api/edb/v1/transform.proto delete mode 100644 protos/ansys/api/edb/v1/transform3d.proto delete mode 100644 protos/ansys/api/edb/v1/value.proto delete mode 100644 protos/ansys/api/edb/v1/variable_server.proto delete mode 100644 protos/ansys/api/edb/v1/via_group.proto delete mode 100644 protos/ansys/api/edb/v1/via_layer.proto delete mode 100644 protos/ansys/api/edb/v1/voltage_regulator.proto delete mode 100644 protos/requirements/requirements_build.txt delete mode 100644 protos/setup.py delete mode 100644 requirements/requirements_build.txt delete mode 100644 requirements/requirements_doc.txt delete mode 100644 requirements/requirements_notebook.txt delete mode 100644 requirements/requirements_tests.txt delete mode 100644 requirements/requirements_tox.txt delete mode 100644 src/ansys/edb/__init__.py rename src/ansys/edb/{ => core}/database.py (91%) create mode 100644 src/ansys/edb/core/definition/__init__.py rename src/ansys/edb/{ => core}/definition/bondwire_def.py (89%) rename src/ansys/edb/{ => core}/definition/component_def.py (76%) rename src/ansys/edb/{ => core}/definition/component_model.py (91%) rename src/ansys/edb/{ => core}/definition/component_pin.py (81%) rename src/ansys/edb/{ => core}/definition/component_property.py (80%) rename src/ansys/edb/{ => core}/definition/dataset_def.py (80%) rename src/ansys/edb/{ => core}/definition/debye_model.py (96%) rename src/ansys/edb/{ => core}/definition/die_property.py (90%) rename src/ansys/edb/{ => core}/definition/dielectric_material_model.py (91%) rename src/ansys/edb/{ => core}/definition/djordjecvic_sarkar_model.py (94%) rename src/ansys/edb/{ => core}/definition/ic_component_property.py (94%) rename src/ansys/edb/{ => core}/definition/io_component_property.py (89%) rename src/ansys/edb/{ => core}/definition/material_def.py (92%) rename src/ansys/edb/{ => core}/definition/material_property_thermal_modifier.py (84%) rename src/ansys/edb/{ => core}/definition/multipole_debye_model.py (94%) rename src/ansys/edb/{ => core}/definition/package_def.py (82%) rename src/ansys/edb/{ => core}/definition/padstack_def.py (81%) rename src/ansys/edb/{ => core}/definition/padstack_def_data.py (91%) rename src/ansys/edb/{ => core}/definition/port_property.py (86%) rename src/ansys/edb/{ => core}/definition/rlc_component_property.py (84%) rename src/ansys/edb/{ => core}/definition/solder_ball_property.py (94%) rename src/ansys/edb/{ => core}/edb_defs.py (100%) create mode 100644 src/ansys/edb/core/geometry/__init__.py rename src/ansys/edb/{ => core}/geometry/arc_data.py (94%) rename src/ansys/edb/{ => core}/geometry/point3d_data.py (93%) rename src/ansys/edb/{ => core}/geometry/point_data.py (90%) rename src/ansys/edb/{ => core}/geometry/polygon_data.py (92%) rename src/ansys/edb/{ => core}/geometry/r_tree.py (96%) rename src/ansys/edb/{ => core}/geometry/triangle3d_data.py (100%) create mode 100644 src/ansys/edb/core/hierarchy/__init__.py rename src/ansys/edb/{ => core}/hierarchy/cell_instance.py (78%) rename src/ansys/edb/{ => core}/hierarchy/component_group.py (82%) rename src/ansys/edb/{ => core}/hierarchy/group.py (86%) rename src/ansys/edb/{ => core}/hierarchy/hierarchy_obj.py (70%) rename src/ansys/edb/{ => core}/hierarchy/inst_array.py (76%) rename src/ansys/edb/{ => core}/hierarchy/model.py (73%) rename src/ansys/edb/{ => core}/hierarchy/netlist_model.py (81%) rename src/ansys/edb/{ => core}/hierarchy/pin_group.py (76%) rename src/ansys/edb/{ => core}/hierarchy/pin_pair_model.py (84%) rename src/ansys/edb/{ => core}/hierarchy/sparameter_model.py (87%) rename src/ansys/edb/{ => core}/hierarchy/spice_model.py (92%) rename src/ansys/edb/{ => core}/hierarchy/structure3d.py (87%) rename src/ansys/edb/{ => core}/hierarchy/via_group.py (77%) create mode 100644 src/ansys/edb/core/inner/__init__.py rename src/ansys/edb/core/{ => inner}/base.py (100%) rename src/ansys/edb/core/{ => inner}/conn_obj.py (81%) rename src/ansys/edb/core/{ => inner}/decorators.py (100%) rename src/ansys/edb/core/{ => inner}/edb_logging.py (98%) rename src/ansys/edb/core/{ => inner}/exceptions.py (100%) rename src/ansys/edb/core/{ => inner}/factory.py (74%) rename src/ansys/edb/core/{ => inner}/interceptors.py (95%) rename src/ansys/edb/core/{ => inner}/layout_obj.py (84%) rename src/ansys/edb/core/{ => inner}/messages.py (99%) rename src/ansys/edb/core/{ => inner}/parser.py (99%) rename src/ansys/edb/core/{ => inner}/utils.py (100%) rename src/ansys/edb/core/{ => inner}/variable_server.py (79%) create mode 100644 src/ansys/edb/core/layer/__init__.py rename src/ansys/edb/{ => core}/layer/layer.py (95%) rename src/ansys/edb/{ => core}/layer/layer_collection.py (96%) rename src/ansys/edb/{ => core}/layer/stackup_layer.py (94%) rename src/ansys/edb/{ => core}/layer/via_layer.py (95%) create mode 100644 src/ansys/edb/core/layout/__init__.py rename src/ansys/edb/{ => core}/layout/cell.py (86%) rename src/ansys/edb/{ => core}/layout/layout.py (70%) rename src/ansys/edb/{ => core}/layout/mcad_model.py (88%) rename src/ansys/edb/{ => core}/layout/voltage_regulator.py (90%) create mode 100644 src/ansys/edb/core/layout_instance/__init__.py rename src/ansys/edb/{ => core}/layout_instance/layout_instance.py (84%) rename src/ansys/edb/{ => core}/layout_instance/layout_instance_context.py (85%) rename src/ansys/edb/{ => core}/layout_instance/layout_obj_instance.py (65%) rename src/ansys/edb/{ => core}/layout_instance/layout_obj_instance_2d_geometry.py (73%) rename src/ansys/edb/{ => core}/layout_instance/layout_obj_instance_3d_geometry.py (53%) rename src/ansys/edb/{ => core}/layout_instance/layout_obj_instance_geometry.py (88%) create mode 100644 src/ansys/edb/core/net/__init__.py rename src/ansys/edb/{ => core}/net/differential_pair.py (82%) rename src/ansys/edb/{ => core}/net/extended_net.py (86%) rename src/ansys/edb/{ => core}/net/net.py (66%) rename src/ansys/edb/{ => core}/net/net_class.py (85%) rename src/ansys/edb/{ => core}/primitive/__init__.py (86%) rename src/ansys/edb/{ => core}/primitive/primitive.py (85%) rename src/ansys/edb/{ => core}/session.py (99%) rename src/ansys/edb/{ => core}/simulation_setup/__init__.py (52%) rename src/ansys/edb/{ => core}/simulation_setup/adaptive_solutions.py (100%) rename src/ansys/edb/{ => core}/simulation_setup/hfss_simulation_settings.py (99%) rename src/ansys/edb/{ => core}/simulation_setup/hfss_simulation_setup.py (77%) rename src/ansys/edb/{ => core}/simulation_setup/mesh_operation.py (100%) rename src/ansys/edb/{ => core}/simulation_setup/raptor_x_simulation_settings.py (99%) rename src/ansys/edb/{ => core}/simulation_setup/raptor_x_simulation_setup.py (75%) rename src/ansys/edb/{ => core}/simulation_setup/simulation_settings.py (98%) rename src/ansys/edb/{ => core}/simulation_setup/simulation_setup.py (96%) rename src/ansys/edb/{ => core}/simulation_setup/siwave_dcir_simulation_settings.py (95%) rename src/ansys/edb/{ => core}/simulation_setup/siwave_dcir_simulation_setup.py (74%) rename src/ansys/edb/{ => core}/simulation_setup/siwave_simulation_settings.py (99%) rename src/ansys/edb/{ => core}/simulation_setup/siwave_simulation_setup.py (75%) rename src/ansys/edb/{ => core}/terminal/__init__.py (87%) rename src/ansys/edb/{ => core}/terminal/terminals.py (98%) rename src/ansys/edb/{ => core}/typing/__init__.py (78%) create mode 100644 src/ansys/edb/core/utility/__init__.py rename src/ansys/edb/{ => core}/utility/conversions.py (92%) rename src/ansys/edb/{ => core}/utility/heat_sink.py (96%) rename src/ansys/edb/{ => core}/utility/hfss_extent_info.py (92%) rename src/ansys/edb/{ => core}/utility/layer_map.py (96%) rename src/ansys/edb/{ => core}/utility/material_property_thermal_modifier_params.py (98%) rename src/ansys/edb/{ => core}/utility/port_post_processing_prop.py (98%) rename src/ansys/edb/{ => core}/utility/rlc.py (98%) rename src/ansys/edb/{ => core}/utility/temperature_settings.py (95%) rename src/ansys/edb/{ => core}/utility/transform.py (86%) rename src/ansys/edb/{ => core}/utility/transform3d.py (97%) rename src/ansys/edb/{ => core}/utility/value.py (95%) delete mode 100644 src/ansys/edb/definition/__init__.py delete mode 100644 src/ansys/edb/geometry/__init__.py delete mode 100644 src/ansys/edb/hierarchy/__init__.py delete mode 100644 src/ansys/edb/layer/__init__.py delete mode 100644 src/ansys/edb/layout/__init__.py delete mode 100644 src/ansys/edb/layout_instance/__init__.py delete mode 100644 src/ansys/edb/net/__init__.py delete mode 100644 src/ansys/edb/utility/__init__.py diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 983c199e2f..045add93eb 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -10,7 +10,9 @@ on: workflow_dispatch: env: - DOCUMENTATION_CNAME: 'edb.docs.pyansys.com' + DOCUMENTATION_CNAME: 'edb.core.docs.pyansys.com' + MAIN_PYTHON_VERSION: '3.10' + PIP_EXTRA_INDEX_URL: 'https://${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/' concurrency: group: ${{ github.workflow }}-${{ github.ref }} @@ -21,9 +23,19 @@ jobs: name: Code style runs-on: ubuntu-latest steps: - - uses: ansys/actions/code-style@v4 + - name: PyAnsys code style checks + uses: ansys/actions/code-style@v4 with: - python-version: 3.7 + python-version: ${{ env.MAIN_PYTHON_VERSION }} + + doc-style: + name: Documentation Style Check + runs-on: ubuntu-latest + steps: + - name: PyAnsys documentation style checks + uses: ansys/actions/doc-style@v4 + with: + token: ${{ secrets.GITHUB_TOKEN }} tests: name: Tests and coverage @@ -31,7 +43,7 @@ jobs: strategy: matrix: os: [windows-latest, ubuntu-latest] - python-version: ['3.7', '3.8', '3.9', '3.10'] + python-version: ['3.8', '3.9', '3.10'] fail-fast: false steps: @@ -40,23 +52,16 @@ jobs: uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} + - name: Install dependencies run: | - python -m pip install --upgrade -r requirements/requirements_tox.txt + python -m pip install --upgrade .[tests] python -m pip install --upgrade tox-gh-actions + - name: Test with tox # Only the tox environment specified in the tox.ini gh-actions is run run: tox -e test -- --ignore=tests/e2e - doc-style: - name: Documentation - runs-on: ubuntu-latest - steps: - - name: "Check documentation style" - uses: ansys/actions/doc-style@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - # TODO: convert to ansys/actions/doc-build doc-build: name: Build documentation @@ -67,11 +72,11 @@ jobs: - name: Set up Python uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: 3.8 - name: Install dependencies run: | - python -m pip install --upgrade -r requirements/requirements_tox.txt + python -m pip install --upgrade .[doc] tox - name: Generate the documentation with tox run: tox -e doc @@ -91,18 +96,10 @@ jobs: - name: Set up Python uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: 3.8 - name: Install dependencies run: | - python -m pip install --upgrade pip flit - python -m pip install -r protos/requirements/requirements_build.txt - python -m pip install -r requirements/requirements_build.txt - - name: Build API - run: | - cd protos - python setup.py develop - python setup.py bdist_wheel - cp -a dist/. ../dist/ + python -m pip install --upgrade pip flit twine - name: Build Core run: | flit build @@ -129,7 +126,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v4.3.0 with: - python-version: 3.7 + python-version: 3.8 - uses: actions/checkout@v2 - uses: actions/download-artifact@v3 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 5599f2de8f..096fde2106 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,58 +1,57 @@ repos: - repo: https://github.com/psf/black - rev: 22.3.0 + rev: 23.9.1 # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!! hooks: - id: black - exclude: | - (?x)( - ^src/ansys/api/| - ^protos - ) + +- repo: https://github.com/adamchainz/blacken-docs + rev: 1.16.0 + hooks: + - id: blacken-docs + additional_dependencies: [black==23.9.1] - repo: https://github.com/pycqa/isort - rev: 5.11.5 + rev: 5.12.0 hooks: - id: isort - exclude: | - (?x)( - ^src/ansys/api/| - ^protos - ) - repo: https://github.com/PyCQA/flake8 - rev: 5.0.4 + rev: 6.1.0 hooks: - id: flake8 - exclude: | - (?x)( - ^src/ansys/api/| - ^protos - ) - repo: https://github.com/codespell-project/codespell - rev: v2.1.0 + rev: v2.2.6 hooks: - id: codespell - exclude: | - (?x)( - ^src/ansys/api/| - ^protos| - ^notebooks - ) + exclude: (?x)(^notebooks) + args: ["--ignore-words", "doc/styles/Vocab/ANSYS/accept.txt", "-w"] - repo: https://github.com/pycqa/pydocstyle - rev: 6.1.1 + rev: 6.3.0 hooks: - id: pydocstyle - additional_dependencies: [toml] - exclude: | - (?x)( - ^tests/| - ^src/ansys/api/| - ^protos - ) + additional_dependencies: [tomli] + exclude: "tests/" + +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-merge-conflict + - id: debug-statements + - id: check-yaml + - id: trailing-whitespace + exclude: (?x)^(.*\.def) + +# - repo: https://github.com/ansys/pre-commit-hooks +# rev: v0.2.2 +# hooks: +# - id: add-license-headers +# args: ["--loc", "./"] +# FIXME: See if this local hooks could be replaced with using +# https://github.com/kynan/nbstripout - repo: local hooks: - id: cleanipynb-helpers diff --git a/LICENSE b/LICENSE index ea581cdfa6..69af3d3e4c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 ANSYS, Inc. All rights reserved. +Copyright (c) 2023 ANSYS, Inc. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.rst b/README.rst index 6d6ab9196c..94502b25de 100644 --- a/README.rst +++ b/README.rst @@ -35,7 +35,7 @@ For developers Installing Pyedb in developer mode allows you to modify the source and enhance it. -Before contributing to the project, please refer to the `PyAnsys Developer's guide`_. You will +Before contributing to the project, please refer to the `PyAnsys Developer's guide`_. You will need to follow these steps: 1. Start by cloning this repository: @@ -77,7 +77,7 @@ need to follow these steps: 4. Finally, verify your development installation by running: .. code:: bash - + tox @@ -86,7 +86,7 @@ How to testing This project takes advantage of `tox`_. This tool allows to automate common development tasks (similar to Makefile) but it is oriented towards Python -development. +development. Using tox ^^^^^^^^^ @@ -141,14 +141,7 @@ However, the recommended way of checking documentation integrity is using: Distributing ------------ -If you would like to create either source or wheel files, start by installing -the building requirements: - -.. code:: bash - - python -m pip install -r requirements/requirements_build.txt - -Then, you can execute: +If you would like to create either source or wheel files, then you can execute: .. code:: bash @@ -184,13 +177,12 @@ Follow these steps as necessary to run the notebooks : .. code:: bash python -m pip install -e . - python -m pip install -e ./protos -3. Install requirements_notebook.txt : +3. Install notebook requirements : .. code:: bash - python -m pip install -r ./requirements/requirements_notebook.txt + python -m pip install .[notebook] 4. Install ipython kernel : diff --git a/doc/make.bat b/doc/make.bat index fbf400507e..cfdfa1cf1b 100644 --- a/doc/make.bat +++ b/doc/make.bat @@ -30,7 +30,7 @@ if errorlevel 9009 ( goto end :clean -rmdir /s /q %BUILDDIR% > /NUL 2>&1 +rmdir /s /q %BUILDDIR% > /NUL 2>&1 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d" goto end diff --git a/doc/source/_templates/sidebar-nav-bs.html b/doc/source/_templates/sidebar-nav-bs.html index 0747bd05f0..2ccf1db9e9 100644 --- a/doc/source/_templates/sidebar-nav-bs.html +++ b/doc/source/_templates/sidebar-nav-bs.html @@ -5,6 +5,6 @@ {% else %} {{ generate_toctree_html("sidebar", maxdepth=4, collapse=False, includehidden=True, titles_only=True) }} {% endif %} - + diff --git a/doc/source/api/database.rst b/doc/source/api/database.rst index 0ef04c2c30..49b53e707b 100644 --- a/doc/source/api/database.rst +++ b/doc/source/api/database.rst @@ -4,7 +4,7 @@ Database Classes ------- -.. currentmodule:: ansys.edb.database +.. currentmodule:: ansys.edb.core.database .. autosummary:: diff --git a/doc/source/api/definition.rst b/doc/source/api/definition.rst index 6b4175c28a..6f2d8da574 100644 --- a/doc/source/api/definition.rst +++ b/doc/source/api/definition.rst @@ -4,7 +4,7 @@ Definition Classes ------- -.. currentmodule:: ansys.edb.definition +.. currentmodule:: ansys.edb.core.definition .. autosummary:: :toctree: _autosummary diff --git a/doc/source/api/geometry.rst b/doc/source/api/geometry.rst index 3bd92a2ea4..d5b0e621f4 100644 --- a/doc/source/api/geometry.rst +++ b/doc/source/api/geometry.rst @@ -4,7 +4,7 @@ Geometry Classes ------- -.. currentmodule:: ansys.edb.geometry +.. currentmodule:: ansys.edb.core.geometry .. autosummary:: :toctree: _autosummary @@ -15,7 +15,7 @@ Classes PointData Point3DData Triangle3DData - + Enums ----- diff --git a/doc/source/api/glossary.rst b/doc/source/api/glossary.rst index 0b5e753fe1..7a3bb9969c 100644 --- a/doc/source/api/glossary.rst +++ b/doc/source/api/glossary.rst @@ -8,25 +8,25 @@ Glossary Connectable The generic type for most objects in Layout. - + Objects of the following types are all connectables : - + .. toctree:: :maxdepth: 1 primitive hierarchy terminal - + Zone - Multizone stackups allow a design to be divided into areas called zones. - - Each zone contains a subset of layers available to the entire circuit board and is spatially defined by polygons on the Outline layer. + Multizone stackups allow a design to be divided into areas called zones. + + Each zone contains a subset of layers available to the entire circuit board and is spatially defined by polygons on the Outline layer. ValueLike - :obj:`Union `\[:obj:`int`, :obj:`float`, :obj:`complex`, :obj:`str`, :class:`Value `\] + :obj:`Union `\[:obj:`int`, :obj:`float`, :obj:`complex`, :obj:`str`, :class:`Value `\] Point3DLike @@ -34,7 +34,7 @@ Glossary PointDataTuple - :obj:`tuple`\[:class:`PointData `, :class:`PointData `\]` + :obj:`tuple`\[:class:`PointData `, :class:`PointData `\]` Triangle3DLike @@ -51,12 +51,12 @@ Glossary HFSS solver properties are represented by a tuple of the form [dc_thickness_type, dc_thickness_value, solve_inside_enabled] - :obj:`tuple`\[:class:`DCThicknessType `, :term:`ValueLike`, :obj:`bool`\] + :obj:`tuple`\[:class:`DCThicknessType `, :term:`ValueLike`, :obj:`bool`\] HFSSExtents - + Extent box around the design, represented by a :obj:`dict` with the following key:values - + | **dielectric**: (:obj:`float`, :obj:`bool`) | Dielectric extent size. First parameter is the value and second parameter indicates if the value is a multiple. | **airbox_horizontal**: (:obj:`float`, :obj:`bool`) diff --git a/doc/source/api/hierarchy.rst b/doc/source/api/hierarchy.rst index e07afa15de..4f818129c1 100644 --- a/doc/source/api/hierarchy.rst +++ b/doc/source/api/hierarchy.rst @@ -8,11 +8,11 @@ Sub-designs, MCAD Components, Coordinate systems etc.. are all examples of hiera Object Types ------------ -.. currentmodule:: ansys.edb.hierarchy +.. currentmodule:: ansys.edb.core.hierarchy .. autosummary:: :toctree: _autosummary - + CellInstance InstArray ComponentGroup @@ -32,6 +32,6 @@ Enums .. autosummary:: :toctree: _autosummary - + ComponentType MeshClosure \ No newline at end of file diff --git a/doc/source/api/layer.rst b/doc/source/api/layer.rst index 89368308cb..73bffc820a 100644 --- a/doc/source/api/layer.rst +++ b/doc/source/api/layer.rst @@ -4,11 +4,11 @@ Layers Classes ------- -.. currentmodule:: ansys.edb.layer +.. currentmodule:: ansys.edb.core.layer .. autosummary:: :toctree: _autosummary - + Layer StackupLayer ViaLayer diff --git a/doc/source/api/layout.rst b/doc/source/api/layout.rst index 8b2b25ed35..d5a70885bb 100644 --- a/doc/source/api/layout.rst +++ b/doc/source/api/layout.rst @@ -4,11 +4,11 @@ Layout Classes ------- -.. currentmodule:: ansys.edb.layout +.. currentmodule:: ansys.edb.core.layout .. autosummary:: :toctree: _autosummary - + Cell Layout McadModel @@ -20,6 +20,6 @@ Enums .. autosummary:: :toctree: _autosummary - + CellType DesignMode \ No newline at end of file diff --git a/doc/source/api/layout_instance.rst b/doc/source/api/layout_instance.rst index 94db6039d9..d548663062 100644 --- a/doc/source/api/layout_instance.rst +++ b/doc/source/api/layout_instance.rst @@ -4,7 +4,7 @@ Layout Instance Classes ------- -.. currentmodule:: ansys.edb.layout_instance +.. currentmodule:: ansys.edb.core.layout_instance .. autosummary:: :toctree: _autosummary diff --git a/doc/source/api/net.rst b/doc/source/api/net.rst index eb08492d4b..50dec12086 100644 --- a/doc/source/api/net.rst +++ b/doc/source/api/net.rst @@ -4,11 +4,11 @@ Nets Classes ------- -.. currentmodule:: ansys.edb.net +.. currentmodule:: ansys.edb.core.net .. autosummary:: :toctree: _autosummary - + DifferentialPair ExtendedNet Net diff --git a/doc/source/api/primitive.rst b/doc/source/api/primitive.rst index 0005cf6738..c2f35fbbe8 100644 --- a/doc/source/api/primitive.rst +++ b/doc/source/api/primitive.rst @@ -4,7 +4,7 @@ Primitives Classes ------- -.. currentmodule:: ansys.edb.primitive +.. currentmodule:: ansys.edb.core.primitive .. autosummary:: :toctree: _autosummary diff --git a/doc/source/api/session.rst b/doc/source/api/session.rst index 4fa13ff855..1ac95cb9d9 100644 --- a/doc/source/api/session.rst +++ b/doc/source/api/session.rst @@ -7,7 +7,7 @@ occurs, all EDB API function calls will be processed using that channel. Functions --------- -.. currentmodule:: ansys.edb.session +.. currentmodule:: ansys.edb.core.session .. autosummary:: :toctree: _autosummary diff --git a/doc/source/api/simulation_setup.rst b/doc/source/api/simulation_setup.rst index a2697412ca..2c508bb8d3 100644 --- a/doc/source/api/simulation_setup.rst +++ b/doc/source/api/simulation_setup.rst @@ -4,7 +4,7 @@ Simulation Setup Classes ------- -.. currentmodule:: ansys.edb.simulation_setup +.. currentmodule:: ansys.edb.core.simulation_setup .. autosummary:: :toctree: _autosummary diff --git a/doc/source/api/terminal.rst b/doc/source/api/terminal.rst index 8b0d98f491..bde52b7948 100644 --- a/doc/source/api/terminal.rst +++ b/doc/source/api/terminal.rst @@ -4,11 +4,11 @@ Terminals Classes ------- -.. currentmodule:: ansys.edb.terminal +.. currentmodule:: ansys.edb.core.terminal .. autosummary:: :toctree: _autosummary - + BoundaryType BundleTerminal Edge diff --git a/doc/source/api/utility.rst b/doc/source/api/utility.rst index b17cbd3816..0fda0d5b47 100644 --- a/doc/source/api/utility.rst +++ b/doc/source/api/utility.rst @@ -4,7 +4,7 @@ Utility Classes ------- -.. currentmodule:: ansys.edb.utility +.. currentmodule:: ansys.edb.core.utility .. autosummary:: :toctree: _autosummary diff --git a/doc/source/conf.py b/doc/source/conf.py index d92db43c53..080a2b9770 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -5,7 +5,7 @@ from ansys_sphinx_theme import ansys_favicon, get_version_match, pyansys_logo_black -from ansys.edb import __version__ +from ansys.edb.core import __version__ # Project information project = "ansys-edb" diff --git a/doc/source/index.rst b/doc/source/index.rst index 01901908a8..65dd59601e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,7 +15,7 @@ Choose :ref:`ref_index_api` to access a complete description of all the availabl .. toctree:: :hidden: - + installation user_guide/user_guide api/index diff --git a/doc/styles/Ansys/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt similarity index 100% rename from doc/styles/Ansys/accept.txt rename to doc/styles/Vocab/ANSYS/accept.txt diff --git a/doc/styles/Ansys/reject.txt b/doc/styles/Vocab/ANSYS/reject.txt similarity index 100% rename from doc/styles/Ansys/reject.txt rename to doc/styles/Vocab/ANSYS/reject.txt diff --git a/notebooks/3d_comp_placement.ipynb b/notebooks/3d_comp_placement.ipynb index b826c4dc3c..bcc461243d 100644 --- a/notebooks/3d_comp_placement.ipynb +++ b/notebooks/3d_comp_placement.ipynb @@ -29,7 +29,7 @@ { "data": { "text/plain": [ - "" + "" ] }, "execution_count": 2, diff --git a/notebooks/helpers/example_setup.ipynb b/notebooks/helpers/example_setup.ipynb index 56d0ad30e3..82f6782651 100644 --- a/notebooks/helpers/example_setup.ipynb +++ b/notebooks/helpers/example_setup.ipynb @@ -10,19 +10,19 @@ "import os, sys, pathlib, ipynbname, glob, shutil\n", "import ansys.edb\n", "\n", - "from ansys.edb.database import *\n", - "from ansys.edb.definition import *\n", - "from ansys.edb.geometry import *\n", - "from ansys.edb.hierarchy import *\n", - "from ansys.edb.layer import *\n", - "from ansys.edb.layout import *\n", - "from ansys.edb.layout_instance import *\n", - "from ansys.edb.net import *\n", - "from ansys.edb.primitive import *\n", - "from ansys.edb.simulation_setup import *\n", - "from ansys.edb.terminal import *\n", - "from ansys.edb.utility import *\n", - "from ansys.edb.session import launch_session" + "from ansys.edb.core.database import *\n", + "from ansys.edb.core.definition import *\n", + "from ansys.edb.core.geometry import *\n", + "from ansys.edb.core.hierarchy import *\n", + "from ansys.edb.core.layer import *\n", + "from ansys.edb.core.layout import *\n", + "from ansys.edb.core.layout_instance import *\n", + "from ansys.edb.core.net import *\n", + "from ansys.edb.core.primitive import *\n", + "from ansys.edb.core.simulation_setup import *\n", + "from ansys.edb.core.terminal import *\n", + "from ansys.edb.core.utility import *\n", + "from ansys.edb.core.session import launch_session" ] }, { diff --git a/protos/README.rst b/protos/README.rst deleted file mode 100644 index 8259900a85..0000000000 --- a/protos/README.rst +++ /dev/null @@ -1,7 +0,0 @@ -### ansys.api.edb.v1 gRPC Interface Package - -This Python package contains the auto-generated gRPC python interface files. - -Version: 0.0.0 -Auto-generated on: 00:00:00 on 06 June 2022 - diff --git a/protos/ansys/api/edb/v1/VERSION b/protos/ansys/api/edb/v1/VERSION deleted file mode 100644 index bd52db81d0..0000000000 --- a/protos/ansys/api/edb/v1/VERSION +++ /dev/null @@ -1 +0,0 @@ -0.0.0 \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/__init__.py b/protos/ansys/api/edb/v1/__init__.py deleted file mode 100644 index 7df9f7aa35..0000000000 --- a/protos/ansys/api/edb/v1/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from ._version import __version__ \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/_version.py b/protos/ansys/api/edb/v1/_version.py deleted file mode 100644 index a104532c6b..0000000000 --- a/protos/ansys/api/edb/v1/_version.py +++ /dev/null @@ -1,2 +0,0 @@ -"""ansys.api.edb.v1 python protocol version""" -__version__ = '0.0.0' # major.minor.patch diff --git a/protos/ansys/api/edb/v1/arc_data.proto b/protos/ansys/api/edb/v1/arc_data.proto deleted file mode 100644 index 97db4be781..0000000000 --- a/protos/ansys/api/edb/v1/arc_data.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Proto file representing the EDB Arc Data class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; - -enum RotationDirection { - ROTATION_DIRECTION_CCW = 0; - ROTATION_DIRECTION_CW = 1; - ROTATION_DIRECTION_COLINEAR = 2; -} - -service ArcDataService { - // Get height of an arc - rpc GetHeight (ArcMessage) returns (google.protobuf.FloatValue) {} - - // Get center point of an arc - rpc GetCenter (ArcMessage) returns (PointMessage) {} - - // Get midpoint of an arc - rpc GetMidpoint (ArcMessage) returns (PointMessage) {} - - // Get radius of an arc - rpc GetRadius (ArcMessage) returns (google.protobuf.FloatValue) {} - - // Get bounding box of an arc - rpc GetBoundingBox (ArcMessage) returns (BoxMessage) {} - - // Get angle between two arcs. - rpc GetAngle (ArcMessage) returns (google.protobuf.FloatValue) {} - - // Get closest points between two arcs. - rpc ClosestPoints (ArcDataTwoArcsMessage) returns (BoxMessage) {} -} - -message ArcMessage { - message RadiusMessage { - double radius = 1; - RotationDirection dir = 2; - bool is_big = 3; - } - message CenterMessage { - PointMessage point = 1; - RotationDirection dir = 2; - } - - PointMessage start = 1; - PointMessage end = 2; - oneof option { - google.protobuf.FloatValue height = 3; - PointMessage thru = 4; - RadiusMessage radius = 5; - CenterMessage center = 6; - } -} - -message ArcDataTwoArcsMessage { - ArcMessage arc1 = 1; - ArcMessage arc2 = 2; -} - -message ArcsMessage { - repeated ArcMessage items = 1; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/board_bend_def.proto b/protos/ansys/api/edb/v1/board_bend_def.proto deleted file mode 100644 index 7fede1433d..0000000000 --- a/protos/ansys/api/edb/v1/board_bend_def.proto +++ /dev/null @@ -1,37 +0,0 @@ -// Proto file representing the BoardBendDef class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; -import "polygon_data.proto"; - -service BoardBendDefService { - rpc Create (BoardBendDefCreateMessage) returns (EDBObjMessage) {} - - rpc GetBoundaryPrim (EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetBendMiddle (EDBObjMessage) returns (PointPairMessage) {} - - rpc SetBendMiddle (PointPairPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRadius (EDBObjMessage) returns (ValueMessage) {} - - rpc SetRadius (ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetAngle (EDBObjMessage) returns (ValueMessage) {} - - rpc SetAngle (ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetBentRegions (EDBObjMessage) returns (PolygonDataListMessage) {} -} - -message BoardBendDefCreateMessage { - EDBObjMessage layout = 1; - EDBObjMessage zone_prim = 2; - PointPairMessage middle = 3; - ValueMessage radius = 4; - ValueMessage angle = 5; -} diff --git a/protos/ansys/api/edb/v1/bondwire.proto b/protos/ansys/api/edb/v1/bondwire.proto deleted file mode 100644 index 6a496b9f87..0000000000 --- a/protos/ansys/api/edb/v1/bondwire.proto +++ /dev/null @@ -1,165 +0,0 @@ -// Proto file representing the EDB Circle class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; - -enum BondwireType { - APD_BONDWIRE = 0; - JEDEC4_BONDWIRE = 1; - JEDEC5_BONDWIRE = 2; - NUM_OF_BONDWIRE_TYPE = 3; - INVALID_BONDWIRE_TYPE = -1; -} - -enum BondwireCrossSectionType { - BONDWIRE_ROUND = 0; - BONDWIRE_RECTANGLE = 1; - INVALID_BONDWIRE_CROSS_SECTION_TYPE = -1; -} - -// Bondwire service definition -service BondwireService { - // Create Bondwire - rpc Create (BondwireCreateMessage) returns (EDBObjMessage) {} - - // Get Material - rpc GetMaterial (BondwireBoolMessage) returns (google.protobuf.StringValue) {} - - // Set Material - rpc SetMaterial (SetMaterialMessage) returns (google.protobuf.Empty) {} - - // Get Bondwire Type - rpc GetType (EDBObjMessage) returns (BondwireTypeMessage) {} - - // Set Bondwire Type - rpc SetType (SetBondwireTypeMessage) returns (google.protobuf.Empty) {} - - // Get Cross Section Type - rpc GetCrossSectionType (EDBObjMessage) returns (GetCrossSectionTypeMessage) {} - - // Set Type - rpc SetCrossSectionType (SetCrossSectionTypeMessage) returns (google.protobuf.Empty) {} - - // Get Cross Section Type - rpc GetCrossSectionHeight (EDBObjMessage) returns (ValueMessage) {} - - // Set Type - rpc SetCrossSectionHeight (SetCrossSectionHeightMessage) returns (google.protobuf.Empty) {} - - // Get Bondwire Definition Name - rpc GetDefinitionName (BondwireBoolMessage) returns (google.protobuf.StringValue) {} - - // Set Bondwire Definition Name - rpc SetDefinitionName (SetDefinitionNameMessage) returns (google.protobuf.Empty) {} - - // Get Start Elevation Layer - rpc GetStartElevation (GetElevationMessage) returns (EDBObjMessage) {} - - // Set Start Elevation Layer - rpc SetStartElevation (SetElevationMessage) returns (google.protobuf.Empty) {} - - // Get End Elevation Layer - rpc GetEndElevation (GetElevationMessage) returns (EDBObjMessage) {} - - // Set End Elevation Layer - rpc SetEndElevation (SetElevationMessage) returns (google.protobuf.Empty) {} - - // Get Trajectory Values - rpc GetTraj (EDBObjMessage) returns (BondwireTrajMessage) {} - - // Set Trajectory Values - rpc SetTraj (SetBondwireTrajMessage) returns (google.protobuf.Empty) {} - - // Get Width Value - rpc GetWidthValue (EDBObjMessage) returns (ValueMessage) {} - - // Get Width Value - rpc SetWidthValue (BondwireValueMessage) returns (google.protobuf.Empty) {} -} - -message BondwireCreateMessage { - EDBObjMessage layout = 1; - NetRefMessage net = 2; - BondwireType bondwire_type = 3; - string definition_name = 4; - string placement_layer = 5; - ValueMessage width = 6; - string material = 7; - EDBObjMessage start_context = 8; - string start_layer_name = 9; - ValueMessage start_x = 10; - ValueMessage start_y = 11; - EDBObjMessage end_context = 12; - string end_layer_name = 13; - ValueMessage end_x = 14; - ValueMessage end_y = 15; -} - -message BondwireBoolMessage { - EDBObjMessage target = 1; - bool evaluated = 2; -} - -message SetMaterialMessage { - EDBObjMessage target = 1; - string material = 2; -} - -message BondwireTypeMessage { - BondwireType type = 1; -} - -message SetBondwireTypeMessage { - EDBObjMessage target = 1; - BondwireType type = 2; -} - -message GetCrossSectionTypeMessage { - BondwireCrossSectionType type = 1; -} - -message SetCrossSectionTypeMessage { - EDBObjMessage target = 1; - BondwireCrossSectionType type = 2; -} - -message SetCrossSectionHeightMessage { - EDBObjMessage target = 1; - ValueMessage height = 2; -} - -message SetDefinitionNameMessage { - EDBObjMessage target = 1; - string definition_name = 2; -} - -message GetElevationMessage { - EDBObjMessage bw = 1; - EDBObjMessage cell_instance = 2; -} - -message SetElevationMessage { - GetElevationMessage target = 1; - string lyrname = 2; -} - -message BondwireValueMessage { - EDBObjMessage target = 1; - ValueMessage value = 2; -} - -message BondwireTrajMessage { - ValueMessage x1 = 1; - ValueMessage y1 = 2; - ValueMessage x2 = 3; - ValueMessage y2 = 4; -} - -message SetBondwireTrajMessage { - EDBObjMessage target = 1; - BondwireTrajMessage traj = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/bondwire_def.proto b/protos/ansys/api/edb/v1/bondwire_def.proto deleted file mode 100644 index 10cc243566..0000000000 --- a/protos/ansys/api/edb/v1/bondwire_def.proto +++ /dev/null @@ -1,89 +0,0 @@ -// Proto file representing the EDB Circle class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -enum BondwireDefType { - APD_BONDWIRE_DEF = 0; - JEDEC4_BONDWIRE_DEF = 1; - JEDEC5_BONDWIRE_DEF = 2; -} - -// BondwireDef service definition -service BondwireDefService { - // Delete BondwireDef. - rpc Delete (EDBObjMessage) returns (google.protobuf.Empty) {} - - // Get the name of the BondwireDef. - rpc GetName (EDBObjMessage) returns (google.protobuf.StringValue) {} -} - -message BondwireDefStrMessage{ - EDBObjMessage object = 1; - string name = 2; -} - -// Apd BondwireDef service definition -service ApdBondwireDefService { - // Creates an Apd BondwireDef. - rpc Create (BondwireDefStrMessage) returns (EDBObjMessage) {} - - // Loads Definitions From File. - rpc LoadDefinitionsFromFile (BondwireDefStrMessage) returns (google.protobuf.Empty) {} - - // Find Apd BondwireDef By Name. - rpc FindByName (BondwireDefStrMessage) returns (EDBObjMessage) {} - - // Get Apd BondwireDef parameters in cblock string format. - rpc GetParameters (EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Set Apd BondwireDef parameters by passing cblock string. - rpc SetParameters (BondwireDefStrMessage) returns (google.protobuf.Empty) {} -} - -service Jedec4BondwireDefService { - // Creates an Jedec4BondwireDef. - rpc Create (BondwireDefStrMessage) returns (EDBObjMessage) {} - - // Find Jedec4BondwireDef By Name. - rpc FindByName (BondwireDefStrMessage) returns (EDBObjMessage) {} - - // Get Jedec4BondwireDef parameters in cblock string format. - rpc GetParameters (EDBObjMessage) returns (ValueMessage) {} - - // Set Jedec4BondwireDef parameters by passing cblock string. - rpc SetParameters (Jedec4BondwireDefSetParametersMessage) returns (google.protobuf.Empty) {} -} - -message Jedec4BondwireDefSetParametersMessage{ - EDBObjMessage target = 1; - ValueMessage top_to_die_distance = 2; -} - -service Jedec5BondwireDefService { - // Creates an Jedec5BondwireDef. - rpc Create (BondwireDefStrMessage) returns (EDBObjMessage) {} - - // Find Jedec5BondwireDef By Name. - rpc FindByName (BondwireDefStrMessage) returns (EDBObjMessage) {} - - // Get Jedec5BondwireDef parameters in cblock string format. - rpc GetParameters (EDBObjMessage) returns (Jedec5BondwireDefParametersMessage) {} - - // Set Jedec5BondwireDef parameters by passing cblock string. - rpc SetParameters (Jedec5BondwireDefSetParametersMessage) returns (google.protobuf.Empty) {} -} - -message Jedec5BondwireDefParametersMessage{ - ValueMessage top_to_die_distance = 1; - ValueMessage die_pad_angle = 2; - ValueMessage lead_pad_angle = 3; -} - -message Jedec5BondwireDefSetParametersMessage{ - EDBObjMessage target = 1; - Jedec5BondwireDefParametersMessage parameters = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/bundle_term.proto b/protos/ansys/api/edb/v1/bundle_term.proto deleted file mode 100644 index 653a4f4770..0000000000 --- a/protos/ansys/api/edb/v1/bundle_term.proto +++ /dev/null @@ -1,14 +0,0 @@ -// Proto file representing the EDB BundleTerminal class - -syntax = "proto3"; -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service BundleTerminalService { - rpc Create (EDBObjCollectionMessage) returns (EDBObjMessage) {} - - rpc Ungroup (EDBObjMessage) returns (google.protobuf.Empty) {} - - rpc GetTerminals (EDBObjMessage) returns (EDBObjCollectionMessage) {} -} diff --git a/protos/ansys/api/edb/v1/cell.proto b/protos/ansys/api/edb/v1/cell.proto deleted file mode 100644 index 4f91d8eff4..0000000000 --- a/protos/ansys/api/edb/v1/cell.proto +++ /dev/null @@ -1,141 +0,0 @@ -// Proto file representing the EDB Cell class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_defs.proto"; -import "edb_messages.proto"; -import "polygon_data.proto"; - - -service CellService { - // Creates a cell - rpc Create (CellCreationMessage) returns (EDBObjMessage) {} - - // Gets the layout of the provided cell - rpc GetLayout (EDBObjMessage) returns (EDBObjMessage) {} - - // Get the flattened layout - rpc GetFlattenedLayout (EDBObjMessage) returns (EDBObjMessage) {} - - // Find cell by name or id - rpc Find (CellFindMessage) returns (EDBObjMessage) {} - - // Delete a cell - rpc Delete (EDBObjMessage) returns (google.protobuf.Empty) {} - - // Get the database - rpc GetDatabase (EDBObjMessage) returns (EDBObjMessage) {} - - // Get whether the cell is of type footprint - rpc IsFootprint (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Get whether the cell is a black box - rpc IsBlackBox (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set whether the cell is a black box - rpc SetBlackBox (BoolPropertyMessage) returns (google.protobuf.Empty) {} - - // Get whether the cell supresses pads - rpc GetSuppressPads (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set whether the cell supresses pads - rpc SetSuppressPads (BoolPropertyMessage) returns (google.protobuf.Empty) {} - - // Get whether the anti pads is always on - rpc GetAntiPadsAlwaysOn (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set whether the anti pads is always on - rpc SetAntiPadsAlwaysOn (BoolPropertyMessage) returns (google.protobuf.Empty) {} - - // Get the option for anti pads - rpc GetAntiPadsOption (EDBObjMessage) returns (google.protobuf.Int64Value) {} - - // Set the option for anti pads - rpc SetAntiPadsOption (IntPropertyMessage) returns (google.protobuf.Empty) {} - - // Get whether the cell is a symbolic footprint - rpc IsSymbolicFootprint (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Get the name of the cell - rpc GetName (EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Set the name of the cell - rpc SetName (StringPropertyMessage) returns (google.protobuf.Empty) {} - - // Get the cell's design mode - rpc GetDesignMode (EDBObjMessage) returns (DesignModeMessage) {} - - // Set the cell's design mode - rpc SetDesignMode (DesignModePropertyMessage) returns (google.protobuf.Empty) {} - - // Get HFSS extent info - rpc GetHfssExtentInfo (EDBObjMessage) returns (HfssExtentInfoMessage) {} - - // Set HFSS extent info - rpc SetHfssExtentInfo (CellSetHfssExtentsMessage) returns (google.protobuf.Empty) {} - - // Get temperature settings - rpc GetTemperatureSettings (EDBObjMessage) returns (TemperatureSettingsMessage) {} - - // Set temperature settings - rpc SetTemperatureSettings (CellSetTemperatureSettingsMessage) returns (google.protobuf.Empty) {} - - // Cut out a polygon - rpc CutOut (CellCutOutMessage) returns (EDBObjMessage) {} - - // Get a list of property ids. - rpc GetProductPropertyIds (GetProductPropertyIdsMessage) returns (ProductPropertyIdsMessage) {} - - // Get product properies - rpc GetProductProperty (GetProductPropertyMessage) returns (google.protobuf.StringValue) {} - - // Set a product property value - rpc SetProductProperty (SetProductPropertyMessage) returns (google.protobuf.Empty) {} - - // Delete a simulation setup by name - rpc DeleteSimulationSetup (StringPropertyMessage) returns (google.protobuf.Empty) {} - - // Get simulation setups - rpc GetSimulationSetups (EDBObjMessage) returns (EDBObjCollectionMessage) {} - - // Generate auto HFSS regions - rpc GenerateAutoHFSSRegions (EDBObjMessage) returns (google.protobuf.Empty) {} - - // Generate via smart box - rpc GenerateViaSmartBox (StringPropertyMessage) returns (PolygonDataListMessage) {} -} - -message CellCreationMessage { - EDBObjMessage database = 1; - CellType type = 2; - string name = 3; -} - -message CellSetHfssExtentsMessage { - EDBObjMessage cell = 1; - HfssExtentInfoMessage info = 2; -} - -message CellCutOutMessage { - EDBObjMessage cell = 1; - EDBObjCollectionMessage included_nets = 2; - EDBObjCollectionMessage clipped_nets = 3; - PolygonDataMessage clipping_polygon = 4; - bool clean_clipping = 5; -} - -message CellFindMessage { - EDBObjMessage database = 1; - CellType type = 2; - oneof query { - string name = 3; - sint64 id = 4; - } -} - -message CellSetTemperatureSettingsMessage { - EDBObjMessage cell = 1; - TemperatureSettingsMessage temp_settings = 2; -} diff --git a/protos/ansys/api/edb/v1/cell_instance.proto b/protos/ansys/api/edb/v1/cell_instance.proto deleted file mode 100644 index 8c4e9539a7..0000000000 --- a/protos/ansys/api/edb/v1/cell_instance.proto +++ /dev/null @@ -1,58 +0,0 @@ -// Proto file representing the Cell Instance class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "hierarchy_obj.proto"; -import "transform3d.proto"; - -// CellInstance Service definition -service CellInstanceService { - // Create a cellinstance with ref layout - rpc Create(CellInstanceCreationMessage) returns (EDBObjMessage) {} - - // Create a cellinstance with component - rpc CreateWithComponent(CellInstanceCreationMessage) returns (EDBObjMessage) {} - - // Finds a cellinstance by name in the given layout - rpc FindByName(ObjectNameInLayoutMessage) returns (EDBObjMessage) {} - - // Get the reference layout - rpc GetReferenceLayout(EDBObjMessage) returns (EDBObjMessage) {} - - // Terminal Instances - rpc GetTermInsts(EDBObjMessage) returns (EDBObjCollectionMessage) {} - - // Get if component is 3dplaced - rpc GetIs3DPlacement(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set if component is 3dplaced - rpc Set3DPlacement(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - // Get 3d transform values - rpc Get3DTransform(EDBObjMessage) returns (EDBObjMessage) {} - - // Set 3d transform values - rpc Set3DTransform(PointerPropertyMessage) returns (google.protobuf.Empty) {} - - // Get Parameter Override - rpc GetParameterOverride(StringPropertyMessage) returns (ValueMessage) {} - - // Set Parameter Override - rpc SetParameterOverride(CellInstanceParameterOverride) returns (google.protobuf.Empty) {} -} - -message CellInstanceCreationMessage { - ObjectNameInLayoutMessage target = 1; - EDBObjMessage ref = 2; -} - -message CellInstanceParameterOverride { - EDBObjMessage target = 1; - string pname = 2; - ValueMessage pval = 3; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/circle.proto b/protos/ansys/api/edb/v1/circle.proto deleted file mode 100644 index e71a7a68b4..0000000000 --- a/protos/ansys/api/edb/v1/circle.proto +++ /dev/null @@ -1,53 +0,0 @@ -// Proto file representing the EDB Circle class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; -import "polygon_data.proto"; - -// Circle service definition -service CircleService { - // Create a circle - rpc Create (CircleCreationMessage) returns (EDBObjMessage) {} - - // Render Circle - rpc Render(CircleRenderMessage) returns (PolygonDataMessage) {} - - // Get Parameters - rpc GetParameters(EDBObjMessage) returns (CircleParametersMessage) {} - - // Set Parameters - rpc SetParameters(SetCircleParametersMessage) returns (google.protobuf.Empty) {} -} - -// Message for Create -message CircleCreationMessage { - EDBObjMessage layout = 1; - LayerRefMessage layer = 2; - NetRefMessage net = 3; - ValueMessage center_x = 4; - ValueMessage center_y = 5; - ValueMessage radius = 6; -} - -// Message for Render -message CircleRenderMessage{ - ValueMessage center_x = 1; - ValueMessage center_y = 2; - ValueMessage radius = 3; - bool is_hole = 4; -} - -message CircleParametersMessage{ - ValueMessage center_x = 1; - ValueMessage center_y = 2; - ValueMessage radius = 3; -} - -message SetCircleParametersMessage { - EDBObjMessage target = 1; - CircleParametersMessage parameters = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/component_def.proto b/protos/ansys/api/edb/v1/component_def.proto deleted file mode 100644 index 5d52958b56..0000000000 --- a/protos/ansys/api/edb/v1/component_def.proto +++ /dev/null @@ -1,43 +0,0 @@ -// Proto file representing the Component definition class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -// Component Definition Service -service ComponentDefService { - // Create a component def in the given database - rpc Create(ComponentDefCreateMessage) returns (EDBObjMessage) {} - - // Find a component def in the given database - rpc FindByName(EDBObjNameMessage) returns (EDBObjMessage) {} - - // Set the name of the component def - rpc SetName(StringPropertyMessage) returns (google.protobuf.Empty) {} - - // Get the name of the component def - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Set the footprint name for the component def - rpc SetFootprintCell(EDBObjPairMessage) returns (google.protobuf.Empty) {} - - // Get the footprint name of the component def - rpc GetFootprintCell(EDBObjMessage) returns (EDBObjMessage) {} - - // Get the component models owned by this component def - rpc GetComponentModels(EDBObjMessage) returns (EDBObjCollectionMessage) {} - - // Get the component pins owned by this component def. - rpc GetComponentPins(EDBObjMessage) returns (EDBObjCollectionMessage) {} -} - - -message ComponentDefCreateMessage { - EDBObjMessage db = 1; - string comp_name = 2; - EDBObjMessage fp = 3; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/component_group.proto b/protos/ansys/api/edb/v1/component_group.proto deleted file mode 100644 index f4548de296..0000000000 --- a/protos/ansys/api/edb/v1/component_group.proto +++ /dev/null @@ -1,48 +0,0 @@ -// Proto file representing the EDB Component Group class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "hierarchy_obj.proto"; - - -// Component Group service definition -service ComponentGroupService { - // Create a component group - rpc Create(ComponentGroupCreateMessage) returns (EDBObjMessage) {} - - // Get number of pins in the component group - rpc GetNumberOfPins(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - - // Get component property - rpc GetComponentProperty(EDBObjMessage) returns (EDBObjMessage) {} - - // Set component property - rpc SetComponentProperty(PointerPropertyMessage) returns (google.protobuf.Empty) {} - - // Get component types - rpc GetComponentType(EDBObjMessage) returns (ComponentTypeMessage) {} - - // Set component type - rpc SetComponentType(SetComponentGroupTypeMessage) returns (google.protobuf.Empty) {} - - // Find component group by component definition - rpc FindByDef(ObjectNameInLayoutMessage) returns (EDBObjCollectionMessage) {} -} - -message ComponentGroupCreateMessage { - ObjectNameInLayoutMessage target = 1; - string comp = 2; -} - -message SetComponentGroupTypeMessage { - EDBObjMessage target = 1; - ComponentTypeMessage comp_type = 2; -} - - - diff --git a/protos/ansys/api/edb/v1/component_model.proto b/protos/ansys/api/edb/v1/component_model.proto deleted file mode 100644 index dcb7828b58..0000000000 --- a/protos/ansys/api/edb/v1/component_model.proto +++ /dev/null @@ -1,35 +0,0 @@ -// Proto file representing the Component Model class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -// Component Definition Service -service ComponentModelService { - // Set reference file - rpc SetReferenceFile(StringPropertyMessage) returns (google.protobuf.Empty) {} - - // Get reference file - rpc GetReferenceFile(EDBObjMessage) returns (google.protobuf.StringValue) {} -} - -service NPortComponentModelService { - // Create nport component model - rpc Create(google.protobuf.StringValue) returns (EDBObjMessage) {} -} - -service DynamicLinkComponentModelService { - // Create dynamic link component model - rpc Create(google.protobuf.StringValue) returns (EDBObjMessage) {} - - // Set design name - rpc SetDesignName(StringPropertyMessage) returns (google.protobuf.Empty) {} - - // Get design name - rpc GetDesignName(EDBObjMessage) returns (google.protobuf.StringValue) {} -} - diff --git a/protos/ansys/api/edb/v1/component_pin.proto b/protos/ansys/api/edb/v1/component_pin.proto deleted file mode 100644 index 26c16076e6..0000000000 --- a/protos/ansys/api/edb/v1/component_pin.proto +++ /dev/null @@ -1,30 +0,0 @@ -// Proto file representing the Component Pin class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -// Component Pin Service -service ComponentPinService { - // Create a component pin inside the given component def - rpc Create(EDBObjNameMessage) returns (EDBObjMessage) {} - - // Find component pin by name in the given component def - rpc FindByName(EDBObjNameMessage) returns (EDBObjMessage) {} - - // Set component pin name - rpc SetName(StringPropertyMessage) returns (google.protobuf.Empty) {} - - // Get component pin name - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Get the number of the pin in the component def it belongs to - rpc GetNumber(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - - // Get component def this pin belongs to - rpc GetComponentDef(EDBObjMessage) returns (EDBObjMessage) {} -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/component_property.proto b/protos/ansys/api/edb/v1/component_property.proto deleted file mode 100644 index 4e81d2e03e..0000000000 --- a/protos/ansys/api/edb/v1/component_property.proto +++ /dev/null @@ -1,33 +0,0 @@ -// Proto file representing the EDB Component Property class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "model.proto"; - -// Component Property service definition -service ComponentPropertyService { - // Clone a component property - rpc Clone(EDBObjMessage) returns (EDBObjMessage) {} - - // Get/Set Package mounting offset - rpc GetPackageMountingOffset(EDBObjMessage) returns (ValueMessage) {} - rpc SetPackageMountingOffset(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - // Get/Set Package def - rpc GetPackageDef(EDBObjMessage) returns (EDBObjMessage) {} - rpc SetPackageDef(PointerPropertyMessage) returns (google.protobuf.Empty) {} - - // Get/Set Model - rpc GetModel(EDBObjMessage) returns (ComponentPropModelMessage) {} - rpc SetModel(PointerPropertyMessage) returns (google.protobuf.Empty) {} -} - -message ComponentPropModelMessage { - EDBObjMessage model = 1; - ModelType model_type = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/connectable.proto b/protos/ansys/api/edb/v1/connectable.proto deleted file mode 100644 index b6796428fe..0000000000 --- a/protos/ansys/api/edb/v1/connectable.proto +++ /dev/null @@ -1,54 +0,0 @@ -// Proto file representing the Cell Instance class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "refs.proto"; -import "layout_obj.proto"; - -// Connectable Service definition -service ConnectableService { - - // Gets the layout object type. - rpc GetObjType(EDBObjMessage) returns (LayoutObjTypeMessage) {} - - // Find a Connectable object by Database ID and type. - rpc FindByIdAndType(FindByIdLayoutObjMessage) returns (EDBObjMessage) {} - - // Get the unique, persistent ID for the Connectable object. - rpc GetId(EDBObjMessage) returns (EDBInternalIdMessage) {} - - // Gets the Component of the connectable object. - rpc GetComponent(EDBObjMessage) returns (EDBObjMessage) {} - - // Gets the group of the connectable object. - rpc GetGroup(EDBObjMessage) returns (EDBObjMessage) {} - - // Sets the group of the connectable object. - rpc SetGroup(PointerPropertyMessage) returns (google.protobuf.Empty) {} - - // Gets the net of the connectable object. - rpc GetNet(EDBObjMessage) returns (EDBObjMessage) {} - - // Sets the net of the connectable object. - rpc SetNet(SetNetMessage) returns (google.protobuf.Empty) {} - } - -message LayoutObjTypeMessage { - LayoutObjType type = 1; -} - -message FindByIdLayoutObjMessage { - EDBObjMessage layout = 1; - LayoutObjType type = 2; - EDBInternalIdMessage id_msg = 3; -} - -message SetNetMessage { - EDBObjMessage target = 1; - NetRefMessage net = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/database.proto b/protos/ansys/api/edb/v1/database.proto deleted file mode 100644 index 36e5b15dce..0000000000 --- a/protos/ansys/api/edb/v1/database.proto +++ /dev/null @@ -1,120 +0,0 @@ -// Proto file representing the EDB Database class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "bondwire.proto"; -import "definition_obj.proto"; - -enum AccessLevel { - ACCESS_LEVEL_NO_ACCESS = 0; - ACCESS_LEVEL_READ_ACCESS = 1; - ACCESS_LEVEL_WRITE_ACCESS = 2; -} - -service DatabaseService { - // Creates a database - rpc Create (google.protobuf.StringValue) returns (EDBObjMessage) {} - - // Opens a database - rpc Open (OpenDatabaseMessage) returns (EDBObjMessage) {} - - // Deletes a database - rpc Delete (google.protobuf.StringValue) returns (google.protobuf.Empty) {} - - // Saves a database - rpc Save (EDBObjMessage) returns (google.protobuf.Empty) {} - - // Closes a database - rpc Close (EDBObjMessage) returns (google.protobuf.Empty) {} - - // Determines whether the database is read only - rpc IsReadOnly(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Gets the top circuits in a database - rpc GetTopCircuits (EDBObjMessage) returns (EDBObjCollectionMessage) {} - - // Gets the id of a database - rpc GetId (EDBObjMessage) returns (google.protobuf.Int64Value) {} - - // Finds a database with the provided id - rpc FindById (google.protobuf.Int64Value) returns (EDBObjMessage) {} - - // Save the database to new location and optionaly to older edb version - rpc SaveAs (SaveAsDatabaseMessage) returns (google.protobuf.Empty) {} - - // Get EDB version by release name - rpc GetVersionByRelease (google.protobuf.StringValue) returns (google.protobuf.StringValue) {} - - // Get the directory of the Database - rpc GetDirectory (EDBObjMessage) returns (google.protobuf.StringValue) {} - - rpc GetProductProperty(GetProductPropertyMessage) returns (google.protobuf.StringValue) {} - rpc SetProductProperty(SetProductPropertyMessage) returns (google.protobuf.Empty) {} - rpc GetProductPropertyIds(GetProductPropertyIdsMessage) returns (ProductPropertyIdsMessage) {} - - rpc ImportMaterialFromControlFile(ImportMaterialFromControlFileMessage) returns (google.protobuf.Empty) {} - rpc GetVersion(EDBObjMessage) returns (GetVersionMessage) {} - rpc Scale(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSource(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetSource(EDBObjNameMessage) returns (google.protobuf.Empty) {} - rpc GetSourceVersion(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetSourceVersion(EDBObjNameMessage) returns (google.protobuf.Empty) {} - - // copy cells - rpc CopyCells (CopyCellsMessage) returns (EDBObjCollectionMessage) {} - - // Get defs - rpc GetDefinitionObjs (GetDefinitionObjsMessage) returns (EDBObjCollectionMessage) {} - - // get cells - rpc TopCircuitCells (EDBObjMessage) returns (EDBObjCollectionMessage) {} - rpc GetCircuits (EDBObjMessage) returns (EDBObjCollectionMessage) {} - rpc GetFootprints (EDBObjMessage) returns (EDBObjCollectionMessage) {} - -} - -// Message for Open -message OpenDatabaseMessage { - string edb_path = 1; - bool read_only = 2; -} - -// Message for SaveAs -message SaveAsDatabaseMessage { - EDBObjMessage db = 1; - string new_location = 2; - string version = 3; -} - -// Message for ImportMaterialFromControlFile -message ImportMaterialFromControlFileMessage { - EDBObjMessage target = 1; - string file = 2; - oneof optional_schema_path { - string schema_path = 3; - } - bool append = 4; -} - -// Message for GetVersion -message GetVersionMessage { - EDBInternalIdMessage major = 1; - EDBInternalIdMessage minor = 2; -} - -// Message for CopyCells -message CopyCellsMessage { - EDBObjMessage target = 1; - EDBObjCollectionMessage cells = 2; -} - -// Message for CopyCells -message GetDefinitionObjsMessage { - EDBObjMessage target = 1; - DefinitionObjType type = 2; - BondwireType subtype = 3; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/dataset_def.proto b/protos/ansys/api/edb/v1/dataset_def.proto deleted file mode 100644 index b0fdf8942a..0000000000 --- a/protos/ansys/api/edb/v1/dataset_def.proto +++ /dev/null @@ -1,28 +0,0 @@ -// Proto file representing the EDB Database class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; - -service DatasetDefService { - // Creates a Dataset Definition - rpc Create (StringPropertyMessage) returns (EDBObjMessage) {} - - // Find Dataset Definition by name - rpc FindByName(EDBObjNameMessage) returns (EDBObjMessage) {} - - // Get Name of Dataset Definition - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Set Name of Dataset Definition - rpc SetName(StringPropertyMessage) returns (google.protobuf.Empty) {} - - // Get Data of Dataset Definition - rpc GetData(EDBObjMessage) returns (PointsMessage) {} - - // Set Data Dataset Definition - rpc SetData(PointsPropertyMessage) returns (google.protobuf.Empty) {} -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/debye_model.proto b/protos/ansys/api/edb/v1/debye_model.proto deleted file mode 100644 index 85a1ae45f2..0000000000 --- a/protos/ansys/api/edb/v1/debye_model.proto +++ /dev/null @@ -1,44 +0,0 @@ -// Proto file representing the DielectricMaterialModel class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -service DebyeModelService { - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - - rpc GetFrequencyRange(EDBObjMessage) returns (FrequencyRangeMessage) {} - rpc SetFrequencyRange(SetFrequencyRangeMessage) returns (google.protobuf.Empty) {} - - rpc GetRelativePermitivityAtHighLowFrequency(EDBObjMessage) returns (FrequencyRangeMessage) {} - rpc SetRelativePermitivityAtHighLowFrequency(SetFrequencyRangeMessage) returns (google.protobuf.Empty) {} - - rpc IsRelativePermitivityEnabledAtOpticalFrequency(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetRelativePermitivityEnabledAtOpticalFrequency(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRelativePermitivityAtOpticalFrequency(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetRelativePermitivityAtOpticalFrequency(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc UseDCConductivity(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseDCConductivity(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDCConductivity(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetDCConductivity(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetLossTangentAtHighLowFrequency(EDBObjMessage) returns (FrequencyRangeMessage) {} - rpc SetLossTangentAtHighLowFrequency(SetFrequencyRangeMessage) returns (google.protobuf.Empty) {} -} - -message FrequencyRangeMessage { - google.protobuf.DoubleValue low = 1; - google.protobuf.DoubleValue high = 2; -} - -message SetFrequencyRangeMessage { - EDBObjMessage target = 1; - FrequencyRangeMessage range = 2; -} diff --git a/protos/ansys/api/edb/v1/definition_obj.proto b/protos/ansys/api/edb/v1/definition_obj.proto deleted file mode 100644 index 6427546950..0000000000 --- a/protos/ansys/api/edb/v1/definition_obj.proto +++ /dev/null @@ -1,18 +0,0 @@ -// Proto file representing the base class of definition objects owned by EDB database objects - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Enum for definition object types -enum DefinitionObjType { - PADSTACK_DEF = 0; - COMPONENT_DEF = 1; - BONDWIRE_DEF = 2; - MATERIAL_DEF = 3; - DATASET_DEF = 4; - PACKAGE_DEF = 5; - DEFINITION_TYPE_COUNT = 6; - INVALID_DEFINITION_TYPE = -1; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/die_property.proto b/protos/ansys/api/edb/v1/die_property.proto deleted file mode 100644 index 9e0735eec8..0000000000 --- a/protos/ansys/api/edb/v1/die_property.proto +++ /dev/null @@ -1,55 +0,0 @@ -// Proto file representing the Die Property class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -enum DieOrientation { -DIE_ORIENTATION_CHIP_UP = 0; -DIE_ORIENTATION_CHIP_DOWN = 1; -} - -enum DieType { -DIE_TYPE_NONE = 0; -DIE_TYPE_FLIPCHIP = 1; -DIE_TYPE_WIREBOND = 2; -} - -// Die Property service definition -service DiePropertyService { - - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - rpc Clone(EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetDieType(EDBObjMessage) returns (DieTypeMessage) {} - rpc SetDieType(DieTypePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetHeight(EDBObjMessage) returns (ValueMessage) {} - rpc SetHeight(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetOrientation(EDBObjMessage) returns (DieOrientationMessage) {} - rpc SetOrientation(DieOrientationPropertyMessage) returns (google.protobuf.Empty) {} -} - - -message DieTypeMessage { - DieType die_type = 1; -} - -message DieTypePropertyMessage { - EDBObjMessage target = 1; - DieTypeMessage die_type = 2; -} - -message DieOrientationMessage { - DieOrientation die_orientation = 1; -} - -message DieOrientationPropertyMessage { - EDBObjMessage target = 1; - DieOrientationMessage die_orientation = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/dielectric_material_model.proto b/protos/ansys/api/edb/v1/dielectric_material_model.proto deleted file mode 100644 index 24fcdf7aed..0000000000 --- a/protos/ansys/api/edb/v1/dielectric_material_model.proto +++ /dev/null @@ -1,13 +0,0 @@ -// Proto file representing the DielectricMaterialModel class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -service DielectricMaterialModelService { - rpc GetType(EDBObjMessage) returns (google.protobuf.Int32Value) {} -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/differential_pair.proto b/protos/ansys/api/edb/v1/differential_pair.proto deleted file mode 100644 index c677afe76d..0000000000 --- a/protos/ansys/api/edb/v1/differential_pair.proto +++ /dev/null @@ -1,33 +0,0 @@ -// Proto file representing references to EDB Rlc classes - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; - -service DifferentialPairService { - // create a differential pair - rpc Create (DifferentialPairCreationMessage) returns (EDBObjMessage) {} - - // find a differential pair - rpc FindByName (StringPropertyMessage) returns (EDBObjMessage) {} - - // differential pair accessors - rpc GetDifferentialPair (EDBObjMessage) returns (DifferentialPairNetRefsMessage) {} - rpc SetDifferentialPair (DifferentialPairNetRefsMessage) returns (google.protobuf.Empty) {} -} - -message DifferentialPairCreationMessage { - EDBObjMessage layout = 1; - string name = 2; - NetRefMessage positive_net = 3; - NetRefMessage negative_net = 4; -} - -message DifferentialPairNetRefsMessage { - EDBObjMessage dp = 1; - NetRefMessage positive_net = 2; - NetRefMessage negative_net = 3; -} diff --git a/protos/ansys/api/edb/v1/djordjecvic_sarkar_model.proto b/protos/ansys/api/edb/v1/djordjecvic_sarkar_model.proto deleted file mode 100644 index 90785ab20b..0000000000 --- a/protos/ansys/api/edb/v1/djordjecvic_sarkar_model.proto +++ /dev/null @@ -1,31 +0,0 @@ -// Proto file representing the DielectricMaterialModel class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -service DjordjecvicSarkarModelService { - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - - rpc GetFrequency(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetFrequency(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRelativePermitivityAtFrequency(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetRelativePermitivityAtFrequency(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetLossTangentAtFrequency(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetLossTangentAtFrequency(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc UseDCRelativePermitivity(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseDCRelativePermitivity(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDCRelativePermitivity(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetDCRelativePermitivity(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDCConductivity(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetDCConductivity(DoublePropertyMessage) returns (google.protobuf.Empty) {} -} diff --git a/protos/ansys/api/edb/v1/edb_defs.proto b/protos/ansys/api/edb/v1/edb_defs.proto deleted file mode 100644 index af13106379..0000000000 --- a/protos/ansys/api/edb/v1/edb_defs.proto +++ /dev/null @@ -1,64 +0,0 @@ -// Proto file containing type definitions - -syntax = "proto3"; - -package ansys.api.edb.v1; - -enum ProductIdType { - DESIGNER = 0; - SI_WAVE = 1; - GENERIC_TRANSLATOR = 2; - USER_DEFINED = 3; - INVALID_PRODUCT = -1; -} - -enum DesignMode { - GENERAL_MODE = 0; - IC_MODE = 1; -} - -enum CellType { - CIRCUIT_CELL = 0; - FOOTPRINT_CELL = 1; -} - -enum GeometryExtentType { - BOUNDING_BOX = 0; - CONFORMING = 1; -} - -// Enum for SimulationSetup types -enum SimulationSetupType { - HFSS_SIM = 0; - SI_WAVE_SIM = 2; - SI_WAVE_DCIR_SIM = 9; - RAPTOR_X_SIM = 12; -} - -//------------------------------------------------------------------------------ -// HFSS Extents - -enum HfssExtentsType { - HFSS_EXTENT_BOUNDING_BOX = 0; - HFSS_EXTENT_CONFIRMING = 1; - HFSS_EXTENT_CONVEX_HULL = 2; - HFSS_EXTENT_POLYGON = 3; -} - -enum HfssExtentsOpenRegionType { - HFSS_EXTENT_RADIATION = 0; - HFSS_EXTENT_PML = 1; -} - -//------------------------------------------------------------------------------ -// Component - -enum ComponentType { - OTHER = 0; - RESISTOR = 1; - INDUCTOR = 2; - CAPACITOR = 3; - IC = 4; - IO = 5; - INVALID = -1; -} diff --git a/protos/ansys/api/edb/v1/edb_messages.proto b/protos/ansys/api/edb/v1/edb_messages.proto deleted file mode 100644 index ac95c05661..0000000000 --- a/protos/ansys/api/edb/v1/edb_messages.proto +++ /dev/null @@ -1,216 +0,0 @@ -// Proto file containing commonly used messages - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import public "google/protobuf/wrappers.proto"; -import public "google/protobuf/empty.proto"; - -import "edb_defs.proto"; - -//------------------------------------------------------------------------------ -// Value - -message ComplexMessage { - double real = 1; - double imag = 2; -} - -message ValueMessage { - string text = 1; - oneof _val { - ComplexMessage constant = 2; - EDBObjMessage variable_owner = 3; - } -} - -//------------------------------------------------------------------------------ -// Cell - -message DesignModeMessage { - DesignMode mode = 1; -} - -message DesignModePropertyMessage { - EDBObjMessage target = 1; - DesignMode mode = 2; -} - -//------------------------------------------------------------------------------ -// Temperature Settings - -message TemperatureSettingsMessage { - ValueMessage temperature = 1; - bool include_temp_dependence = 2; - bool enable_thermal_feedback = 3; -} - -//------------------------------------------------------------------------------ -// HFSS Extents - -message HfssExtentMessage { - double value = 1; - bool absolute = 2; -} - -message HfssExtentInfoMessage { - bool use_open_region = 1; - HfssExtentsType extent_type = 2; - HfssExtentsOpenRegionType open_region_type = 3; - EDBObjMessage base_polygon = 4; - HfssExtentsType dielectric_extent_type = 5; - EDBObjMessage dielectric_base_polygon = 6; - HfssExtentMessage dielectric = 7; - bool honor_user_dielectric = 8; - bool airbox_truncate_at_ground = 9; - HfssExtentMessage airbox_horizontal = 10; - HfssExtentMessage airbox_vertical_positive = 11; - HfssExtentMessage airbox_vertical_negative = 12; - bool sync_airbox_vertical_extent = 13; - bool is_pml_visible = 14; - ValueMessage operating_frequency = 15; - ValueMessage radiation_level = 16; - bool user_xy_data_extent_for_vertical_expansion = 17; -} - -//------------------------------------------------------------------------------ -// Component - -message ComponentTypeMessage { - ComponentType comp_type = 1; -} - -//------------------------------------------------------------------------------ -// Helpers - -message EDBObjMessage { - uint64 impl_ptr_address = 1; - uint64 id = 2; -} - -// Message containing a collection of edb objects -message EDBObjCollectionMessage { - repeated EDBObjMessage items = 1; -} - -// Message representing an arbitrary edb object and a name -message EDBObjNameMessage { - EDBObjMessage target = 1; - string name = 2; -} - -message IntPropertyMessage { - EDBObjMessage target = 1; - int64 value = 2; -} - -message BoolPropertyMessage { - EDBObjMessage target = 1; - bool value = 2; -} - -message StringPropertyMessage { - EDBObjMessage target = 1; - string value = 2; -} - -message PointerPropertyMessage { - EDBObjMessage target = 1; - EDBObjMessage value = 2; -} - -message ProductPropertyIdMessage { - ProductIdType product_id = 1; - uint64 attribute_id = 2; -} - -message GetProductPropertyMessage { - EDBObjMessage edb_obj = 1; - ProductPropertyIdMessage product_prop_id = 2; -} - -message DoublePropertyMessage { - EDBObjMessage target = 1; - double value = 2; -} - -message ValuePropertyMessage { - EDBObjMessage target = 1; - ValueMessage value = 2; -} - -message SetProductPropertyMessage { - EDBObjMessage edb_obj = 1; - ProductPropertyIdMessage product_prop_id = 2; - string property_value = 3; -} - -message GetProductPropertyIdsMessage { - EDBObjMessage edb_obj = 1; - ProductIdType product_id = 2; -} - -message ProductPropertyIdsMessage { - repeated uint64 ids = 1; -} - -message IntegersPropertyMessage { - repeated uint64 props = 1; -} - -message EDBInternalIdMessage { - uint64 id = 1; -} - -message StringsMessage { - repeated string strings = 1; -} - -message StringsPropertyMessage { - EDBObjMessage edb_obj = 1; - repeated string strings = 2; -} - -message EDBObjPairMessage { - EDBObjMessage edb_obj_0 = 1; - EDBObjMessage edb_obj_1 = 2; -} - -message StringPairMessage { - string first = 1; - string second = 2; -} - -message StringPairsMessage { - repeated StringPairMessage pairs = 1; -} - -message StringPairPropertyMessage { - EDBObjMessage target = 1; - StringPairMessage values = 2; -} - -message ValuePairMessage { - ValueMessage val1 = 1; - ValueMessage val2 = 2; -} - -message ValuePairPropertyMessage { - EDBObjMessage target = 1; - ValuePairMessage values = 2; -} - -message UInt64PropertyMessage { - EDBObjMessage target = 1; - uint64 value = 2; -} - -message DoublesMessage { - repeated double doubles = 1; -} - -message DoublesPropertyMessage { - EDBObjMessage edb_obj = 1; - repeated double doubles = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/edge_term.proto b/protos/ansys/api/edb/v1/edge_term.proto deleted file mode 100644 index 0d00c39135..0000000000 --- a/protos/ansys/api/edb/v1/edge_term.proto +++ /dev/null @@ -1,73 +0,0 @@ -// Proto file representing the EDB Edge Term class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "arc_data.proto"; -import "point_data.proto"; -import "refs.proto"; - -enum EdgeType -{ - PRIMITIVE_EDGE = 0; - PAD_EDGE = 1; -} - -service EdgeService { - - rpc GetEdgeType (EDBObjMessage) returns (EdgeTypeMessage) {} - - rpc Create (EdgeCreationMessage) returns (EDBObjMessage) {} - - rpc GetParameters (EDBObjMessage) returns (EdgeParamsMessage) {} -} - -service EdgeTerminalService { - rpc Create (EdgeTermCreationMessage) returns (EDBObjMessage) {} - - rpc GetEdges (EDBObjMessage) returns (EDBObjCollectionMessage) {} - - rpc SetEdges (EdgeTermSetEdgesMessage) returns (google.protobuf.Empty) {} -} - -message EdgeTypeMessage { - EdgeType t = 1; -} - -message EdgeCreationMessage { - EdgeType edge_type = 1; - EdgeParamsMessage params = 2; -} - -message EdgeParamsMessage { - oneof type { - PrimitiveEdgeParamsMessage primitve_params = 1; - PadEdgeParamsMessage pad_params = 2; - } -} - -message PrimitiveEdgeParamsMessage { - EDBObjMessage primitive = 1; - PointMessage point = 2; -} - -message PadEdgeParamsMessage { - EDBObjMessage padstack = 1; - LayerRefMessage layer = 2; - ArcMessage arc = 3; -} - -message EdgeTermCreationMessage { - EDBObjMessage layout = 1; - NetRefMessage net = 2; - string name = 3; - repeated EDBObjMessage edges = 4; - bool is_ref = 5; -} - -message EdgeTermSetEdgesMessage { - EDBObjMessage term = 1; - repeated EDBObjMessage edges = 2; -} diff --git a/protos/ansys/api/edb/v1/extended_net.proto b/protos/ansys/api/edb/v1/extended_net.proto deleted file mode 100644 index 39e5d746dc..0000000000 --- a/protos/ansys/api/edb/v1/extended_net.proto +++ /dev/null @@ -1,34 +0,0 @@ -// Proto file representing the Extended Net class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service ExtendedNetService { - rpc Create (ExtendedNetCreationMessage) returns (EDBObjMessage) {} - - rpc FindByName(ExtendedNetLookupMessage) returns (EDBObjMessage) {} - - rpc RemoveNet(ExtendedNetModifyMessage) returns (google.protobuf.Empty) {} - - rpc AddNet(ExtendedNetModifyMessage) returns (google.protobuf.Empty) {} - - rpc RemoveAllNets(EDBObjMessage) returns (google.protobuf.Empty) {} -} - -message ExtendedNetCreationMessage { - EDBObjMessage layout = 1; - string name = 2; -} - -message ExtendedNetLookupMessage { - EDBObjMessage layout = 1; - string name = 2; -} - -message ExtendedNetModifyMessage { - EDBObjMessage ext_net = 1; - EDBObjMessage net = 2; -} diff --git a/protos/ansys/api/edb/v1/group.proto b/protos/ansys/api/edb/v1/group.proto deleted file mode 100644 index 1468379564..0000000000 --- a/protos/ansys/api/edb/v1/group.proto +++ /dev/null @@ -1,49 +0,0 @@ -// Proto file representing the EDB Group class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "hierarchy_obj.proto"; - -// Group service definition -service GroupService { - // Create a group - rpc Create(ObjectNameInLayoutMessage) returns (EDBObjMessage) {} - - // Finds a group by name in the given layout - rpc FindByName(ObjectNameInLayoutMessage) returns (EDBObjMessage) {} - - // Add a member to the group - rpc AddMember(GroupModifyMemberMessage) returns (google.protobuf.Empty) {} - - // Remove a member from the group - rpc RemoveMember(GroupModifyMemberMessage) returns (google.protobuf.Empty) {} - - // Ungroup this group - rpc Ungroup(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - // Get iterable for group members - rpc GetMembers(EDBObjMessage) returns (EDBObjCollectionMessage) {} - - // Get the type of the group - rpc GetGroupType(EDBObjMessage) returns (GroupTypeMessage) {} -} - -message GroupModifyMemberMessage { - EDBObjMessage target = 1; - EDBObjMessage member = 2; -} - -message GroupTypeMessage { - enum GroupType { - GROUP = 0; - COMPONENT = 1; - STRUCTURE_3D = 2; - VIA_GROUP = 3; - } - GroupType group_type = 1; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/hfss_simulation_settings.proto b/protos/ansys/api/edb/v1/hfss_simulation_settings.proto deleted file mode 100644 index 14633d72dd..0000000000 --- a/protos/ansys/api/edb/v1/hfss_simulation_settings.proto +++ /dev/null @@ -1,223 +0,0 @@ -// Proto file representing hfss simulation setup settings - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -enum BasisFunctionOrder { - ZERO_ORDER = 0; - FIRST_ORDER = 1; - SECOND_ORDER = 2; - MIXED_ORDER = 3; -} - -enum SolverType { - AUTO_SOLVER = 0; - DIRECT_SOLVER = 1; - ITERATIVE_SOLVER = 2; - NUM_SOLVER_TYPES = 3; -} - -enum AdaptType -{ - SINGLE = 0; - MULTI_FREQUENCIES = 1; - BROADBAND = 2; - NUM_ADAPT_TYPE = 3; -}; - -// General settings -service HFSSGeneralSettingsService { - rpc GetSingleFrequencyAdaptiveSolution(EDBObjMessage) returns (SingleFrequencyAdaptiveSolutionMessage) {} - rpc SetSingleFrequencyAdaptiveSolution(SingleFrequencyAdaptiveSolutionPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMultiFrequencyAdaptiveSolution(EDBObjMessage) returns (MultiFrequencyAdaptiveSolutionMessage) {} - rpc SetMultiFrequencyAdaptiveSolution(MultiFrequencyAdaptiveSolutionPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetBroadbandFrequencyAdaptiveSolution(EDBObjMessage) returns (BroadbandFrequencyAdaptiveSolutionMessage) {} - rpc SetBroadbandFrequencyAdaptiveSolution(BroadbandFrequencyAdaptiveSolutionPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSaveFieldsFlag(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetSaveFieldsFlag(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseMeshRegion(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseMeshRegion(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMeshRegionName(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMeshRegionName(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseParallelRefinement(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseParallelRefinement(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetAdaptType(EDBObjMessage) returns (AdaptTypeMessage) {} - rpc SetAdaptType(AdaptTypePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSaveRadFieldsOnlyFlag(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetSaveRadFieldsOnlyFlag(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -message AdaptTypeMessage { - AdaptType adapt_type = 1; -} - -message AdaptTypePropertyMessage { - EDBObjMessage target = 1; - AdaptType adapt_type = 2; -} - -message AdaptiveFrequencyDataMessage { - string adaptive_frequency = 1; - string max_delta = 2; -} - -message MatrixConvergenceEntryMessage { - string port_1 = 1; - string port_2 = 2; - double mag_limit = 3; - double phase_limit = 4; -} - -message MatrixConvergenceDataMessage { - bool all_are_constant = 1; - bool all_diag_are_constant = 2; - bool all_off_diag_are_constant = 3; - double mag_min_threashold = 4; - repeated MatrixConvergenceEntryMessage entries = 5; -} - -message SingleFrequencyAdaptiveSolutionMessage { - AdaptiveFrequencyDataMessage adaptive_frequency = 1; - uint64 max_passes = 2; - MatrixConvergenceDataMessage matrix_conv_data = 3; - bool use_matrix_conv_data = 4; -} - -message SingleFrequencyAdaptiveSolutionPropertyMessage { - EDBObjMessage target = 1; - SingleFrequencyAdaptiveSolutionMessage adaptive_frequency = 2; -} - -message AdaptiveMultiFrequencyDataMessage { - AdaptiveFrequencyDataMessage adaptive_frequency = 1; - map output_variables = 2; -} - -message MultiFrequencyAdaptiveSolutionMessage { - repeated AdaptiveMultiFrequencyDataMessage adaptive_frequencies = 1; - uint64 max_passes = 2; -} - -message MultiFrequencyAdaptiveSolutionPropertyMessage { - EDBObjMessage target = 1; - MultiFrequencyAdaptiveSolutionMessage adaptive_frequency = 2; -} - -message BroadbandFrequencyAdaptiveSolutionMessage { - string max_delta = 1; - uint64 max_passes = 2; - string low_frequency = 3; - string high_frequency = 4; -} - -message BroadbandFrequencyAdaptiveSolutionPropertyMessage { - EDBObjMessage target = 1; - BroadbandFrequencyAdaptiveSolutionMessage adaptive_frequency = 2; -} - -// HFSS Options -service HFSSOptionsSettingsService { - rpc GetMaxRefinementPerPass(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMaxRefinementPerPass(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinPasses(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMinPasses(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinConvergedPasses(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMinConvergedPasses(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseMaxRefinement(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseMaxRefinement(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetBasisFunctionOrder(EDBObjMessage) returns (BasisFunctionOrderMessage) {} - rpc SetBasisFunctionOrder(BasisFunctionOrderPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSolverTypeOrder(EDBObjMessage) returns (SolverTypeMessage) {} - rpc SetSolverTypeOrder(SolverTypePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRelativeResidual(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetRelativeResidual(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetEnhancedLowFrequencyAccuracy(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetEnhancedLowFrequencyAccuracy(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -message BasisFunctionOrderMessage { - BasisFunctionOrder basis_function_order = 1; -} - -message BasisFunctionOrderPropertyMessage { - EDBObjMessage target = 1; - BasisFunctionOrder basis_function_order = 2; -} - -message SolverTypeMessage { - SolverType solver_type = 1; -} - -message SolverTypePropertyMessage { - EDBObjMessage target = 1; - SolverType solver_type = 2; -} - -// HFSS Advanced -service HFSSAdvancedSettingsService { - rpc GetICModeAutoResolution(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetICModeAutoResolution(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetICModeLength(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetICModeLength(StringPropertyMessage) returns (google.protobuf.Empty) {} -} - -// HFSS Advanced Meshing -service HFSSAdvancedMeshingSettingsService { - rpc GetLayerAlignment(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetLayerAlignment(StringPropertyMessage) returns (google.protobuf.Empty) {} -} - -// Solver settings -service HFSSSolverSettingsService { - rpc GetMaxDeltaZ0(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetMaxDeltaZ0(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSetTrianglesForWaveport(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetSetTrianglesForWaveport(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinTrianglesForWavePort(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMinTrianglesForWavePort(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaxTrianglesForWavePort(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMaxTrianglesForWavePort(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetIntraPlaneCouplingEnabled(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIntraPlaneCouplingEnabled(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -// HFSS DCR -service DCRSettingsService { - rpc GetMaxPasses(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMaxPasses(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinPasses(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMinPasses(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinConvergedPasses(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMinConvergedPasses(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPercentError(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetPercentError(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPercentRefinementPerPass(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetPercentRefinementPerPass(DoublePropertyMessage) returns (google.protobuf.Empty) {} -} diff --git a/protos/ansys/api/edb/v1/hfss_simulation_setup.proto b/protos/ansys/api/edb/v1/hfss_simulation_setup.proto deleted file mode 100644 index 3919614dd3..0000000000 --- a/protos/ansys/api/edb/v1/hfss_simulation_setup.proto +++ /dev/null @@ -1,58 +0,0 @@ -// Proto file representing hfss simulation setup - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service HfssSimulationSetupService { - rpc GetMeshOperations (EDBObjMessage) returns (MeshOperationsMessage) {} - - rpc SetMeshOperations (MeshOperationsPropertyMessage) returns (google.protobuf.Empty) {} -} - -// Message for MeshOperation net layer info -message MeshOpNetLayerInfoMessage { - string net = 1; - string layer = 2; - bool is_sheet = 3; -} - -// Message containing skin depth operation specific attributes -message SkinDepthMeshOperationMessage { - string skin_depth = 1; - string surface_triangle_length = 2; - string num_layers = 3; - string max_elements = 4; - bool restrict_max_elements = 5; -} - -// Message containing length operation specific attributes -message LengthMeshOperationMessage { - string max_length = 1; - bool restrict_length = 2; - string max_elements = 3; - bool restrict_max_elements = 4; -} - -message MeshOperationMessage { - string name = 1; - bool enabled = 2; - bool refine_inside = 3; - string mesh_region = 4; - repeated MeshOpNetLayerInfoMessage net_layer_info = 5; - oneof mesh_operation_sub_type { - SkinDepthMeshOperationMessage skin_depth_mesh_op = 6; - LengthMeshOperationMessage length_mesh_op = 7; - } -} - -message MeshOperationsMessage { - repeated MeshOperationMessage mesh_ops = 1; -} - -message MeshOperationsPropertyMessage { - EDBObjMessage target = 1; - MeshOperationsMessage mesh_ops = 2; -} diff --git a/protos/ansys/api/edb/v1/hierarchy_obj.proto b/protos/ansys/api/edb/v1/hierarchy_obj.proto deleted file mode 100644 index 6bf0adf557..0000000000 --- a/protos/ansys/api/edb/v1/hierarchy_obj.proto +++ /dev/null @@ -1,56 +0,0 @@ -// Proto file representing the EDB hierarchy objects class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "point_data.proto"; -import "transform.proto"; - -// Hierarchy object service definition -service HierarchyObjectService { - // Get Transform - rpc GetTransform(EDBObjMessage) returns (TransformMessage) {} - - // Set Transform - rpc SetTransform(TransformPropertyMessage) returns (google.protobuf.Empty) {} - - // Get Name - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Set Name - rpc SetName(EDBObjNameMessage) returns (google.protobuf.Empty) {} - - // Get Component - rpc GetComponent(EDBObjMessage) returns (EDBObjMessage) {} - - // Get Placement Layer - rpc GetPlacementLayer(EDBObjMessage) returns (EDBObjMessage) {} - - // Set Placement Layer - rpc SetPlacementLayer(PointerPropertyMessage) returns (google.protobuf.Empty) {} - - // Get Location - rpc GetLocation(EDBObjMessage) returns (PointMessage) {} - - // Set Location - rpc SetLocation(PointPropertyMessage) returns (google.protobuf.Empty) {} - - // Get Solve Independent Preference - rpc GetSolveIndependentPreference(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set Solve Independent Preference - rpc SetSolveIndependentPreference(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -message ObjectNameInLayoutMessage { - EDBObjMessage layout = 1; - string name = 2; -} - - - - diff --git a/protos/ansys/api/edb/v1/ic_component_property.proto b/protos/ansys/api/edb/v1/ic_component_property.proto deleted file mode 100644 index cb828fb178..0000000000 --- a/protos/ansys/api/edb/v1/ic_component_property.proto +++ /dev/null @@ -1,27 +0,0 @@ -// Proto file representing the EDB IC Component Property class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -// IC Component Property service definition -service ICComponentPropertyService { - // Create IC Component Property - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - - // Get/Set the solder ball property - rpc SetSolderBallProperty(PointerPropertyMessage) returns (google.protobuf.Empty) {} - rpc GetSolderBallProperty(EDBObjMessage) returns (EDBObjMessage) {} - - // Get/Set the die property - rpc SetDieProperty(PointerPropertyMessage) returns (google.protobuf.Empty) {} - rpc GetDieProperty(EDBObjMessage) returns (EDBObjMessage) {} - - // Get/Set the port property - rpc SetPortProperty(PointerPropertyMessage) returns (google.protobuf.Empty) {} - rpc GetPortProperty(EDBObjMessage) returns (EDBObjMessage) {} -} diff --git a/protos/ansys/api/edb/v1/inst_array.proto b/protos/ansys/api/edb/v1/inst_array.proto deleted file mode 100644 index de5ba64441..0000000000 --- a/protos/ansys/api/edb/v1/inst_array.proto +++ /dev/null @@ -1,43 +0,0 @@ -// Proto file representing the EDB Instance Array class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "point_data.proto"; - -// Instance Array service definition -service InstArrayService { - rpc Create(InstArrayCreationMessage) returns (EDBObjMessage) {} - - rpc FindByName(StringPropertyMessage) returns (EDBObjMessage) {} - - rpc GetOrig(EDBObjMessage) returns (PointMessage) {} - - rpc GetXAxis(EDBObjMessage) returns (PointMessage) {} - rpc SetXAxis(PointPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetYAxis(EDBObjMessage) returns (PointMessage) {} - rpc SetYAxis(PointPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetXCount(EDBObjMessage) returns (ValueMessage) {} - rpc SetXCount(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetYCount(EDBObjMessage) returns (ValueMessage) {} - rpc SetYCount(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc Decompose(EDBObjMessage) returns (google.protobuf.Empty) {} -} - -message InstArrayCreationMessage { - StringPropertyMessage layout = 1; - EDBObjMessage ref = 2; - PointMessage orig = 3; - PointMessage xaxis = 4; - PointMessage yaxis = 5; - ValueMessage xcount = 6; - ValueMessage ycount = 7; -} diff --git a/protos/ansys/api/edb/v1/io_component_property.proto b/protos/ansys/api/edb/v1/io_component_property.proto deleted file mode 100644 index aece71210b..0000000000 --- a/protos/ansys/api/edb/v1/io_component_property.proto +++ /dev/null @@ -1,23 +0,0 @@ -// Proto file representing the EDB IO Component Property class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -// IO Component Property service definition -service IOComponentPropertyService { - // Create IO Component Property - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - - // Get/Set the solder ball property - rpc SetSolderBallProperty(PointerPropertyMessage) returns (google.protobuf.Empty) {} - rpc GetSolderBallProperty(EDBObjMessage) returns (EDBObjMessage) {} - - // Get/Set the port property - rpc SetPortProperty(PointerPropertyMessage) returns (google.protobuf.Empty) {} - rpc GetPortProperty(EDBObjMessage) returns (EDBObjMessage) {} -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/layer.proto b/protos/ansys/api/edb/v1/layer.proto deleted file mode 100644 index 9a3d15d56a..0000000000 --- a/protos/ansys/api/edb/v1/layer.proto +++ /dev/null @@ -1,213 +0,0 @@ -// Proto file representing the LCLayer and LCSLayer classes - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -enum LayerType { - SIGNAL_LAYER = 0; - DIELECTRIC_LAYER = 1; - CONDUCTING_LAYER = 2; - AIRLINES_LAYER = 3; - ERRORS_LAYER = 4; - SYMBOL_LAYER = 5; - MEASURE_LAYER = 6; - ASSEMBLY_LAYER = 8; - SILKSCREEN_LAYER = 9; - SOLDER_MASK_LAYER = 10; - SOLDER_PASTE_LAYER = 11; - GLUE_LAYER = 12; - WIREBOND_LAYER = 13; - USER_LAYER = 14; - SIWAVE_HFSS_SOLVER_REGIONS = 16; - POST_PROCESSING_LAYER = 17; - OUTLINE_LAYER = 18; - LAYER_TYPES_COUNT = 19; - UNDEFINED_LAYER_TYPE = -1; -} - -enum TopBottomAssociation { - TOP_ASSOCIATED = 0; - NO_TOP_BOTTOM_ASSOCIATED = 1; - BOTTOM_ASSOCIATED = 2; - TOP_BOTTOM_ASSOCIATION_COUNT = 4; - INVALID_TOP_BOTTOM_ASSOCIATION = -1; -} - -enum DrawOverride { - NO_OVERRIDE = 0; - FILL = 1; - WIREFRAME = -1; -} - -enum LayerVisibility { - LAYER_VISIBILITY_PLACEHOLDER = 0; // DO NOT USE - THIS IS A PROTO3 REQUIREMENT - PRIMITIVE_VISIBLE = 0x00000001; - PATH_VISIBLE = 0x00000002; - PAD_VISIBLE = 0x00000004; - HOLE_VISIBLE = 0x00000008; - COMPONENT_VISIBLE = 0x00000010; - ALL_VISIBLE = 0x0000001F; -} - -// Layer service definition -service LayerService { - // Create a non-stackup layer - rpc Create (LayerCreationMessage) returns (EDBObjMessage) {} - - // Get the layer type of the layer - rpc GetLayerType (EDBObjMessage) returns (LayerTypeMessage) {} - - // Set the layer type of the layer - rpc SetLayerType (SetLayerTypeMessage) returns (google.protobuf.Empty) {} - - // Check whether or not this layer is a via layer - rpc IsViaLayer (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Get the name of this layer - rpc GetName (EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Set the name of this layer - rpc SetName (SetNameMessage) returns (google.protobuf.Empty) {} - - // Create a clone of this layer - rpc Clone (CloneMessage) returns (EDBObjMessage) {} - - // Get the layer id of this layer - rpc GetLayerId (EDBObjMessage) returns (google.protobuf.Int64Value) {} - - // Get the top bottom association of this layer - rpc GetTopBottomAssociation (EDBObjMessage) returns (TopBottomAssociationMessage) {} - - // Set the top bottom association of this layer - rpc SetTopBottomAssociation (SetTopBottomAssociationMessage) returns (google.protobuf.Empty) {} - - // Get the color of this layer - rpc GetColor (EDBObjMessage) returns (google.protobuf.UInt64Value) {} - - // Set the color of this layer - rpc SetColor (SetColorMessage) returns (google.protobuf.Empty) {} - - // Get the visibility mask of this layer - rpc GetVisibilityMask (EDBObjMessage) returns (google.protobuf.UInt64Value) {} - - // Set the visibility mask of this layer - rpc SetVisibilityMask (SetVisibilityMaskMessage) returns (google.protobuf.Empty) {} - - // Get the layer's locked status - rpc GetLocked (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set the layer's locked status - rpc SetLocked (SetLockedMessage) returns (google.protobuf.Empty) {} - - // Get the layer's transparency value - rpc GetTransparency (EDBObjMessage) returns (google.protobuf.UInt64Value) {} - - // Set the layer's transparency status - rpc SetTransparency (SetTransparencyMessage) returns (google.protobuf.Empty) {} - - // Get the layer's draw override type - rpc GetDrawOverride (EDBObjMessage) returns (DrawOverrideMessage) {} - - // Set the layer's draw override type - rpc SetDrawOverride (SetDrawOverrideMessage) returns (google.protobuf.Empty) {} - - // Get the layer's product property corresponding to the given product and attribute ids - rpc GetProductProperty (GetProductPropertyMessage) returns (google.protobuf.StringValue) {} - - // Set the layer's product property corresponding to the given product and attribute ids - rpc SetProductProperty (SetProductPropertyMessage) returns (google.protobuf.Empty) {} - - // Get a list of property ids associated with the layer for the given product. - rpc GetProductPropertyIds (GetProductPropertyIdsMessage) returns (ProductPropertyIdsMessage) {} - - // Get whether this layer is in the specified zone - rpc IsInZone (ZoneMessage) returns (google.protobuf.BoolValue) {} - - // Set whether this layer is in the specified zone - rpc SetIsInZone (SetIsInZoneMessage) returns (google.protobuf.Empty) {} - - // Get the zone ids of all zones containing this layer - rpc GetZones (EDBObjMessage) returns (ZonesMessage) {} - - // Get the zone index asociated with the layer's owning layer collection (if owner is invalid index is 0, if owner is multizone index is -1) - rpc GetZone (EDBObjMessage) returns (google.protobuf.Int64Value) {} -} - -message LayerCreationMessage { - string name = 1; - LayerType type = 2; -} - -message LayerTypeMessage { - LayerType type = 1; -} - -message SetLayerTypeMessage { - EDBObjMessage layer = 1; - LayerType type = 2; -} - -message SetNameMessage { - EDBObjMessage layer = 1; - string name = 2; -} - -message CloneMessage { - EDBObjMessage layer = 1; - bool copy_id = 2; -} - -message TopBottomAssociationMessage { - TopBottomAssociation top_bottom_association = 1; -} - -message SetTopBottomAssociationMessage { - EDBObjMessage layer = 1; - TopBottomAssociation top_bottom_association = 2; -} - -message SetColorMessage { - EDBObjMessage layer = 1; - uint64 color = 2; -} - -message SetVisibilityMaskMessage { - EDBObjMessage layer = 1; - uint64 visibility_mask = 2; -} - -message SetLockedMessage { - EDBObjMessage layer = 1; - bool is_locked = 2; -} - -message SetTransparencyMessage { - EDBObjMessage layer = 1; - uint64 transparency = 2; -} - -message DrawOverrideMessage { - DrawOverride draw_override = 1; -} - -message SetDrawOverrideMessage { - EDBObjMessage layer = 1; - DrawOverride draw_override = 2; -} - -message ZoneMessage { - EDBObjMessage layer = 1; - int64 zone = 2; -} - -message SetIsInZoneMessage { - ZoneMessage zone_msg = 1; - bool in_zone = 2; -} - -message ZonesMessage { - repeated int64 zones = 1; -} diff --git a/protos/ansys/api/edb/v1/layer_collection.proto b/protos/ansys/api/edb/v1/layer_collection.proto deleted file mode 100644 index 55ebebcc45..0000000000 --- a/protos/ansys/api/edb/v1/layer_collection.proto +++ /dev/null @@ -1,189 +0,0 @@ -// Proto file representing the LCCollection class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "layer.proto"; - -enum LayerCollectionMode { - LAMINATE = 0; - OVERLAPPING = 1; - MULTIZONE = 2; -} - -enum DielectricMergingMethod { - WEIGHTED_AVERAGE = 0; - KRASZEWSKI = 1; - WEIGHTED_CAPACITANCE = 2; -} - -service LayerCollectionService { - // Creates an empty LayerCollection - rpc Create (LayerCollectionModeMessage) returns (EDBObjMessage) {} - - // Clone an existing LayerCollection - rpc Clone (EDBObjMessage) returns (EDBObjMessage) {} - - // Get the LayerCollection mode - rpc GetMode (EDBObjMessage) returns (LayerCollectionModeMessage) {} - - // Set the LayerCollection mode - rpc SetMode (SetLayerCollectionModeMessage) returns (google.protobuf.Empty) {} - - // Adds the provided layers to the LayerCollection - rpc AddLayers (AddLayersMessage) returns (google.protobuf.Empty) {} - - // Import a LayerCollection from a control file - rpc ImportFromControlFile (ImportFromControlFileMessage) returns (google.protobuf.Empty) {} - - // Add a new layer to the LayerCollection - rpc AddLayer (AddLayerMessage) returns (EDBObjMessage) {} - - // Check whether there is layer overlapping or gap for laminate stackup. - // Check whether there is dielectric layer overlapping or gap for overlapping stackup. - rpc IsValid (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Finds a layer with the given name in the layer collection - rpc FindByName (FindLayerByNameMessage) returns (EDBObjMessage) {} - - // Get top bottom stackup layers of specific type - rpc GetTopBottomStackupLayers (GetTopBottomStackupLayersMessage) returns (TopBottomStackupLayersMessage) {} - - // Get a list of layers in the LayerCollection filtered by the given layer filter - rpc GetLayers (GetLayersMessage) returns (EDBObjCollectionMessage) {} - - // Get the layer's product property corresponding to the given product and attribute ids - rpc GetProductProperty (GetProductPropertyMessage) returns (google.protobuf.StringValue) {} - - // Set the layer's product property corresponding to the given product and attribute ids - rpc SetProductProperty (SetProductPropertyMessage) returns (google.protobuf.Empty) {} - - // Get a list of property ids associated with the layer for the given product - rpc GetProductPropertyIds (GetProductPropertyIdsMessage) returns (ProductPropertyIdsMessage) {} - - // Merges the dielectric layers in a range of layers into one large dielectric layer that spans the elevation range of all merged dielectric layers - rpc MergeDielectrics (MergeDielectricsMessage) returns (EDBObjMessage) {} - - // Retrieves a list of all zones in the LayerCollection - rpc GetZoneIds (EDBObjMessage) returns (ZonesMessage) {} - - // Retrieves the name corresponding to the specified zone - rpc GetZoneName (LayerCollectionZoneMessage) returns (google.protobuf.StringValue) {} - - // Set the name corresponding to the specified zone - rpc SetZoneName (SetZoneNameMessage) returns (google.protobuf.Empty) {} - - // Inserts a new zone - rpc InsertZone (InsertZoneMessage) returns (google.protobuf.Int64Value) {} - - // Removes a zone - rpc RemoveZone (LayerCollectionZoneMessage) returns (google.protobuf.Empty) {} - - // Simplifies dielectric layers by splitting them at the boundaries of signal layers and merging them - rpc SimplifyDielectricsForPhi (SimplifyDielectricsForPhiMessage) returns (EDBObjCollectionMessage) {} - - // Sets the zone to the layer and updates the layer in the collection - rpc AddZoneToLayer (AddZoneToLayerMessage) returns (google.protobuf.Empty) {} -} - -message LayerCollectionModeMessage { - LayerCollectionMode mode = 1; -} - -message SetLayerCollectionModeMessage { - EDBObjMessage layer_collection = 1; - LayerCollectionMode mode = 2; -} - -message AddLayerAboveBelowMessage { - string above_below_layer_name = 1; - bool add_above = 2; -} - -message AddLayerMessage { - EDBObjMessage layer_collection = 1; - EDBObjMessage layer = 2; - oneof op_params { - AddLayerAboveBelowMessage above_below_msg = 3; - bool add_top = 4; - } -} - -message ImportFromControlFileMessage { - EDBObjMessage layer_collection = 1; - string control_file_path = 2; - oneof optional_schema_path { - string schema_path = 3; - } -} - -// Message for AddLayers -message AddLayersMessage { - EDBObjMessage layer_collection = 1; - repeated EDBObjMessage layers = 2; -} - -// Message for FindByName -message FindLayerByNameMessage { - EDBObjMessage layer_collection = 1; - string name = 2; -} - -message GetTopBottomStackupLayersMessage { - EDBObjMessage layer_collection = 1; - int64 layer_type_set = 2; -} - -message TopBottomStackupLayersMessage { - EDBObjMessage top_layer = 1; - double top_layer_elevation = 2; - EDBObjMessage bottom_layer = 3; - double bottom_layer_elevation = 4; -} - -message GetLayersMessage { - EDBObjMessage layer_collection = 1; - int64 layer_filter = 2; -} - -message MergeDielectricsMessage { - EDBObjMessage layer_collection = 1; - EDBObjMessage layout = 2; - string start_layer_name = 3; - string end_layer_name = 4; - DielectricMergingMethod merging_method = 5; - string merged_layer_name = 6; - string merged_mat_name = 7; -} - -message LayerCollectionZoneMessage { - EDBObjMessage layer_collection = 1; - int64 zone = 2; -} - -message SetZoneNameMessage { - EDBObjMessage layer_collection = 1; - int64 zone = 2; - string zone_name = 3; -} - -message InsertZoneMessage { - EDBObjMessage layer_collection = 1; - int64 copy_zone = 2; -} - -message SimplifyDielectricsForPhiMessage { - EDBObjMessage layer_collection = 1; - EDBObjMessage database = 2; - double layer_thickness_thresh = 3; - DielectricMergingMethod merging_method = 4; -} - -message AddZoneToLayerMessage { - EDBObjMessage layer_collection = 1; - EDBObjMessage layer = 2; - int64 zone = 3; - bool in_zone = 4; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/layer_map.proto b/protos/ansys/api/edb/v1/layer_map.proto deleted file mode 100644 index 9732612ddf..0000000000 --- a/protos/ansys/api/edb/v1/layer_map.proto +++ /dev/null @@ -1,43 +0,0 @@ -// Proto file representing the LayerMap class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -enum LayerMapUniqueDirection { - FORWARD_UNIQUE = 0; - BACKWARD_UNIQUE = 1; - TWOWAY_UNIQUE = 2; - ILLEGAL_UNIQUE_DIRECTION = -1; -} - -// LayerMap service definition -service LayerMapService { - - // Create a layer map - rpc Create (LayerMapUniqueDirectionMessage) returns (EDBObjMessage) {} - - // Clear a layer map - rpc Clear (EDBObjMessage) returns (google.protobuf.Empty) {} - - // SetMapping of a layer map - rpc SetMapping (LayerMapTwoIntPropertiesMessage) returns (google.protobuf.Empty) {} - - // GetMapping of a layer map - rpc GetMappingForward (IntPropertyMessage) returns (ProductPropertyIdsMessage) {} - - // GetMapping of a layer map - rpc GetMappingBackward (IntPropertyMessage) returns (ProductPropertyIdsMessage) {} -} - -message LayerMapUniqueDirectionMessage { - LayerMapUniqueDirection direction = 1; -} - -message LayerMapTwoIntPropertiesMessage { - EDBObjMessage target = 1; - EDBInternalIdMessage from_id = 2; - EDBInternalIdMessage to_id = 3; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/layout.proto b/protos/ansys/api/edb/v1/layout.proto deleted file mode 100644 index b9b0bd31c4..0000000000 --- a/protos/ansys/api/edb/v1/layout.proto +++ /dev/null @@ -1,91 +0,0 @@ -// Proto file representing the EDB Layout class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "refs.proto"; -import "layout_obj.proto"; -import "edb_defs.proto"; -import "polygon_data.proto"; - -// Cell service definition -service LayoutService { - // Gets the cell of the provided layout - rpc GetCell (EDBObjMessage) returns (EDBObjMessage) {} - - // Gets the layer collection of the layout - rpc GetLayerCollection (EDBObjMessage) returns (EDBObjMessage) {} - - // Sets the layer collection of the layout - rpc SetLayerCollection (SetLayerCollectionMessage) returns (google.protobuf.Empty) {} - - // Gets the layout objects that belong to the layout - rpc GetItems (LayoutGetItemsMessage) returns (EDBObjCollectionMessage) {} - - // Get expanded extent from nets - rpc GetExpandedExtentFromNets (LayoutExpandedExtentMessage) returns (PolygonDataMessage) {} - - // Convert primitives to via - rpc ConvertPrimitivesToVias(LayoutConvertP2VMessage) returns (google.protobuf.Empty) {} - - // Gets if the port reference terminals are connected - rpc ArePortReferenceTerminalsConnected (EDBObjMessage) returns (LayoutPortRefTerminalsConnectedMessage) {} - - // Gets list of zone primitives - rpc GetZonePrimitives (EDBObjMessage) returns (EDBObjCollectionMessage) {} - - // Set fixed zone primitives - rpc SetFixedZonePrimitives (PointerPropertyMessage) returns (google.protobuf.Empty) {} - - // Get fixed zone primitive - rpc GetFixedZonePrimitive (EDBObjMessage) returns (EDBObjMessage) {} - - // Get board bend definitions - rpc GetBoardBendDefs (EDBObjMessage) returns (EDBObjCollectionMessage) {} - - // Synchronize bend manager - rpc SynchronizeBendManager (EDBObjMessage) returns (google.protobuf.Empty) {} - - // Get the layout instance of the layout - rpc GetLayoutInstance(EDBObjMessage) returns (EDBObjMessage) {} -} - -message SetLayerCollectionMessage { - EDBObjMessage layout = 1; - EDBObjMessage layer_collection = 2; -} - -message LayerLookupMessage { - EDBObjMessage layout = 1; - LayerRefMessage layer = 2; -} - -message LayoutGetItemsMessage { - EDBObjMessage layout = 1; - LayoutObjType obj_type = 2; -} - -message LayoutExpandedExtentMessage { - EDBObjMessage layout = 1; - EDBObjCollectionMessage nets = 2; - GeometryExtentType etype = 3; - float expansion_factor = 4; - bool expansion_factor_unitless = 5; - bool use_round_corner = 6; - uint64 num_increments = 7; -} - -message LayoutConvertP2VMessage { - EDBObjMessage layout = 1; - EDBObjCollectionMessage primitives = 2; - bool is_pins = 3; -} - -message LayoutPortRefTerminalsConnectedMessage { - bool is_connected = 1; - repeated google.protobuf.StringValue error_ports = 2; -} diff --git a/protos/ansys/api/edb/v1/layout_instance.proto b/protos/ansys/api/edb/v1/layout_instance.proto deleted file mode 100644 index ce1953c9cb..0000000000 --- a/protos/ansys/api/edb/v1/layout_instance.proto +++ /dev/null @@ -1,54 +0,0 @@ -// Proto file representing the layout instance class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; -import "refs.proto"; -import "polygon_data.proto"; - -service LayoutInstanceService { - rpc Refresh(EDBObjMessage) returns (google.protobuf.Empty) {} - - rpc QueryLayoutObjInstances(LayoutObjInstancesQueryMessage) returns (LayoutObjInstancesQueryResultsMessage) {} - - rpc GetLayoutObjInstanceInContext(GetLayoutObjInstanceInContextMessage) returns (EDBObjMessage) {} - - rpc GetConnectedObjects(GetConnectedObjectsMessage) returns (EDBObjCollectionMessage) {} -} - -message LayoutObjInstancesQueryMessage { - EDBObjMessage layout_inst = 1; - oneof spatial_filter { - PointMessage point_filter = 2; - PolygonDataMessage region_filter = 3; - } - repeated LayerRefMessage layer_filter = 4; - repeated NetRefMessage net_filter = 5; -} - -message LayoutObjInstancesQueryResultsMessage { - oneof results { - EDBObjCollectionMessage hits = 1; - FullPartialHitsMessage full_partial_hits = 2; - } -} - -message FullPartialHitsMessage { - EDBObjCollectionMessage full = 1; - EDBObjCollectionMessage partial = 2; -} - -message GetLayoutObjInstanceInContextMessage { - EDBObjMessage layout_inst = 1; - EDBObjMessage layout_obj = 2; - StringsMessage context = 3; -} - -message GetConnectedObjectsMessage { - EDBObjMessage layout_inst = 1; - EDBObjMessage layout_obj = 2; - bool touching_only = 3; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/layout_instance_context.proto b/protos/ansys/api/edb/v1/layout_instance_context.proto deleted file mode 100644 index e2355d4f36..0000000000 --- a/protos/ansys/api/edb/v1/layout_instance_context.proto +++ /dev/null @@ -1,26 +0,0 @@ -// Proto file representing the layout instance context class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; - -service LayoutInstanceContextService { - rpc GetLayout(EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetBBox(BoolPropertyMessage) returns (BoxMessage) {} - - rpc IsTopOrBlackBox(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - rpc GetTopOrBlackBox(EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetPlacementElevation(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - - rpc Is3DPlacement(BoolPropertyMessage) returns (google.protobuf.BoolValue) {} - - rpc GetTransformation(EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetTransformationBetweenContexts(EDBObjPairMessage) returns (EDBObjMessage) {} -} diff --git a/protos/ansys/api/edb/v1/layout_obj.proto b/protos/ansys/api/edb/v1/layout_obj.proto deleted file mode 100644 index dcf2848eb6..0000000000 --- a/protos/ansys/api/edb/v1/layout_obj.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Proto file representing the base class of objects owned by EDB layout objects - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -// Enum for layout object types -enum LayoutObjType { - PRIMITIVE = 0; - PADSTACK_INST = 1; - TERM = 2; - TERM_INST = 3; - CELL_INST = 4; - LAYER = 5; - NET = 6; - PADSTACK = 7; - GROUP = 8; - NET_CLASS = 9; - CELL = 10; - DIFFERENTIAL_PAIR = 11; - PIN_GROUP = 12; - VOLTAGE_REGULATOR = 13; - EXTENDED_NET = 14; - LAYOUT_OBJ_TYPE_COUNT = 15; - INST_ARRAY = 16; - INVALID_LAYOUT_OBJ = -1; -} - -// LayoutObj service definition -service LayoutObjService { - // Gets the layout of the layout object - rpc GetLayout (LayoutObjTargetMessage) returns (EDBObjMessage) {} - - // Delete the layout object - rpc Delete (LayoutObjTargetMessage) returns (google.protobuf.Empty) {} - - // Gets a double product property by product id and attribute id - rpc GetProductProperty (GetProductPropertyTypeMessage) returns (google.protobuf.StringValue) {} - - // Sets a integer property by product id and attribute id - rpc SetProductProperty (SetProductPropertyTypeMessage) returns (google.protobuf.Empty) {} - - // Gets a list of property ids associated with the layout object for the given product - rpc GetProductPropertyIds (GetProductPropertyIdsTypeMessage) returns (ProductPropertyIdsMessage) {} -} - -message LayoutObjTargetMessage { - EDBObjMessage target = 1; - LayoutObjType type = 2; -} - -message GetProductPropertyTypeMessage { - GetProductPropertyMessage target = 1; - LayoutObjType type = 2; -} - -message SetProductPropertyTypeMessage { - SetProductPropertyMessage target = 1; - LayoutObjType type = 2; -} - -message GetProductPropertyIdsTypeMessage { - GetProductPropertyIdsMessage target = 1; - LayoutObjType type = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/layout_obj_instance.proto b/protos/ansys/api/edb/v1/layout_obj_instance.proto deleted file mode 100644 index ba3d3027c1..0000000000 --- a/protos/ansys/api/edb/v1/layout_obj_instance.proto +++ /dev/null @@ -1,33 +0,0 @@ -// Proto file representing the layout obj instance class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; -import "point_data.proto"; -import "layout_obj_instance_geometry.proto"; - -service LayoutObjInstanceService { - rpc GetLayers(EDBObjMessage) returns (EDBObjCollectionMessage) {} - - rpc GetGeometries(LayerRefPropertyMessage) returns (FetchedLayoutObjInstanceGeometriesMessage) {} - - rpc GetContext(EDBObjMessage) returns (StringsMessage) {} - - rpc GetLayoutInstanceContext(EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetLayoutObj(EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetBBox(BoolPropertyMessage) returns (BoxMessage) {} -} - -message FetchedLayoutObjInstanceGeometryMessage { - LayoutObjInstanceGeometryMessage geometry = 1; - int64 type = 2; -} - -message FetchedLayoutObjInstanceGeometriesMessage { - repeated FetchedLayoutObjInstanceGeometryMessage geometries = 1; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/layout_obj_instance_2d_geometry.proto b/protos/ansys/api/edb/v1/layout_obj_instance_2d_geometry.proto deleted file mode 100644 index 6e4c14de05..0000000000 --- a/protos/ansys/api/edb/v1/layout_obj_instance_2d_geometry.proto +++ /dev/null @@ -1,20 +0,0 @@ -// Proto file representing the layout obj instance 2d geometry class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "layout_obj_instance_geometry.proto"; -import "polygon_data.proto"; - -service LayoutObjInstance2DGeometryService { - rpc IsNegative(LayoutObjInstanceGeometryMessage) returns (google.protobuf.BoolValue) {} - - rpc GetPolygonData(GetPolygonDataMessage) returns (PolygonDataMessage) {} -} - -message GetPolygonDataMessage { - LayoutObjInstanceGeometryMessage layout_obj_inst_geom = 1; - bool apply_neg = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/layout_obj_instance_3d_geometry.proto b/protos/ansys/api/edb/v1/layout_obj_instance_3d_geometry.proto deleted file mode 100644 index 0b2b69065f..0000000000 --- a/protos/ansys/api/edb/v1/layout_obj_instance_3d_geometry.proto +++ /dev/null @@ -1,23 +0,0 @@ -// Proto file representing the layout obj instance 2d geometry class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_3d_data.proto"; -import "layout_obj_instance_geometry.proto"; - -service LayoutObjInstance3DGeometryService { - rpc GetTesselationData(LayoutObjInstanceGeometryMessage) returns (TesselationDataMessage) {} -} - -message Triangle3DDataMessage { - Point3DMessage point_1 = 1; - Point3DMessage point_2 = 2; - Point3DMessage point_3 = 3; -} - -message TesselationDataMessage { - repeated Triangle3DDataMessage tesselation_data = 1; -} diff --git a/protos/ansys/api/edb/v1/layout_obj_instance_geometry.proto b/protos/ansys/api/edb/v1/layout_obj_instance_geometry.proto deleted file mode 100644 index 31bc7f4c03..0000000000 --- a/protos/ansys/api/edb/v1/layout_obj_instance_geometry.proto +++ /dev/null @@ -1,19 +0,0 @@ -// Proto file representing the layout obj instance geometry class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service LayoutObjInstanceGeometryService { - rpc GetMaterial(LayoutObjInstanceGeometryMessage) returns (google.protobuf.StringValue) {} - - rpc GetColor(LayoutObjInstanceGeometryMessage) returns (google.protobuf.Int64Value) {} -} - -message LayoutObjInstanceGeometryMessage { - EDBObjMessage geometry = 1; - EDBObjMessage owning_drawing = 2; - EDBObjMessage placement_layer = 3; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/material_def.proto b/protos/ansys/api/edb/v1/material_def.proto deleted file mode 100644 index 6fc97b1113..0000000000 --- a/protos/ansys/api/edb/v1/material_def.proto +++ /dev/null @@ -1,152 +0,0 @@ -// Proto file representing the MaterialDef class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -enum MaterialPropertyID { - MATERIAL_PROPERTY_PLACEHOLDER = 0; // DO NOT USE - THIS IS A PROTO3 REQUIREMENT - PERMITTIVITY = 3; - PERMEABILITY = 4; - CONDUCTIVITY = 5; - DIELECTRIC_LOSS_TANGENT = 6; - MAGNETIC_LOSS_TANGENT = 7; - THERMAL_CONDUCTIVITY = 14; - MASS_DENSITY = 34; - SPECIFIC_HEAT = 38; - YOUNGS_MODULUS = 39; - POISSONS_RATIO = 40; - THERMAL_EXPANSION_COEFFICIENT = 42; - INVALID_PROPERTY = 71; -} - -service MaterialDefService { - rpc Create(MaterialDefCreationMessage) returns (EDBObjMessage) {} - - // DEPRECATED: use Create instead - rpc SetProperty(MaterialDefSetPropertyMessage) returns (google.protobuf.Empty) {} - - // Find Material Definition by name - rpc FindByName(EDBObjNameMessage) returns (EDBObjMessage) {} - - // Delete Material Definition - rpc Delete(EDBObjMessage) returns (google.protobuf.Empty) {} - - // Get Property - rpc GetProperty(MaterialDefGetPropertyMessage) returns (ValueMessage) {} - - // Get All Properties - rpc GetAllProperties(EDBObjMessage) returns (MaterialDefGetAllPropertiesMessage) {} - - // Remove Property - rpc RemoveProperty(MaterialDefGetPropertyMessage) returns (google.protobuf.Empty) {} - - // Get Name of Material Def - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Get Dielectric Material Model - rpc GetDielectricMaterialModel(EDBObjMessage) returns (EDBObjMessage) {} - - // Set Dielectric Material Model - rpc SetDielectricMaterialModel(PointerPropertyMessage) returns (google.protobuf.Empty) {} - - // Get Dimensions - rpc GetDimensions(MaterialDefPropertyMessage) returns (MaterialDefGetDimensionMessage) {} - - // Set Thermal Modifier - rpc SetThermalModifier(SetMaterialDefPropertyMessage) returns (google.protobuf.Empty) {} - - // Set Anisotropic Thermal Modifier - rpc SetAnisotropicThermalModifier(SetMaterialDefPropertyComponentMessage) returns (google.protobuf.Empty) {} - - // Get Thermal Modifier - rpc GetThermalModifier(MaterialDefPropertyMessage) returns (EDBObjMessage) {} - - // Get Anisotropic Thermal Modifier - rpc GetAnisotropicThermalModifier(MaterialDefPropertyComponentMessage) returns (EDBObjMessage) {} -} - -message MaterialDefCreationMessage { - EDBObjMessage database = 1; - string name = 2; - MaterialDefPropertiesMessage properties = 3; -} - -message TensorPositionMessage { - uint64 col = 1; - uint64 row = 2; -} - -message MaterialDefSetPropertyMessage { - EDBObjMessage materialDef = 1; - MaterialPropertyID propertyId = 2; - ValueMessage value = 3; - oneof select{ - EDBInternalIdMessage component = 4; - TensorPositionMessage tensor = 5; - } -} - -message MaterialDefGetPropertyMessage { - EDBObjMessage materialDef = 1; - MaterialPropertyID propertyId = 2; - oneof select{ - EDBInternalIdMessage component = 3; - TensorPositionMessage tensor = 4; - } -} - -message MaterialDefPropertiesMessage { - ValueMessage permittivity = 1; - ValueMessage permeability = 2; - ValueMessage conductivity = 3; - ValueMessage dielectric_loss_tangent = 4; - ValueMessage magnetic_loss_tangent = 5; - ValueMessage thermal_conductivity = 6; - ValueMessage mass_density = 7; - ValueMessage specific_heat = 8; - ValueMessage youngs_modulus = 9; - ValueMessage poissons_ratio = 10; - ValueMessage thermal_expansion_coefficient = 11; -} - -message MaterialDefGetAllPropertiesMessage{ - repeated MaterialPropertyID properties= 1; -} - -message MaterialDefGetDimensionMessage { - TensorPositionMessage tensor = 1; -} - -message SetAnisotropicThermalModifierMessage { - MaterialDefSetPropertyMessage material_prop = 1; - uint64 component = 2; -} - -message SetMaterialDefPropertyMessage { - EDBObjMessage materialDef = 1; - MaterialPropertyID propertyId = 2; - EDBObjMessage thermal_modifier = 3; -} - -message SetMaterialDefPropertyComponentMessage { - EDBObjMessage materialDef = 1; - MaterialPropertyID propertyId = 2; - EDBObjMessage thermal_modifier = 3; - uint64 component = 4; -} - -message MaterialDefPropertyMessage { - EDBObjMessage materialDef = 1; - MaterialPropertyID propertyId = 2; -} - -message MaterialDefPropertyComponentMessage { - EDBObjMessage materialDef = 1; - MaterialPropertyID propertyId = 2; - uint64 component = 3; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/material_property_thermal_modifier.proto b/protos/ansys/api/edb/v1/material_property_thermal_modifier.proto deleted file mode 100644 index 90fce1be32..0000000000 --- a/protos/ansys/api/edb/v1/material_property_thermal_modifier.proto +++ /dev/null @@ -1,26 +0,0 @@ -// Proto file representing the EDB AdaptiveSettings class and derived classes - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service MaterialPropertyThermalModifierService { - rpc Create(MaterialPropertyThermalModifierParamsMessage) returns (EDBObjMessage) {} - - rpc GetQuadraticModelParams(EDBObjMessage) returns (MaterialPropertyThermalModifierParamsMessage) {} - - rpc GetThermalModifierExpression(EDBObjMessage) returns (ValueMessage) {} -} - -message MaterialPropertyThermalModifierParamsMessage{ - ValueMessage temp_ref = 1; - ValueMessage c1 = 2; - ValueMessage c2 = 3; - ValueMessage temp_lower_limit = 4; - ValueMessage temp_upper_limit = 5; - bool auto_calc_constant_thermal_modifier = 6; - ValueMessage lower_const_therm_mod = 7; - ValueMessage upper_const_therm_mod = 8; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/mcad_model.proto b/protos/ansys/api/edb/v1/mcad_model.proto deleted file mode 100644 index 6621b4faa2..0000000000 --- a/protos/ansys/api/edb/v1/mcad_model.proto +++ /dev/null @@ -1,98 +0,0 @@ -// Proto file representing the MCAD Model - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_3d_data.proto"; - -service McadModelService { - rpc CreateStride (McadModelCreationMessage) returns (EDBObjMessage) {} - rpc CreateHfss (McadModelHfssCreationMessage) returns (EDBObjMessage) {} - rpc Create3dComp (McadModelCreationMessage) returns (EDBObjMessage) {} - - rpc IsMcad (EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc IsMcadStride (EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc IsMcadHfss (EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc IsMcad3dComp (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - rpc GetOrigin (EDBObjMessage) returns (Point3DMessage) {} - rpc SetOrigin (Point3DPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRotation (EDBObjMessage) returns (McadModelRotationMessage) {} - rpc SetRotation (McadModelSetRotationMessage) returns (google.protobuf.Empty) {} - - rpc GetScale (EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetScale (DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaterial (IntPropertyMessage) returns (google.protobuf.StringValue) {} - rpc SetMaterial (McadModelStringMessage) returns (google.protobuf.Empty) {} - - rpc GetVisible (IntPropertyMessage) returns (google.protobuf.BoolValue) {} - rpc SetVisible (McadModelBoolMessage) returns (google.protobuf.Empty) {} - - rpc GetModeled (IntPropertyMessage) returns (google.protobuf.BoolValue) {} - rpc SetModeled (McadModelBoolMessage) returns (google.protobuf.Empty) {} - - rpc GetCellInst (EDBObjMessage) returns (EDBObjMessage) {} - rpc GetPartCount (EDBObjMessage) returns (google.protobuf.Int64Value) {} - rpc GetPartName (IntPropertyMessage) returns (google.protobuf.StringValue) {} - rpc GetPartIndex (StringPropertyMessage) returns (google.protobuf.Int64Value) {} - rpc GetModelName (EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc GetDesignName (EDBObjMessage) returns (google.protobuf.StringValue) {} -} - -message McadModelCreationMessage { - message WithLayout { - EDBObjMessage obj = 1; - string file_name = 2; - } - message WithConnObj { - EDBObjMessage obj = 1; - } - - oneof param { - WithConnObj conn_obj = 1; - WithLayout layout = 2; - } -} - -message McadModelHfssCreationMessage { - message WithLayout { - EDBObjMessage obj = 1; - string file_name = 2; - string design = 3; - } - message WithConnObj { - EDBObjMessage obj = 1; - } - - oneof param { - WithConnObj conn_obj = 1; - WithLayout layout = 2; - } -} - -message McadModelRotationMessage { - Point3DMessage axis_from = 1; - Point3DMessage axis_to = 2; - double angle = 3; -} - -message McadModelSetRotationMessage { - EDBObjMessage model = 1; - McadModelRotationMessage rotation = 2; -} - -message McadModelStringMessage { - EDBObjMessage model = 1; - int64 index = 2; - string value = 3; -} - -message McadModelBoolMessage { - EDBObjMessage model = 1; - int64 index = 2; - bool value = 3; -} diff --git a/protos/ansys/api/edb/v1/model.proto b/protos/ansys/api/edb/v1/model.proto deleted file mode 100644 index a5f7d25cd1..0000000000 --- a/protos/ansys/api/edb/v1/model.proto +++ /dev/null @@ -1,21 +0,0 @@ -// Proto file representing the Hierarchy Model classes - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -enum ModelType { - PIN_PAIR_RLC_MODEL_TYPE = 0; - S_PARAM_MODEL_TYPE = 1; - NETLIST_MODEL_TYPE = 2; - LIBRARY_MODEL_TYPE = 3; - SPICE_MODEL_TYPE = 4; - MODEL_TYPE_TOTAL = 5; - INVALID_MODEL_TYPE = -1; -} - -service ModelService { - rpc Clone (EDBObjMessage) returns (EDBObjMessage) {} -} diff --git a/protos/ansys/api/edb/v1/multipole_debye_model.proto b/protos/ansys/api/edb/v1/multipole_debye_model.proto deleted file mode 100644 index 563905e968..0000000000 --- a/protos/ansys/api/edb/v1/multipole_debye_model.proto +++ /dev/null @@ -1,27 +0,0 @@ -// Proto file representing the DielectricMaterialModel class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -service MultipoleDebyeModelService { - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - - rpc GetParameters(EDBObjMessage) returns (MultipoleDebyeModelGetParams) {} - rpc SetParameters(MultipoleDebyeModelSetParams) returns (google.protobuf.Empty) {} -} - -message MultipoleDebyeModelGetParams { - repeated google.protobuf.DoubleValue frequencies = 1; - repeated google.protobuf.DoubleValue relative_permitivities = 2; - repeated google.protobuf.DoubleValue loss_tangents = 3; -} - -message MultipoleDebyeModelSetParams { - EDBObjMessage target = 1; - MultipoleDebyeModelGetParams vectors = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/net.proto b/protos/ansys/api/edb/v1/net.proto deleted file mode 100644 index 962a4a93a9..0000000000 --- a/protos/ansys/api/edb/v1/net.proto +++ /dev/null @@ -1,33 +0,0 @@ -// Proto file representing the EDB Net class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "layout_obj.proto"; - -// Net service definition -service NetService { - // Creates a net - rpc Create (StringPropertyMessage) returns (EDBObjMessage) {} - - // Finds a net on a layer by name - rpc FindByName (StringPropertyMessage) returns (EDBObjMessage) {} - - // name accessors - rpc GetName (EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetName (StringPropertyMessage) returns (google.protobuf.Empty) {} - - // is_power_ground accessors - rpc GetIsPowerGround (EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIsPowerGround (BoolPropertyMessage) returns (google.protobuf.Empty) {} - - // layout objects getter - rpc GetLayoutObjects (NetGetLayoutObjMessage) returns (EDBObjCollectionMessage) {} -} - -message NetGetLayoutObjMessage { - EDBObjMessage net = 1; - LayoutObjType obj_type = 2; -} diff --git a/protos/ansys/api/edb/v1/netclass.proto b/protos/ansys/api/edb/v1/netclass.proto deleted file mode 100644 index 21bf7649b3..0000000000 --- a/protos/ansys/api/edb/v1/netclass.proto +++ /dev/null @@ -1,42 +0,0 @@ -// Proto file representing the EDB NetClass - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service NetClassService { - rpc Create(NetClassCreationMessage) returns (EDBObjMessage) {} - - rpc FindByName(EDBObjNameMessage) returns (EDBObjMessage) {} - - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - - rpc SetName(EDBObjNameMessage) returns (google.protobuf.Empty) {} - - rpc GetDescription(EDBObjMessage) returns (google.protobuf.StringValue) {} - - rpc SetDescription(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc IsPowerGround(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - rpc GetNets(EDBObjMessage) returns (EDBObjCollectionMessage) {} - - rpc AddNet(NetClassEditMessage) returns (google.protobuf.Empty) {} - - rpc RemoveNet(NetClassEditMessage) returns (google.protobuf.Empty) {} - - rpc ContainsNet(NetClassEditMessage) returns (google.protobuf.BoolValue) {} -} - -// Message for Create -message NetClassCreationMessage { - EDBObjMessage layout = 1; - string name = 2; -} - -message NetClassEditMessage { - EDBObjMessage netclass = 1; - EDBObjMessage net = 2; -} diff --git a/protos/ansys/api/edb/v1/netlist_model.proto b/protos/ansys/api/edb/v1/netlist_model.proto deleted file mode 100644 index 2ebe0b86ff..0000000000 --- a/protos/ansys/api/edb/v1/netlist_model.proto +++ /dev/null @@ -1,13 +0,0 @@ -// Proto file representing the NetlistModel class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service NetlistModelService { - rpc Create (google.protobuf.StringValue) returns (EDBObjMessage) {} - rpc GetNetlist (EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetNetlist (StringPropertyMessage) returns (google.protobuf.Empty) {} -} diff --git a/protos/ansys/api/edb/v1/package_def.proto b/protos/ansys/api/edb/v1/package_def.proto deleted file mode 100644 index 0febca6a13..0000000000 --- a/protos/ansys/api/edb/v1/package_def.proto +++ /dev/null @@ -1,65 +0,0 @@ -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "polygon_data.proto"; - -enum HeatSinkFinOrientation { - X_ORIENTED = 0; - Y_ORIENTED = 1; - OTHER_ORIENTED = 2; -} - -service PackageDefService { - rpc Create(StringPropertyMessage) returns (EDBObjMessage) {} - rpc Delete(EDBObjMessage) returns (google.protobuf.Empty) {} - - rpc FindByName(StringPropertyMessage) returns (EDBObjMessage) {} - rpc FindByEDBUId(IntPropertyMessage) returns (EDBObjMessage) {} - - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetName(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetExteriorBoundary(EDBObjMessage) returns (PolygonDataMessage) {} - rpc SetExteriorBoundary(PolygonDataPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetHeight(EDBObjMessage) returns (ValueMessage) {} - rpc SetHeight(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetOperatingPower(EDBObjMessage) returns (ValueMessage) {} - rpc SetOperatingPower(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaximumPower(EDBObjMessage) returns (ValueMessage) {} - rpc SetMaximumPower(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetTherm_Cond(EDBObjMessage) returns (ValueMessage) {} - rpc SetTherm_Cond(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetTheta_JB(EDBObjMessage) returns (ValueMessage) {} - rpc SetTheta_JB(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetTheta_JC(EDBObjMessage) returns (ValueMessage) {} - rpc SetTheta_JC(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetHeatSink(EDBObjMessage) returns (HeatSinkMessage) {} - rpc SetHeatSink(SetHeatSinkMessage) returns (google.protobuf.Empty) {} - - rpc GetProductProperty (GetProductPropertyMessage) returns (google.protobuf.StringValue) {} - rpc SetProductProperty (SetProductPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetProductPropertyIds (GetProductPropertyIdsMessage) returns (ProductPropertyIdsMessage) {} -} - -message HeatSinkMessage { - ValueMessage thickness = 1; - ValueMessage spacing = 2; - ValueMessage base_height = 3; - ValueMessage height = 4; - HeatSinkFinOrientation orientation = 5; -} - -message SetHeatSinkMessage { - EDBObjMessage target = 1; - HeatSinkMessage value = 2; -} diff --git a/protos/ansys/api/edb/v1/padstack_def.proto b/protos/ansys/api/edb/v1/padstack_def.proto deleted file mode 100644 index 0844bb2617..0000000000 --- a/protos/ansys/api/edb/v1/padstack_def.proto +++ /dev/null @@ -1,35 +0,0 @@ -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service PadstackDefService { - // create a PadstackDef - rpc Create(PadstackDefStringMessage) returns (EDBObjMessage) {} - - // delete a PadstackDef - rpc Delete(EDBObjMessage) returns (google.protobuf.Empty) {} - - // find a PadstackDef by name - rpc FindByName(PadstackDefStringMessage) returns (EDBObjMessage) {} - - // get name of a PadstackDef - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Get PSPadstackDefinition of PadstackDef - rpc GetData(EDBObjMessage) returns (EDBObjMessage) {} - - // Set PSPadstackDefinition of PadstackDef - rpc SetData(PadstackDefSetDataMessage) returns (google.protobuf.Empty) {} -} - -message PadstackDefStringMessage { - EDBObjMessage target = 1; - string name = 2; -} - -message PadstackDefSetDataMessage { - EDBObjMessage target = 1; - EDBObjMessage data = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/padstack_def_data.proto b/protos/ansys/api/edb/v1/padstack_def_data.proto deleted file mode 100644 index f79b60eb01..0000000000 --- a/protos/ansys/api/edb/v1/padstack_def_data.proto +++ /dev/null @@ -1,241 +0,0 @@ -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "polygon_data.proto"; - -// PAD_TYPE type enum -enum PadType { - REGULAR_PAD = 0; - ANTI_PAD = 1; - THERMAL_PAD = 2; - HOLE = 3; - UNKNOWN_GEOM_TYPE = 4; -} - -// PAD_GEOMETRY_TYPE type enum -enum PadGeometryType { - PADGEOMTYPE_NO_GEOMETRY = 0; - PADGEOMTYPE_CIRCLE = 1; - PADGEOMTYPE_SQUARE = 2; - PADGEOMTYPE_RECTANGLE = 3; - PADGEOMTYPE_OVAL = 4; - PADGEOMTYPE_BULLET = 5; - PADGEOMTYPE_NSIDED_POLYGON = 6; - PADGEOMTYPE_POLYGON = 7; - PADGEOMTYPE_ROUND45 = 8; - PADGEOMTYPE_ROUND90 = 9; - PADGEOMTYPE_SQUARE45 = 10; - PADGEOMTYPE_SQUARE90 = 11; - PADGEOMTYPE_INVALID_GEOMETRY = 12; -} - -// PADSTACK_HOLE_RANGE type enum -enum PadstackHoleRange { - THROUGH = 0; - BEGIN_ON_UPPER_PAD = 1; - END_ON_LOWER_PAD = 2; - UPPER_PAD_TO_LOWER_PAD = 3; - UNKNOWN_RANGE = 4; -} - -// SOLDERBALL_SHAPE type enum -enum SolderballShape { - NO_SOLDERBALL = 0; - SOLDERBALL_CYLINDER = 1; - SOLDERBALL_SPHEROID = 2; - UNKNOWN_SOLDERBALL_SHAPE = 3; -} - -// SOLDERBALL_PLACEMENT type enum -enum SolderballPlacement { - ABOVE_PADSTACK = 0; - BELOW_PADSTACK = 1; - UNKNOWN_PLACEMENT = 2; -} - -service PadstackDefDataService { - // create a PadstackDefData - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - - // get material of PadstackDefData - rpc GetMaterial(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // set material of PadstackDefData - rpc SetMaterial(PadstackDefDataSetMaterialMessage) returns (google.protobuf.Empty) {} - - // get layer names from PadstackDefData - rpc GetLayerNames(EDBObjMessage) returns (PadstackDefDataGetLayerNamesMessage) {} - - // get LayerIds from PadstackDefData - rpc GetLayerIds(EDBObjMessage) returns (PadstackDefDataGetLayerIdsMessage) {} - - // add Layers to PadstackDefData - rpc AddLayers(PadstackDefDataAddLayersMessage) returns (google.protobuf.Empty) {} - - // get PadParameters of PadstackDefData - rpc GetPadParameters(PadstackDefDataGetPadParametersMessage) returns (PadstackDefDataPadParametersMessage) {} - - // set PadParameters of PadstackDefData - rpc SetPadParameters(PadstackDefDataPadParametersSetMessage) returns (google.protobuf.Empty) {} - - // get PadstackHoleRange of PadstackDefData - rpc GetHoleRange(EDBObjMessage) returns (PadstackDefDataPadstackHoleRangeMessage) {} - - // set PadstackHoleRange of PadstackDefData - rpc SetHoleRange(PadstackDefDataSetHoleRangeMessage) returns (google.protobuf.Empty) {} - - // get plating percentage of PadstackDefData - rpc GetPlatingPercentage(EDBObjMessage) returns (ValueMessage) {} - - // set plating percentage of PadstackDefData - rpc SetPlatingPercentage(PadstackDefDataSetPlatingPercentage) returns (google.protobuf.Empty) {} - - // get SolderBallShape of PadstackDefData - rpc GetSolderBallShape(EDBObjMessage) returns (PadstackDefDataSolderballShapeMessage) {} - - // set SolderBallShape of PadstackDefData - rpc SetSolderBallShape(PadstackDefDataSetSolderballShapeMessage) returns (google.protobuf.Empty) {} - - // get SolderBallPlacement of PadstackDefData - rpc GetSolderBallPlacement(EDBObjMessage) returns (PadstackDefDataSolderballPlacementMessage) {} - - // set SolderBallPlacement of PadstackDefData - rpc SetSolderBallPlacement(PadstackDefDataSetSolderballPlacementMessage) returns (google.protobuf.Empty) {} - - // get solderBall parameters of PadstackDefData - rpc GetSolderBallParam(EDBObjMessage) returns (PadstackDefDataGetSolderBallParamMessage) {} - - // set solderBall parameters of PadstackDefData - rpc SetSolderBallParam(PadstackDefDataSetSolderBallParamMessage) returns (google.protobuf.Empty) {} - - // get solderBall material of PadstackDefData - rpc GetSolderBallMaterial(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // set solderBall material of PadstackDefData - rpc SetSolderBallMaterial(PadstackDefDataSetSolderBallMaterialMessage) returns (google.protobuf.Empty) {} -} - -// Message representing target and material -message PadstackDefDataSetMaterialMessage { - EDBObjMessage target = 1; - string name = 2; -} - -// Message representing -message PadstackDefDataGetLayerNamesMessage { - repeated string names= 1; -} - -// Message representing multiple layer ids -message PadstackDefDataGetLayerIdsMessage { - repeated int32 ids = 1; -} - -// Message representing a target and multiple layer names -message PadstackDefDataAddLayersMessage{ - EDBObjMessage target = 1; - PadstackDefDataGetLayerNamesMessage layer_names = 2; -} - -// Message representing target to get pad parameters -message PadstackDefDataGetPadParametersMessage{ - EDBObjMessage target = 1; - oneof layer { - string layer_name = 2; - int32 layer_id = 3; - } - PadType pad_type = 4; -} - -// Message representing get pad parameters -message PadstackDefDataGetPadParametersParametersMessage{ - PadGeometryType geometry_type = 1; - repeated ValueMessage sizes = 2; - ValueMessage offset_x = 3; - ValueMessage offset_y = 4; - ValueMessage rotation = 5; -} - -message PadstackDefDataSetPadParametersMessage{ - PadstackDefDataGetPadParametersMessage params1 = 1; - PadstackDefDataGetPadParametersParametersMessage params2 = 2; -} - -message PadstackDefDataGetPolygonalPadParametersParametersMessage{ - PolygonDataMessage fp = 1; - ValueMessage offset_x = 2; - ValueMessage offset_y = 3; - ValueMessage rotation = 4; -} - -message PadstackDefDataSetPolygonalPadParametersMessage{ - PadstackDefDataGetPadParametersMessage params1 = 1; - PolygonDataMessage fp = 2; - ValueMessage offset_x = 3; - ValueMessage offset_y = 4; - ValueMessage rotation = 5; -} - -message PadstackDefDataPadParametersMessage{ - oneof pad_message { - PadstackDefDataGetPadParametersParametersMessage generic = 1; - PadstackDefDataGetPolygonalPadParametersParametersMessage polygon = 2; - } -} - -message PadstackDefDataPadParametersSetMessage{ - oneof pad_message { - PadstackDefDataSetPadParametersMessage generic = 1; - PadstackDefDataSetPolygonalPadParametersMessage polygon = 2; - } -} - -message PadstackDefDataPadstackHoleRangeMessage{ - PadstackHoleRange hole_range = 1; -} - -message PadstackDefDataSetHoleRangeMessage{ - EDBObjMessage target = 1; - PadstackHoleRange hole_range = 2; -} - -message PadstackDefDataSetPlatingPercentage{ - EDBObjMessage target = 1; - ValueMessage plating_percentage = 2; -} - -message PadstackDefDataSolderballShapeMessage{ - SolderballShape solderball_shape = 1; -} - -message PadstackDefDataSetSolderballShapeMessage{ - EDBObjMessage target = 1; - SolderballShape solderball_shape = 2; -} - -message PadstackDefDataSolderballPlacementMessage{ - SolderballPlacement solderball_placement = 1; -} - -message PadstackDefDataSetSolderballPlacementMessage{ - EDBObjMessage target = 1; - SolderballPlacement solderball_placement = 2; -} - -message PadstackDefDataGetSolderBallParamMessage{ - ValueMessage d1 = 1; - ValueMessage d2 = 2; -} - -message PadstackDefDataSetSolderBallParamMessage{ - EDBObjMessage target = 1; - ValueMessage d1 = 2; - ValueMessage d2 = 3; -} - -message PadstackDefDataSetSolderBallMaterialMessage{ - EDBObjMessage target = 1; - string material = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/padstack_inst_term.proto b/protos/ansys/api/edb/v1/padstack_inst_term.proto deleted file mode 100644 index 6797d72109..0000000000 --- a/protos/ansys/api/edb/v1/padstack_inst_term.proto +++ /dev/null @@ -1,33 +0,0 @@ -// Proto file representing the EDB PadstackInstTerm class - -syntax = "proto3"; -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; - -service PadstackInstanceTerminalService { - rpc Create (PadstackInstTermCreationsMessage) returns (EDBObjMessage) {} - - rpc GetParameters (EDBObjMessage) returns (PadstackInstTermParamsMessage) {} - - rpc SetParameters (PadstackInstTermSetParamsMessage) returns (google.protobuf.Empty) {} -} - -message PadstackInstTermParamsMessage { - EDBObjMessage padstack_instance = 1; - LayerRefMessage layer = 2; -} - -message PadstackInstTermCreationsMessage { - EDBObjMessage layout = 1; - NetRefMessage net = 2; - string name = 3; - PadstackInstTermParamsMessage params = 4; - bool is_ref = 5; -} - -message PadstackInstTermSetParamsMessage { - EDBObjMessage term = 1; - PadstackInstTermParamsMessage params = 2; -} diff --git a/protos/ansys/api/edb/v1/padstack_instance.proto b/protos/ansys/api/edb/v1/padstack_instance.proto deleted file mode 100644 index bfe25698e1..0000000000 --- a/protos/ansys/api/edb/v1/padstack_instance.proto +++ /dev/null @@ -1,180 +0,0 @@ -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; - -// BACK_DRILL_TYPE type enum -enum BackDrillType { - NO_DRILL = 0; - LAYER_DRILL = 1; - DEPTH_DRILL = 2; -} - -service PadstackInstanceService { - // create a PadstackInst - rpc Create(PadstackInstCreateMessage) returns (EDBObjMessage) {} - - // Get PadstackDef from PadstackInst - rpc GetPadstackDef(EDBObjMessage) returns (EDBObjMessage) {} - - // Get name of PadstackInst - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - - // Set name of PadstackInst - rpc SetName(EDBObjNameMessage) returns (google.protobuf.Empty) {} - - // Get position and rotation from PadstackInst - rpc GetPositionAndRotation(EDBObjMessage) returns (PadstackInstPositionAndRotationMessage) {} - - // Set position and rotation of PadstackInst - rpc SetPositionAndRotation(PadstackInstSetPositionAndRotationMessage) returns (google.protobuf.Empty) {} - - // Get layer range from PadstackInst - rpc GetLayerRange(EDBObjMessage) returns (PadstackInstLayerRangeMessage) {} - - // Set layer range of PadstackInst - rpc SetLayerRange(PadstackInstSetLayerRangeMessage) returns (google.protobuf.Empty) {} - - // Get SolderBall Layer from PadstackInst - rpc GetSolderBallLayer(EDBObjMessage) returns (EDBObjMessage) {} - - // Set SolderBall Layer of PadstackInst - rpc SetSolderBallLayer(PadstackInstSetSolderBallLayerMessage) returns (google.protobuf.Empty) {} - - // Get Layer Map from PadstackInst - rpc GetLayerMap(EDBObjMessage) returns (EDBObjMessage) {} - - // Set Layer Map from PadstackInst - rpc SetLayerMap(PointerPropertyMessage) returns (google.protobuf.Empty) {} - - // Get Hole Overrides from PadstackInst - rpc GetHoleOverrides(EDBObjMessage) returns (PadstackInstHoleOverridesMessage) {} - - // Set Hole Overrides of PadstackInst - rpc SetHoleOverrides(PadstackInstSetHoleOverridesMessage) returns (google.protobuf.Empty) {} - - // Check if PadstackInst is layout pin - rpc GetIsLayoutPin(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set PadstackInst to be layout pin - rpc SetIsLayoutPin(PadstackInstSetIsLayoutPinMessage) returns (google.protobuf.Empty) {} - - // Get Back Drill Type from PadstackInst - rpc GetBackDrillType(PadstackInstGetBackDrillMessage) returns (PadstackInstBackDrillTypeMessage) {} - - // Get back drill by layer from PadstackInst - rpc GetBackDrillByLayer(PadstackInstGetBackDrillMessage) returns (PadstackInstBackDrillByLayerMessage) {} - - // Get back drill by depth from PadstackInst - rpc GetBackDrillByDepth(PadstackInstGetBackDrillMessage) returns (PadstackInstBackDrillByDepthMessage) {} - - // Set back drill of PadstackInst by layer by Layer - rpc SetBackDrillByLayer(PadstackInstSetBackDrillByLayerMessage) returns (google.protobuf.Empty) {} - - // Set back drill of PadstackInst by layer by Depth - rpc SetBackDrillByDepth(PadstackInstSetBackDrillByDepthMessage) returns (google.protobuf.Empty) {} - - // Get Terminal of PadstackInst - rpc GetPadstackInstanceTerminal(EDBObjMessage) returns (EDBObjMessage) {} - - // Check if PadstackInst is in pin group - rpc IsInPinGroup(PadstackInstIsInPinGroupMessage) returns (google.protobuf.BoolValue) {} - - // Get pin groups of PadstackInst - rpc GetPinGroups(EDBObjMessage) returns (EDBObjCollectionMessage ) {} - -} - -message PadstackInstCreateMessage{ - EDBObjMessage layout = 1; - EDBObjMessage net = 2; - string name = 3; - EDBObjMessage padstack_def = 4; - ValueMessage rotation = 5; - EDBObjMessage top_layer = 6; - EDBObjMessage bottom_layer = 7; - EDBObjMessage solder_ball_layer = 8; - EDBObjMessage layer_map = 9; -} - -message PadstackInstPositionAndRotationMessage { - PointMessage position = 1; - ValueMessage rotation = 2; -} - -message PadstackInstSetPositionAndRotationMessage { - EDBObjMessage target = 1; - PadstackInstPositionAndRotationMessage params = 2; -} - -message PadstackInstLayerRangeMessage { - EDBObjMessage top_layer = 1; - EDBObjMessage bottom_layer = 2; -} - -message PadstackInstSetLayerRangeMessage { - EDBObjMessage target = 1; - PadstackInstLayerRangeMessage range = 2; -} - -message PadstackInstSetSolderBallLayerMessage { - EDBObjMessage target = 1; - EDBObjMessage layer = 2; -} - -message PadstackInstHoleOverridesMessage { - bool is_hole_override = 1; - ValueMessage hole_override = 2; -} - -message PadstackInstSetHoleOverridesMessage { - EDBObjMessage target = 1; - PadstackInstHoleOverridesMessage hole_override_msg = 2; -} - -message PadstackInstBackDrillTypeMessage { - BackDrillType type = 1; -} - -message PadstackInstSetIsLayoutPinMessage { - EDBObjMessage target = 1; - bool is_layout_pin = 2; -} - -message PadstackInstGetBackDrillMessage { - EDBObjMessage target = 1; - bool from_bottom = 2; -} - -message PadstackInstBackDrillByLayerMessage { - EDBObjMessage drill_to_layer = 1; - ValueMessage diameter = 2; - ValueMessage offset = 3; -} - -message PadstackInstBackDrillByDepthMessage { - ValueMessage drill_depth = 1; - ValueMessage diameter = 2; -} - -message PadstackInstSetBackDrillByLayerMessage { - EDBObjMessage target = 1; - EDBObjMessage drill_to_layer = 2; - ValueMessage offset = 3; - ValueMessage diameter = 4; - bool from_bottom = 5; -} - -message PadstackInstSetBackDrillByDepthMessage { - EDBObjMessage target = 1; - ValueMessage drill_depth = 2; - ValueMessage diameter = 3; - bool from_bottom = 4; -} - -message PadstackInstIsInPinGroupMessage{ - EDBObjMessage target = 1; - EDBObjMessage pin_group = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/path.proto b/protos/ansys/api/edb/v1/path.proto deleted file mode 100644 index 9be7b8fa46..0000000000 --- a/protos/ansys/api/edb/v1/path.proto +++ /dev/null @@ -1,154 +0,0 @@ -// Proto file representing the EDB Path class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "polygon_data.proto"; -import "refs.proto"; - -enum PathEndCapStyle { - ROUND = 0; - FLAT = 1; - EXTENDED = 2; - CLIPPED = 3; - INVALID_END_CAP = -1; -} - -enum PathCornerStyle { - ROUND_CORNER = 0; - SHARP_CORNER = 1; - MITER_CORNER = 2; -} - -service PathService { - rpc Create (PathCreationMessage) returns (EDBObjMessage) {} - - // Render Path - rpc Render (PathRenderMessage) returns (PolygonDataMessage) {} - - // Get Polygon Data - rpc GetPolygonData (EDBObjMessage) returns (PolygonDataMessage) {} - - // Get Center Line - rpc GetCenterLine (EDBObjMessage) returns (PolygonDataMessage) {} - - // Set Center Line - rpc SetCenterLine (SetCenterLineMessage) returns (google.protobuf.Empty) {} - - // Get End Cap Style - rpc GetEndCapStyle (EDBObjMessage) returns (EndCapStyleMessage) {} - - // Set End Cap Style - rpc SetEndCapStyle (SetEndCapStyleMessage) returns (google.protobuf.Empty) {} - - // Get Clip Info - rpc GetClipInfo (EDBObjMessage) returns (ClipInfoMessage) {} - - // Set Clip Info - rpc SetClipInfo (SetClipInfoMessage) returns (google.protobuf.Empty) {} - - // Get Corner Style - rpc GetCornerStyle (EDBObjMessage) returns (CornerStyleMessage) {} - - // Set Corner Style - rpc SetCornerStyle (SetCornerStyleMessage) returns (google.protobuf.Empty) {} - - // Get Width - rpc GetWidth (EDBObjMessage) returns (WidthMessage) {} - - // Set Width - rpc SetWidth (SetWidthMessage) returns (google.protobuf.Empty) {} - - // Get Miter Ratio - rpc GetMiterRatio (EDBObjMessage) returns (MiterRatioMessage) {} - - // Set Miter Ratio - rpc SetMiterRatio (SetMiterRatioMessage) returns (google.protobuf.Empty) {} -} - -// Message for Create -message PathCreationMessage { - EDBObjMessage layout = 1; - LayerRefMessage layer = 2; - NetRefMessage net = 3; - ValueMessage width = 4; - PathEndCapStyle end_cap1 = 5; - PathEndCapStyle end_cap2 = 6; - PathCornerStyle corner = 7; - PolygonDataMessage points = 8; -} - -// Message for Render -message PathRenderMessage { - ValueMessage width = 1; - PathEndCapStyle end_cap1 = 2; - PathEndCapStyle end_cap2 = 3; - PathCornerStyle corner_style = 4; - PolygonDataMessage path = 5; -} - -// Message for Setting Center Line -message SetCenterLineMessage{ - EDBObjMessage target = 1; - PolygonDataMessage center_line = 2; -} - -// Message for Get EndCapStyle -message EndCapStyleMessage{ - PathEndCapStyle end_cap1 = 1; - PathEndCapStyle end_cap2 = 2; -} - -// Message for Set EndCapStyle -message SetEndCapStyleMessage{ - EDBObjMessage target = 1; - EndCapStyleMessage end_cap = 2; -} - -// Message for Get ClipInfo -message ClipInfoMessage{ - PolygonDataMessage clipping_poly = 1; - bool keep_inside = 2; -} - -// Message for Set ClipInfo -message SetClipInfoMessage{ - EDBObjMessage target = 1; - PolygonDataMessage clipping_poly = 2; - bool keep_inside = 3; -} - -// Message for Get Corner Style -message CornerStyleMessage{ - PathCornerStyle corner_style = 1; -} - -// Message for Set Corner Style -message SetCornerStyleMessage{ - EDBObjMessage target = 1; - CornerStyleMessage corner_style = 2; -} - -// Message for Get Width -message WidthMessage{ - ValueMessage width = 1; -} - -// Message for Set Width -message SetWidthMessage{ - EDBObjMessage target = 1; - WidthMessage width = 2; -} - -// Message for Get Miter Ratio -message MiterRatioMessage{ - ValueMessage miter_ratio = 1; -} - -// Message for Set Miter Ratio -message SetMiterRatioMessage{ - EDBObjMessage target = 1; - MiterRatioMessage miter_ratio = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/pin_group.proto b/protos/ansys/api/edb/v1/pin_group.proto deleted file mode 100644 index 1ca7857669..0000000000 --- a/protos/ansys/api/edb/v1/pin_group.proto +++ /dev/null @@ -1,44 +0,0 @@ -// Proto file representing the EDB PinGroup class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service PinGroupService { - rpc Create (PinGroupCreationMessage) returns (EDBObjMessage) {} - - rpc FindByName (PinGroupLookupMessage) returns (EDBObjMessage) {} - - rpc GetUniqueName (PinGroupGetUniqueNameMessage) returns (google.protobuf.StringValue) {} - - rpc GetName (EDBObjMessage) returns (google.protobuf.StringValue) {} - - rpc AddPins (PinGroupPinsModifyMessage) returns (google.protobuf.Empty) {} - - rpc RemovePins (PinGroupPinsModifyMessage) returns (google.protobuf.Empty) {} - - rpc GetPins (EDBObjMessage) returns (EDBObjCollectionMessage) {} -} - -message PinGroupCreationMessage { - EDBObjMessage layout = 1; - string name = 2; - repeated EDBObjMessage pins = 3; -} - -message PinGroupLookupMessage { - EDBObjMessage layout = 1; - string name = 2; -} - -message PinGroupGetUniqueNameMessage { - EDBObjMessage layout = 1; - string prefix = 2; -} - -message PinGroupPinsModifyMessage { - EDBObjMessage pin_group = 1; - repeated EDBObjMessage pins = 2; -} diff --git a/protos/ansys/api/edb/v1/pin_group_term.proto b/protos/ansys/api/edb/v1/pin_group_term.proto deleted file mode 100644 index 1db823aacb..0000000000 --- a/protos/ansys/api/edb/v1/pin_group_term.proto +++ /dev/null @@ -1,37 +0,0 @@ -// Proto file representing the EDB PinGroupTerm class - -syntax = "proto3"; -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; - -service PinGroupTerminalService { - rpc Create (PinGroupTermCreationMessage) returns (EDBObjMessage) {} - - rpc GetPinGroup (EDBObjMessage) returns (EDBObjMessage) {} - - rpc SetPinGroup (PinGroupTermSetPinGroupMessage) returns (google.protobuf.Empty) {} - - rpc GetLayer (EDBObjMessage) returns (EDBObjMessage) {} - - rpc SetLayer (PinGroupTermSetLayerMessage) returns (google.protobuf.Empty) {} -} - -message PinGroupTermCreationMessage { - EDBObjMessage layout = 1; - NetRefMessage net = 2; - string name = 3; - EDBObjMessage pin_group = 4; - bool is_ref = 5; -} - -message PinGroupTermSetPinGroupMessage { - EDBObjMessage term = 1; - EDBObjMessage pin_group = 2; -} - -message PinGroupTermSetLayerMessage { - EDBObjMessage term = 1; - LayerRefMessage layer = 2; -} diff --git a/protos/ansys/api/edb/v1/pin_pair_model.proto b/protos/ansys/api/edb/v1/pin_pair_model.proto deleted file mode 100644 index dc0c72fe1e..0000000000 --- a/protos/ansys/api/edb/v1/pin_pair_model.proto +++ /dev/null @@ -1,27 +0,0 @@ -// Proto file representing the PinPairModel class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "rlc.proto"; - -service PinPairModelService { - rpc Create (google.protobuf.Empty) returns (EDBObjMessage) {} - rpc GetRlc (StringPairPropertyMessage) returns (PinPairRlcMessage) {} - rpc SetRlc (PinPairModelRlcPropertyMessage) returns (google.protobuf.Empty) {} - rpc DeleteRlc (StringPairPropertyMessage) returns (google.protobuf.Empty) {} - rpc GetPinPairs (EDBObjMessage) returns (StringPairsMessage) {} -} - -message PinPairModelRlcPropertyMessage { - EDBObjMessage model = 1; - StringPairMessage pins = 2; - RlcMessage rlc = 3; -} - -message PinPairRlcMessage { - bool found = 1; - RlcMessage rlc = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/point_3d_data.proto b/protos/ansys/api/edb/v1/point_3d_data.proto deleted file mode 100644 index 1cd793b473..0000000000 --- a/protos/ansys/api/edb/v1/point_3d_data.proto +++ /dev/null @@ -1,45 +0,0 @@ -// Proto file representing the EDB Point 3D Data class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -message Point3DMessage { - ValueMessage x = 1; - ValueMessage y = 2; - ValueMessage z = 3; -} - -message Point3DPropertyMessage { - EDBObjMessage target = 1; - Point3DMessage value = 2; -} - -message CPos3DMessage { - double x = 1; - double y = 2; - double z = 3; -} - -message CPos3DPropertyMessage { - EDBObjMessage target = 1; - CPos3DMessage value = 2; -} - -message CPos3DPairMessage { - CPos3DMessage x = 1; - CPos3DMessage y = 2; -} - -message CPos3DTripleMessage { - CPos3DMessage x = 1; - CPos3DMessage y = 2; - CPos3DMessage z = 3; -} - -message CPos3DDoubleMessage { - CPos3DMessage pos = 1; - double value = 2; -} diff --git a/protos/ansys/api/edb/v1/point_data.proto b/protos/ansys/api/edb/v1/point_data.proto deleted file mode 100644 index 895de2d84d..0000000000 --- a/protos/ansys/api/edb/v1/point_data.proto +++ /dev/null @@ -1,70 +0,0 @@ -// Proto file representing the EDB Point Data class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -enum PolySense { - SENSE_UNKNOWN = 0; - SENSE_CW = 1; - SENSE_CCW = 2; -} - -service PointDataService { - rpc Rotate (PointDataRotateMessage) returns (PointMessage) {} - rpc ClosestPoint (PointDataWithLineMessage) returns (PointMessage) {} - rpc Distance (PointDataWithLineMessage) returns (google.protobuf.FloatValue) {} -} - -message PointMessage { - ValueMessage x = 1; - ValueMessage y = 2; -} - -message PointsMessage { - repeated PointMessage points = 1; -} - -message PointPropertyMessage { - EDBObjMessage target = 1; - PointMessage point = 2; -} - -message PointsPropertyMessage { - EDBObjMessage target = 1; - repeated PointMessage points = 2; -} - -message PointDataRotateMessage { - PointMessage point = 1; - PointMessage rotate_center = 2; - float rotate_angle = 3; -} - -message PointPairMessage { - PointMessage point_0 = 1; - PointMessage point_1 = 2; -} - -message PointPairPropertyMessage { - PointPairMessage point_pair = 1; - EDBObjMessage target = 2; -} - -message PointDataWithLineMessage { - PointMessage point = 1; - PointMessage line_start = 2; - PointMessage line_end = 3; -} - -message BoxMessage { - PointMessage lower_left = 1; - PointMessage upper_right = 2; -} - -message CircleMessage { - PointMessage center = 1; - ValueMessage radius = 2; -} diff --git a/protos/ansys/api/edb/v1/point_term.proto b/protos/ansys/api/edb/v1/point_term.proto deleted file mode 100644 index 485404eff1..0000000000 --- a/protos/ansys/api/edb/v1/point_term.proto +++ /dev/null @@ -1,35 +0,0 @@ -// Proto file representing the EDB Point Term class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; -import "refs.proto"; - -service PointTerminalService { - // Create a point term - rpc Create (PointTermCreationMessage) returns (EDBObjMessage) {} - - rpc GetParameters(EDBObjMessage) returns (PointTermParamsMessage) {} - - rpc SetParameters(PointTermSetParamsMessage) returns (google.protobuf.Empty) {} -} - -message PointTermCreationMessage { - EDBObjMessage layout = 1; - NetRefMessage net = 2; - string name = 3; - PointTermParamsMessage params = 4; -} - -message PointTermParamsMessage { - PointMessage point = 1; - LayerRefMessage layer = 2; -} - -message PointTermSetParamsMessage { - EDBObjMessage term = 1; - PointTermParamsMessage params = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/polygon.proto b/protos/ansys/api/edb/v1/polygon.proto deleted file mode 100644 index 9d4fb3cc17..0000000000 --- a/protos/ansys/api/edb/v1/polygon.proto +++ /dev/null @@ -1,35 +0,0 @@ -// Proto file representing the EDB Polygon class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "polygon_data.proto"; -import "refs.proto"; - -// Polygon service definition -service PolygonService { - // Create a polygon - rpc Create (PolygonCreationMessage) returns (EDBObjMessage) {} - - // Get PolygonData - rpc GetPolygonData (EDBObjMessage) returns (PolygonDataMessage) {} - - // Set PolygonData - rpc SetPolygonData (SetPolygonDataMessage) returns (google.protobuf.Empty) {} -} - -// Message for Create -message PolygonCreationMessage { - EDBObjMessage layout = 1; - LayerRefMessage layer = 2; - NetRefMessage net = 3; - PolygonDataMessage points = 4; -} - -// Message for Set PolygonData -message SetPolygonDataMessage { - EDBObjMessage target = 1; - PolygonDataMessage poly = 2; -} diff --git a/protos/ansys/api/edb/v1/polygon_data.proto b/protos/ansys/api/edb/v1/polygon_data.proto deleted file mode 100644 index 67ce664f9e..0000000000 --- a/protos/ansys/api/edb/v1/polygon_data.proto +++ /dev/null @@ -1,133 +0,0 @@ -// Proto file representing the EDB Polygon Data class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; - -enum IntersectionType -{ - NO_INTERSECTION = 0; - THIS_INSIDE_OTHER = 1; - OTHER_INSIDE_THIS = 2; - COMMON_INTERSECTION = 3; - UNDEFINED_INTERSECTION = 4; -}; - -// Polygon Data service definition -service PolygonDataService { - rpc GetNormalizedPoints (PolygonDataMessage) returns (PointsMessage) {} - rpc IsCircle (PolygonDataMessage) returns (google.protobuf.BoolValue) {} - rpc IsBox (PolygonDataMessage) returns (google.protobuf.BoolValue) {} - rpc HasSelfIntersections (PolygonDataWithToleranceMessage) returns (google.protobuf.BoolValue) {} - rpc RemoveSelfIntersections (PolygonDataWithToleranceMessage) returns (PolygonDataListMessage) {} - rpc IsConvex (PolygonDataMessage) returns (google.protobuf.BoolValue) {} - rpc GetArea (PolygonDataMessage) returns (google.protobuf.FloatValue) {} - rpc Transform (PolygonDataTransformMessage) returns (PolygonDataMessage) {} - rpc GetBBox (PolygonDataListMessage) returns (BoxMessage) {} - rpc GetConvexHull (PolygonDataListMessage) returns (PolygonDataMessage) {} - rpc RemoveArcs (PolygonDataRemoveArcMessage) returns (PolygonDataMessage) {} - rpc Defeature (PolygonDataWithToleranceMessage) returns (PolygonDataMessage) {} - rpc GetBoundingCircle (PolygonDataMessage) returns (CircleMessage) {} - rpc IsInside (PolygonDataWithPointMessage) returns (google.protobuf.BoolValue) {} - rpc CircleIntersectsPolygon (PolygonDataWithCircleMessage) returns (google.protobuf.BoolValue) {} - rpc GetIntersectionType (PolygonDataPairWithToleranceMessage) returns (IntersectionTypeMessage) {} - rpc GetClosestPoints (PolygonDataWithPointsMessage) returns (PointsMessage) {} - rpc GetUnion (PolygonDataListMessage) returns (PolygonDataListMessage) {} - rpc GetIntersection (PolygonDataPairMessage) returns (PolygonDataListMessage) {} - rpc Subtract (PolygonDataPairMessage) returns (PolygonDataListMessage) {} - rpc Xor (PolygonDataPairMessage) returns (PolygonDataListMessage) {} - rpc Expand (PolygonDataExpandMessage) returns (PolygonDataListMessage) {} - rpc Get2DAlphaShape (PolygonDataGetAlphaShapeMessage) returns (PolygonDataListMessage) {} -} - -message PolygonDataMessage { - repeated PointMessage points = 1; - bool closed = 2; - PolySense sense = 3; - repeated PolygonDataMessage holes = 4; -} - -message PolygonDataListMessage { - repeated PolygonDataMessage polygons = 1; -} - -message PolygonDataWithToleranceMessage { - PolygonDataMessage polygon = 1; - float tol = 2; -} - -message PolygonDataPairMessage { - PolygonDataListMessage first = 1; - PolygonDataListMessage second = 2; -} - -message PolygonDataPairWithToleranceMessage { - PolygonDataMessage first = 1; - PolygonDataMessage second = 2; - float tol = 3; -} - -message PolygonDataTransformMessage { - message PointValueMessage { - PointMessage point = 1; - float value = 2; - } - - PolygonDataMessage polygon = 1; - oneof op { - PointMessage move = 2; - PointValueMessage rotate = 3; - PointValueMessage scale = 4; - float mirror_x = 5; - } -} - -message PolygonDataRemoveArcMessage { - PolygonDataMessage polygon = 1; - float max_chord_error = 2; - float max_arc_angle = 3; - int64 max_points = 4; -} - -message PolygonDataWithCircleMessage { - PolygonDataMessage polygon = 1; - CircleMessage circle = 2; -} - -message PolygonDataWithPointMessage { - PolygonDataMessage target = 1; - PointMessage point = 2; -} - -message PolygonDataWithPointsMessage { - PolygonDataMessage target = 1; - oneof coord { - PointMessage point = 2; - PolygonDataMessage polygon = 3; - } -} - -message PolygonDataExpandMessage { - PolygonDataMessage polygon = 1; - float offset = 2; - float tol = 3; - bool round_corner = 4; - float max_corner_extension = 5; -} - -message PolygonDataGetAlphaShapeMessage { - repeated PointMessage points = 1; - float alpha = 2; -} - -message IntersectionTypeMessage { - IntersectionType intersection_type = 1; -} - -message PolygonDataPropertyMessage { - EDBObjMessage target = 1; - PolygonDataMessage value = 2; -} diff --git a/protos/ansys/api/edb/v1/port_post_processing_prop.proto b/protos/ansys/api/edb/v1/port_post_processing_prop.proto deleted file mode 100644 index 6d32303779..0000000000 --- a/protos/ansys/api/edb/v1/port_post_processing_prop.proto +++ /dev/null @@ -1,17 +0,0 @@ -// Proto file representing references to EDB Port Post Processing Prop - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -message PortPostProcessingPropMessage { - ValueMessage voltage_magnitude = 1; - ValueMessage voltage_phase = 2; - ValueMessage deembed_length = 3; - ValueMessage renormalization_impedance = 4; - bool do_deembed = 5; - bool do_deembed_gap_length = 6; - bool do_renormalize = 7; -} diff --git a/protos/ansys/api/edb/v1/port_property.proto b/protos/ansys/api/edb/v1/port_property.proto deleted file mode 100644 index 4e379fa4a2..0000000000 --- a/protos/ansys/api/edb/v1/port_property.proto +++ /dev/null @@ -1,25 +0,0 @@ -// Proto file representing the Port Property class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -// Port Property service definition -service PortPropertyService { - - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - rpc Clone(EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetReferenceHeight(EDBObjMessage) returns (ValueMessage) {} - rpc SetReferenceHeight(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetReferenceSizeAuto(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetReferenceSizeAuto(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetReferenceSize(EDBObjMessage) returns (ValuePairMessage) {} - rpc SetReferenceSize(ValuePairPropertyMessage) returns (google.protobuf.Empty) {} -} diff --git a/protos/ansys/api/edb/v1/primitive.proto b/protos/ansys/api/edb/v1/primitive.proto deleted file mode 100644 index b19e1787bb..0000000000 --- a/protos/ansys/api/edb/v1/primitive.proto +++ /dev/null @@ -1,106 +0,0 @@ -// Proto file representing the EDB Primitive class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "refs.proto"; - -// Primitive type enum -enum PrimitiveType { - RECTANGLE = 0; - CIRCLE = 1; - POLYGON = 2; - PATH = 3; - BONDWIRE = 4; - PRIM_PLUGIN = 5; - TEXT = 6; - PATH_3D = 7; - BOARD_BEND = 8; - INVALID_TYPE = 9; -} - -// Primitive service definition -service PrimitiveService { - // Gets the primitive type of this primitive - rpc GetPrimitiveType (EDBObjMessage) returns (PrimitiveTypeMessage) {} - - // Adds a void - rpc AddVoid (PrimitiveVoidCreationMessage) returns (google.protobuf.Empty) {} - - // Sets HFSS Properties - rpc SetHfssProp (PrimitiveHfssPropMessage) returns (google.protobuf.Empty) {} - - // Get Layer - rpc GetLayer (EDBObjMessage) returns (EDBObjMessage) {} - - // Set Layer - rpc SetLayer (SetLayerMessage) returns (google.protobuf.Empty) {} - - // Get IsNegative - rpc GetIsNegative (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set IsNegative - rpc SetIsNegative (SetIsNegativeMessage) returns (google.protobuf.Empty) {} - - // Get isVoid - rpc IsVoid (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Get HasVoids - rpc HasVoids(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Gets an iterator of the voids in the Primitive - rpc Voids(EDBObjMessage) returns (EDBObjCollectionMessage) {} - - // Get Owner - rpc GetOwner(EDBObjMessage) returns (EDBObjMessage) {} - - // Get isParametrized - rpc IsParameterized(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Get HFSS Properties - rpc GetHfssProp (EDBObjMessage) returns (GetPrimitiveHfssPropMessage) {} - - // Remove HFSS Properties - rpc RemoveHfssProp (EDBObjMessage) returns (google.protobuf.Empty) {} - - // Get Is Zone Primitive - rpc IsZonePrimitive (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Make primitive a zone primitive in the specified zone - rpc MakeZonePrimitive (IntPropertyMessage) returns (google.protobuf.Empty) {} -} - -// Message for GetPrimitiveType -message PrimitiveTypeMessage { - PrimitiveType type = 1; -} - -message PrimitiveVoidCreationMessage { - EDBObjMessage target = 1; - EDBObjMessage hole = 2; -} - -message PrimitiveHfssPropMessage { - EDBObjMessage target = 1; - string material_name = 2; - bool solve_inside = 3; -} - -message GetPrimitiveHfssPropMessage { - string material_name = 1; - bool solve_inside = 2; -} - -message SetLayerMessage { - EDBObjMessage target = 1; - LayerRefMessage layer = 2; -} - -message SetIsNegativeMessage { - EDBObjMessage target = 1; - bool is_negative = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/r_tree.proto b/protos/ansys/api/edb/v1/r_tree.proto deleted file mode 100644 index d3b6a255f1..0000000000 --- a/protos/ansys/api/edb/v1/r_tree.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Proto file representing the EDB RTree class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "point_data.proto"; -import "polygon_data.proto"; - -service RTreeService { - rpc Create (google.protobuf.DoubleValue) returns (EDBObjMessage) {} - - rpc GetExtent (EDBObjMessage) returns (BoxMessage) {} - - rpc InsertIntObject (RTreeObjMessage) returns (google.protobuf.Empty) {} - - rpc DeleteIntObject (RTreeObjMessage) returns (google.protobuf.Empty) {} - - rpc Empty (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - rpc Search (RTreeSearchMessage) returns (IntegersPropertyMessage) {} - - rpc NearestNeighbor(RTreeObjMessage) returns (NearestNeighborResponseMessage) {} - - rpc TouchingGeometry (RTreeGeometryRequestMessage) returns (IntegersPropertyMessage) {} - - rpc ConnectedGeometry(RTreeGeometryRequestMessage) returns (IntegersPropertyMessage) {} - - rpc GetConnectedGeometrySets (EDBObjMessage) returns (GeometrySetsMessage) {} - - rpc IncrementVisit(EDBObjMessage) returns (google.protobuf.Empty) {} - - rpc IsVisited (RTreeObjMessage) returns (google.protobuf.BoolValue) {} - - rpc Visit(RTreeObjMessage) returns (google.protobuf.Empty) {} - - rpc GetVisit(EDBObjMessage) returns (google.protobuf.Int64Value) {} -} - -message RTreeObjMessage { - EDBObjMessage target = 1; - PolygonDataMessage polygon = 2; - uint64 prop = 3; -} - -message RTreeSearchMessage { - EDBObjMessage target = 1; - BoxMessage box = 2; - bool bb_search = 3; -} - -message NearestNeighborResponseMessage { - uint64 id = 1; - BoxMessage coordinates = 2; -} - -message RTreeGeometryRequestMessage { - EDBObjMessage target = 1; - PolygonDataMessage polygon = 2; - int64 prop = 3; - bool increment_visit = 4; -} - -message GeometrySetsMessage { - repeated int64 id = 1; - repeated int64 sizes = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/raptor_x_simulation_settings.proto b/protos/ansys/api/edb/v1/raptor_x_simulation_settings.proto deleted file mode 100644 index f1f084a3d0..0000000000 --- a/protos/ansys/api/edb/v1/raptor_x_simulation_settings.proto +++ /dev/null @@ -1,121 +0,0 @@ -// Proto file representing raptorx simulation setup settings - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service RaptorXGeneralSettingsService { - rpc GetUseGoldEMSolver(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseGoldEMSolver(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaxFrequency(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMaxFrequency(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetGlobalTemperature(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetGlobalTemperature(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSaveNetlist(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetSaveNetlist(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetNetlistExportSpectre(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetNetlistExportSpectre(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSaveRFM(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetSaveRFM(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -service RaptorXAdvancedSettingsService { - rpc GetUseMeshFrequency(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseMeshFrequency(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMeshFrequency(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMeshFrequency(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseEdgeMesh(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseEdgeMesh(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetEdgeMesh(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetEdgeMesh(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseCellsPerWavelength(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseCellsPerWavelength(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetCellsPerWavelength(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetCellsPerWavelength(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUsePlaneProjectionFactor(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUsePlaneProjectionFactor(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPlaneProjectionFactor(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetPlaneProjectionFactor(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseRelaxedZAxis(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseRelaxedZAxis(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseEliminateSlitPerHoles(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseEliminateSlitPerHoles(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetEliminateSlitPerHoles(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetEliminateSlitPerHoles(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseArcResolution(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseArcResolution(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetArcResolution(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetArcResolution(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseAutoRemovalSliverPoly(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseAutoRemovalSliverPoly(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetAutoRemovalSliverPoly(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetAutoRemovalSliverPoly(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseAccelerateViaExtraction(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseAccelerateViaExtraction(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseEnableSubstrateNetworkExtraction(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseEnableSubstrateNetworkExtraction(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseLDE(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseLDE(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseExtractFloatingMetalsDummy(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseExtractFloatingMetalsDummy(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseExtractFloatingMetalsFloating(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseExtractFloatingMetalsFloating(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseEnableEtchTransform(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseEnableEtchTransform(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseEnableHybridExtraction(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseEnableHybridExtraction(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseEnableAdvancedCapEffects(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseEnableAdvancedCapEffects(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseOverrideShrinkFac(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseOverrideShrinkFac(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetOverrideShrinkFac(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetOverrideShrinkFac(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetAdvancedOptions(EDBObjMessage) returns (RaptorXSimSettingsOptionsMessage) {} - rpc SetAdvancedOptions(RaptorXSimSettingsOptionsPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetNetSettingsOptions(EDBObjMessage) returns (RaptorXSimSettingsOptionsMessage) {} - rpc SetNetSettingsOptions(RaptorXSimSettingsOptionsPropertyMessage) returns (google.protobuf.Empty) {} -} - -message RaptorXSimSettingsOptionsMessage -{ - map options = 1; -} - -message RaptorXSimSettingsOptionsPropertyMessage -{ - RaptorXSimSettingsOptionsMessage value = 1; - EDBObjMessage target = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/rectangle.proto b/protos/ansys/api/edb/v1/rectangle.proto deleted file mode 100644 index cd907f5c05..0000000000 --- a/protos/ansys/api/edb/v1/rectangle.proto +++ /dev/null @@ -1,69 +0,0 @@ -// Proto file representing the EDB Rectangle class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; -import "polygon_data.proto"; - -enum RectangleRepresentationType { - INVALID_RECT_TYPE = 0; - CENTER_WIDTH_HEIGHT = 1; - LOWER_LEFT_UPPER_RIGHT = 2; -} - -service RectangleService { - // Create a rectangle - rpc Create (RectangleCreationMessage) returns (EDBObjMessage) {} - - // Return Rectangle Parameters - rpc GetParameters (EDBObjMessage) returns (RectangleParametersMessage) {} - - // Recieve Rectangle Parameters - rpc SetParameters (SetRectangleParametersMessage) returns (google.protobuf.Empty) {} - - // Render Geometry PolygonData - rpc Render(RectanglePolygonDataMessage) returns (PolygonDataMessage) {} -} - -// Message for Create -message RectangleCreationMessage { - EDBObjMessage layout = 1; - LayerRefMessage layer = 2; - NetRefMessage net = 3; - RectangleRepresentationType representation_type = 4; - ValueMessage parameter1 = 5; - ValueMessage parameter2 = 6; - ValueMessage parameter3 = 7; - ValueMessage parameter4 = 8; - ValueMessage corner_radius = 9; - ValueMessage rotation = 10; -} - -// Message for rectangle parameters -message RectangleParametersMessage{ - RectangleRepresentationType representation_type = 1; - ValueMessage parameter1 = 2; - ValueMessage parameter2 = 3; - ValueMessage parameter3 = 4; - ValueMessage parameter4 = 5; - ValueMessage corner_radius = 6; - ValueMessage rotation = 7; -} - -message SetRectangleParametersMessage{ - EDBObjMessage target = 1; - RectangleParametersMessage parameters = 2; -} - -message RectanglePolygonDataMessage{ - ValueMessage center_x = 1; - ValueMessage center_y = 2; - ValueMessage width = 3; - ValueMessage height = 4; - ValueMessage corner_radius = 5; - ValueMessage rotation = 6; - bool ishole = 7; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/refs.proto b/protos/ansys/api/edb/v1/refs.proto deleted file mode 100644 index 54da848f4c..0000000000 --- a/protos/ansys/api/edb/v1/refs.proto +++ /dev/null @@ -1,33 +0,0 @@ -// Proto file representing references to EDB Object classes - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -message LayerRefMessage { - oneof ref { - EDBObjMessage id = 1; - google.protobuf.StringValue name = 2; - } -} - -message LayerRefPropertyMessage { - EDBObjMessage edb_obj = 1; - LayerRefMessage layer_ref = 2; -} - -message NetRefMessage { - oneof ref { - EDBObjMessage id = 1; - google.protobuf.StringValue name = 2; - } -} - -message CellInstanceRefMessage { - oneof ref { - EDBObjMessage id = 1; - google.protobuf.StringValue name = 2; - } -} diff --git a/protos/ansys/api/edb/v1/rlc.proto b/protos/ansys/api/edb/v1/rlc.proto deleted file mode 100644 index 54d2182d73..0000000000 --- a/protos/ansys/api/edb/v1/rlc.proto +++ /dev/null @@ -1,17 +0,0 @@ -// Proto file representing references to EDB Rlc classes - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -message RlcMessage { - ValueMessage r = 1; - ValueMessage l = 2; - ValueMessage c = 3; - google.protobuf.BoolValue r_enabled = 4; - google.protobuf.BoolValue l_enabled = 5; - google.protobuf.BoolValue c_enabled = 6; - google.protobuf.BoolValue is_parallel = 7; -} diff --git a/protos/ansys/api/edb/v1/rlc_component_property.proto b/protos/ansys/api/edb/v1/rlc_component_property.proto deleted file mode 100644 index 717f86b536..0000000000 --- a/protos/ansys/api/edb/v1/rlc_component_property.proto +++ /dev/null @@ -1,19 +0,0 @@ -// Proto file representing the RLC Component Property class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; - -// RLC Component Property service definition -service RLCComponentPropertyService { - // Create RLC Component Property - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - - // Get/Set enabled - rpc GetEnabled(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetEnabled(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} diff --git a/protos/ansys/api/edb/v1/simulation_settings.proto b/protos/ansys/api/edb/v1/simulation_settings.proto deleted file mode 100644 index 00a73c4411..0000000000 --- a/protos/ansys/api/edb/v1/simulation_settings.proto +++ /dev/null @@ -1,107 +0,0 @@ -// Proto file representing simulation setup settings - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -// SimulationSetup service definition -service SimulationSettingsService { - rpc GetEnabled (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - rpc SetEnabled (BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -// Settings options -service SettingsOptionsService { - rpc GetDoLamdaRefineFlag(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetDoLamdaRefineFlag(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetLamdaTarget(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetLamdaTarget(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseDefaultLamda(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseDefaultLamda(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -// Advanced settings -enum T25DViaStyle -{ - WIREBOND = 0; - RIBBON = 1; - MESH = 2; - FIELD = 3; - NUM_VIA_STYLE = 4; -} - -service AdvancedSettingsService { - rpc GetUnionPolygons(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUnionPolygons(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRemoveFloatingGeometry(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetRemoveFloatingGeometry(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSmallVoidArea(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetSmallVoidArea(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseDefeature(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseDefeature(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseDefeatureAbsoluteLength(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseDefeatureAbsoluteLength(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDefeatureAbsoluteLength(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetDefeatureAbsoluteLength(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDefeatureRatio(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetDefeatureRatio(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetViaModelType(EDBObjMessage) returns (ViaModelTypeMessage) {} - rpc SetViaModelType(ViaModelTypePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetNumViaSides(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetNumViaSides(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetViaDensity(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetViaDensity(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetViaMaterial(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetViaMaterial(StringPropertyMessage) returns (google.protobuf.Empty) {} -} - -message ViaModelTypeMessage { - T25DViaStyle via_model_type = 1; -} - -message ViaModelTypePropertyMessage { - EDBObjMessage target = 1; - T25DViaStyle via_model_type = 2; -} - -// Advanced meshing settings -service AdvancedMeshingSettingsService { - rpc GetArcStepSize(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetArcStepSize(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetCircleStartAzimuth(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetCircleStartAzimuth(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaxNumArcPoints(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMaxNumArcPoints(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseArcChordErrorApprox(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseArcChordErrorApprox(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetArcChordErrorApprox(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetArcChordErrorApprox(StringPropertyMessage) returns (google.protobuf.Empty) {} -} - -// Solver settings -service SolverSettingsService { - rpc GetThinSignalLayerThreshold(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetThinSignalLayerThreshold(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetThinDielectricLayerThreshold(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetThinDielectricLayerThreshold(StringPropertyMessage) returns (google.protobuf.Empty) {} -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/simulation_setup.proto b/protos/ansys/api/edb/v1/simulation_setup.proto deleted file mode 100644 index 6e8fa33941..0000000000 --- a/protos/ansys/api/edb/v1/simulation_setup.proto +++ /dev/null @@ -1,48 +0,0 @@ -// Proto file representing simulation setup - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "edb_defs.proto"; - -service SimulationSetupService { - rpc Create(SimulationSetupCreationMessage) returns (EDBObjMessage) {} - - rpc GetName (EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetName (StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPosition (EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetPosition (UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSweepData (EDBObjMessage) returns (SweepDataListMessage) {} - rpc SetSweepData (SweepDataListPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetType (EDBObjMessage) returns (SimulationSetupTypeMessage) {} -} - -message SimulationSetupCreationMessage { - EDBObjMessage cell = 1; - string name = 2; - SimulationSetupType type = 3; -} - -message SweepDataMessage { - string name = 1; - string frequency_string = 2; - bool fast_sweep = 3; -} - -message SweepDataListMessage { - repeated SweepDataMessage sweep_data = 1; -} - -message SweepDataListPropertyMessage { - EDBObjMessage target = 1; - SweepDataListMessage sweeps = 2; -} - -message SimulationSetupTypeMessage { - SimulationSetupType type = 1; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/siwave_dcir_simulation_settings.proto b/protos/ansys/api/edb/v1/siwave_dcir_simulation_settings.proto deleted file mode 100644 index 75960fe6f6..0000000000 --- a/protos/ansys/api/edb/v1/siwave_dcir_simulation_settings.proto +++ /dev/null @@ -1,53 +0,0 @@ -// Proto file representing siwave dcir simulation setup settings - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service SIWaveDCIRSimulationSettingsService { - rpc GetIcepakTempFile(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetIcepakTempFile(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSourceTermsToGround(EDBObjMessage) returns (SourceTermsToGroundMessage) {} - rpc SetSourceTermsToGround(SourceTermsToGroundPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetExportDCThermalData(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetExportDCThermalData(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetImportThermalData(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetImportThermalData(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetFullDCReportPath(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetFullDCReportPath(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetViaReportPath(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetViaReportPath(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPerPinResPath(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetPerPinResPath(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDCReportConfigFile(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetDCReportConfigFile(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDCReportShowActiveDevices(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetDCReportShowActiveDevices(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPerPinUsePinFormat(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetPerPinUsePinFormat(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseLoopResForPerPin(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseLoopResForPerPin(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -message SourceTermsToGroundMessage -{ - map source_terms_to_ground = 1; -} - -message SourceTermsToGroundPropertyMessage -{ - SourceTermsToGroundMessage value = 1; - EDBObjMessage target = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/siwave_simulation_settings.proto b/protos/ansys/api/edb/v1/siwave_simulation_settings.proto deleted file mode 100644 index 00bf5b79e4..0000000000 --- a/protos/ansys/api/edb/v1/siwave_simulation_settings.proto +++ /dev/null @@ -1,207 +0,0 @@ -// Proto file representing siwave simulation setup settings - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service SIWaveGeneralSettingsService { - rpc GetUseSISettings(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseSISettings(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetUseCustomSettings(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseCustomSettings(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSISliderPos(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetSISliderPos(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPISliderPos(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetPISliderPos(UInt64PropertyMessage) returns (google.protobuf.Empty) {} -} - -service SIWaveAdvancedSettingsService { - rpc GetIncludeCoPlaneCoupling(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIncludeCoPlaneCoupling(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetIncludeInterPlaneCoupling(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIncludeInterPlaneCoupling(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetIncludeSplitPlaneCoupling(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIncludeSplitPlaneCoupling(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetIncludeFringePlaneCoupling(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIncludeFringePlaneCoupling(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetIncludeTracePlaneCoupling(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIncludeTracePlaneCoupling(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetCrossTalkThreshold(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetCrossTalkThreshold(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaxCoupledLines(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMaxCoupledLines(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinVoidArea(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMinVoidArea(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinPadAreaToMesh(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMinPadAreaToMesh(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinPlaneAreaToMesh(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMinPlaneAreaToMesh(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetSnapLengthThreshold(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetSnapLengthThreshold(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMeshAutomatic(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetMeshAutomatic(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMeshFrequency(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMeshFrequency(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc Get3DReturnCurrentDistribution(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc Set3DReturnCurrentDistribution(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetIncludeVISources(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIncludeVISources(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetIncludeInfGnd(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIncludeInfGnd(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetInfGndLocation(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetInfGndLocation(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPerformERC(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetPerformERC(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetIgnoreNonFunctionalPads(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIgnoreNonFunctionalPads(BoolPropertyMessage) returns (google.protobuf.Empty) {} -} - -service SIWaveDCSettingsService { - rpc GetUseDCCustomSettings(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseDCCustomSettings(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetComputeInductance(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetComputeInductance(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPlotJV(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetPlotJV(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetContactRadius(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetContactRadius(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDCSliderPos(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetDCSliderPos(UInt64PropertyMessage) returns (google.protobuf.Empty) {} -} - -service SIWaveDCAdvancedSettingsService { - rpc GetDCMinPlaneAreaToMesh(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetDCMinPlaneAreaToMesh(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDCMinVoidAreaToMesh(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetDCMinVoidAreaToMesh(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaxInitMeshEdgeLength(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMaxInitMeshEdgeLength(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPerformAdaptiveRefinement(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetPerformAdaptiveRefinement(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaxNumPasses(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMaxNumPasses(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMinNumPasses(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetMinNumPasses(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPercentLocalRefinement(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetPercentLocalRefinement(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetEnergyError(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - rpc SetEnergyError(DoublePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMeshBws(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetMeshBws(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRefineBws(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetRefineBws(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMeshVias(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetMeshVias(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRefineVias(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetRefineVias(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetNumBwSides(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetNumBwSides(UInt64PropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetNumViaSides(EDBObjMessage) returns (google.protobuf.UInt64Value) {} - rpc SetNumViaSides(UInt64PropertyMessage) returns (google.protobuf.Empty) {} -} - -enum SParamInterpolation -{ - POINT_IN = 0; - LINEAR_IN = 1; - STEP_IN = 2; -} - -enum SParamExtrapolation -{ - ZERO_EX = 0; - SAME_EX = 1; - LINEAR_EX = 2; - CONSTANT_EX = 3; -} - -enum SParamDCBehavior -{ - ZERO_DC = 0; - SAME_DC = 1; - LINEAR_DC = 2; - CONSTANT_DC = 3; - ONE_PORT_CAPACITOR_DC = 4; - OPEN_DC = 5; -} - -service SIWaveSParameterSettingsService { - rpc GetUseStateSpace(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetUseStateSpace(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetInterpolation(EDBObjMessage) returns (SParamInterpolationMessage) {} - rpc SetInterpolation(SParamInterpolationPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetExtrapolation(EDBObjMessage) returns (SParamExtrapolationMessage) {} - rpc SetExtrapolation(SParamExtrapolationPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetDCBehavior(EDBObjMessage) returns (SParamDCBehaviorMessage) {} - rpc SetDCBehavior(SParamDCBehaviorPropertyMessage) returns (google.protobuf.Empty) {} -} - -message SParamInterpolationMessage { - SParamInterpolation interpolation = 1; -} - -message SParamInterpolationPropertyMessage { - EDBObjMessage target = 1; - SParamInterpolation interpolation = 2; -} - -message SParamExtrapolationMessage { - SParamExtrapolation extrapolation = 1; -} - -message SParamExtrapolationPropertyMessage { - EDBObjMessage target = 1; - SParamExtrapolation extrapolation = 2; -} - -message SParamDCBehaviorMessage { - SParamDCBehavior dc_behavior = 1; -} - -message SParamDCBehaviorPropertyMessage { - EDBObjMessage target = 1; - SParamDCBehavior dc_behavior = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/solder_ball_property.proto b/protos/ansys/api/edb/v1/solder_ball_property.proto deleted file mode 100644 index 9f2545e671..0000000000 --- a/protos/ansys/api/edb/v1/solder_ball_property.proto +++ /dev/null @@ -1,39 +0,0 @@ -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "padstack_def_data.proto"; - -service SolderBallPropertyService { - rpc Create(google.protobuf.Empty) returns (EDBObjMessage) {} - - rpc GetShape(EDBObjMessage) returns (PadstackDefDataSolderballShapeMessage) {} - rpc SetShape(PadstackDefDataSetSolderballShapeMessage) returns (google.protobuf.Empty) {} - - rpc GetPlacement(EDBObjMessage) returns (PadstackDefDataSolderballPlacementMessage) {} - rpc SetPlacement(PadstackDefDataSetSolderballPlacementMessage) returns (google.protobuf.Empty) {} - - rpc GetDiameter(EDBObjMessage) returns (DiameterMessage) {} - rpc SetDiameter(SetDiameterMessage) returns (google.protobuf.Empty) {} - - rpc GetHeight(EDBObjMessage) returns (ValueMessage) {} - rpc SetHeight(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMaterialName(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetMaterialName(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc UsesSolderball(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - rpc Clone(EDBObjMessage) returns (EDBObjMessage) {} -} - -message DiameterMessage { - ValueMessage diameter1 = 1; - ValueMessage diameter2 = 2; -} - -message SetDiameterMessage { - EDBObjMessage target = 1; - DiameterMessage value = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/sparameter_model.proto b/protos/ansys/api/edb/v1/sparameter_model.proto deleted file mode 100644 index f8ee69f911..0000000000 --- a/protos/ansys/api/edb/v1/sparameter_model.proto +++ /dev/null @@ -1,21 +0,0 @@ -// Proto file representing the SParameterModel class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service SParameterModelService { - rpc Create (SParameterModelMessage) returns (EDBObjMessage) {} - - rpc GetProperties (EDBObjMessage) returns (SParameterModelMessage) {} - - rpc SetComponentModelName (StringPropertyMessage) returns (google.protobuf.Empty) {} - rpc SetReferenceNet (StringPropertyMessage) returns (google.protobuf.Empty) {} -} - -message SParameterModelMessage { - string name = 1; - string ref_net = 2; -} diff --git a/protos/ansys/api/edb/v1/spice_model.proto b/protos/ansys/api/edb/v1/spice_model.proto deleted file mode 100644 index ee0d2f6e12..0000000000 --- a/protos/ansys/api/edb/v1/spice_model.proto +++ /dev/null @@ -1,32 +0,0 @@ -// Proto file representing the SpiceModel class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service SpiceModelService { - rpc Create (SpiceModelMessage) returns (EDBObjMessage) {} - - rpc GetProperties (EDBObjMessage) returns (SpiceModelMessage) {} - - rpc SetModelPath (StringPropertyMessage) returns (google.protobuf.Empty) {} - rpc SetModelName (StringPropertyMessage) returns (google.protobuf.Empty) {} - rpc SetSubCkt (StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc AddTerminalPinPair (SpiceModelNewTerminalPinMessage) returns (google.protobuf.Empty) {} - rpc RemoveTerminalPinPair (StringPropertyMessage) returns (google.protobuf.Empty) {} -} - -message SpiceModelMessage { - string name = 1; - string path = 2; - string sub_ckt = 3; -} - -message SpiceModelNewTerminalPinMessage { - EDBObjMessage target = 1; - string terminal = 2; - string pin = 3; -} diff --git a/protos/ansys/api/edb/v1/stackup_layer.proto b/protos/ansys/api/edb/v1/stackup_layer.proto deleted file mode 100644 index ad1234a7ba..0000000000 --- a/protos/ansys/api/edb/v1/stackup_layer.proto +++ /dev/null @@ -1,172 +0,0 @@ -// Proto file representing the LCSLayer class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "layer.proto"; - -// Stackup layer service definition -service StackupLayerService { - // Creates a stackup layer - rpc Create (StackupLayerCreationMessage) returns (EDBObjMessage) {} - - // Get the negative property of the stackup layer - rpc GetNegative (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Set the negative property of the stackup layer - rpc SetNegative (SetNegativeMessage) returns (google.protobuf.Empty) {} - - // Get the thickness of the layer - rpc GetThickness(EDBObjMessage) returns (ValueMessage) {} - - // Set the thickness of the layer - rpc SetThickness(StackupLayerValueMessage) returns (google.protobuf.Empty) {} - - // Get the lower elevation of the layer - rpc GetLowerElevation(EDBObjMessage) returns (ValueMessage) {} - - // Set the lower elevation of the layer - rpc SetLowerElevation(StackupLayerValueMessage) returns (google.protobuf.Empty) {} - - // Get the upper elevation of the layer - rpc GetUpperElevation(EDBObjMessage) returns (ValueMessage) {} - - // Get the material of the layer - rpc GetMaterial(GetLayerMaterialMessage) returns (google.protobuf.StringValue) {} - - // Set the material of the layer - rpc SetMaterial(SetLayerMaterialMessage) returns (google.protobuf.Empty) {} - - // Get the fill material of the layer - rpc GetFillMaterial(GetLayerMaterialMessage) returns (google.protobuf.StringValue) {} - - // Set the fill material of the layer - rpc SetFillMaterial(SetLayerMaterialMessage) returns (google.protobuf.Empty) {} - - // Enable/Disable surface roughness for the layer - rpc SetRoughnessEnabled(SetLayerPropEnabledMessage) returns (google.protobuf.Empty) {} - - // Check if surface roughness is enabled for the layer - rpc IsRoughnessEnabled(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Get the roughness model of the layer - rpc GetRoughnessModel(LayerRoughnessRegionMessage) returns (RoughnessModelMessage) {} - - // Set the roughness model of the layer - rpc SetRoughnessModel(SetRoughnessModelMessage) returns (google.protobuf.Empty) {} - - // Check if etch factor is enabled for the layer - rpc IsEtchFactorEnabled(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Enable/Disable etch factor for the layer - rpc SetEtchFactorEnabled(SetLayerPropEnabledMessage) returns (google.protobuf.Empty) {} - - // Set the etch factor of the layer - rpc SetEtchFactor(StackupLayerValueMessage) returns (google.protobuf.Empty) {} - - // Get the etch factor of the layer - rpc GetEtchFactor(EDBObjMessage) returns (ValueMessage) {} - - // Check if solver properties are enabled for the layer - rpc GetUseSolverProperties(EDBObjMessage) returns (google.protobuf.BoolValue) {} - - // Enable/Disable solver properties for the layer - rpc SetUseSolverProperties(SetLayerPropEnabledMessage) returns (google.protobuf.Empty) {} - - // Get the HFSS solver-specific properties of the layer - rpc GetHFSSSolverProperties(EDBObjMessage) returns (HFSSSolverPropertiesMessage) {} - - // Set the HFSS solver-specific properties of the layer - rpc SetHFSSSolverProperties(SetHFSSSolverPropertiesMessage) returns (google.protobuf.Empty) {} - - // Retrieves the layer ids of all via layers referencing the layer. - rpc GetReferencingViaLayerIds(EDBObjMessage) returns (ViaLayerIdsMessage) {} -} - -// Message for StackupLayerService::Create -message StackupLayerCreationMessage { - string name = 1; - LayerType type = 2; - ValueMessage thickness = 3; - ValueMessage elevation = 4; - string material = 5; -} - -// Message for StackupLayerService::SetNegative -message SetNegativeMessage { - EDBObjMessage layer = 1; - bool is_negative = 2; -} - -message StackupLayerValueMessage { - EDBObjMessage layer = 1; - ValueMessage value = 2; -} - -message GetLayerMaterialMessage { - EDBObjMessage layer = 1; - bool evaluated = 2; -} - -message SetLayerMaterialMessage { - EDBObjMessage layer = 1; - string material = 2; -} - -message SetLayerPropEnabledMessage { - EDBObjMessage layer = 1; - bool enabled = 2; -} - -message GroisseRoughnessModelMessage { - ValueMessage roughness = 1; -} - -message HurrayRoughnessModelMessage { - ValueMessage nodule_radius = 1; - ValueMessage surface_ratio = 2; -} - -message RoughnessModelMessage { - ValueMessage roughness = 1; - oneof huray_surface_ratio { - ValueMessage surface_ratio = 2; - } -} - -message LayerRoughnessRegionMessage { - EDBObjMessage layer = 1; - enum RoughnessRegion { - TOP = 0; - BOTTOM = 1; - SIDE = 2; - } - RoughnessRegion roughness_region = 2; -} - -message SetRoughnessModelMessage { - LayerRoughnessRegionMessage layer_rough_region = 1; - RoughnessModelMessage roughness_model = 2; -} - -message HFSSSolverPropertiesMessage { - enum DCThicknessType { - EFFECTIVE = 0; - LAYER = 1; - MANUAL = 2; - } - bool solve_inside = 1; - DCThicknessType dc_thickness_type = 2; - ValueMessage dc_thickness = 3; -} - -message SetHFSSSolverPropertiesMessage { - EDBObjMessage layer = 1; - HFSSSolverPropertiesMessage hfss_solver_props = 2; -} - -message ViaLayerIdsMessage { - repeated int64 ref_layer_ids = 1; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/structure3d.proto b/protos/ansys/api/edb/v1/structure3d.proto deleted file mode 100644 index 47570f47d2..0000000000 --- a/protos/ansys/api/edb/v1/structure3d.proto +++ /dev/null @@ -1,55 +0,0 @@ -// Proto file representing the EDB Structure3D class - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "hierarchy_obj.proto"; - - -enum Closure { - OPEN_ENDED = 0; - ENDS_CLOSED = 1; - FILLED_CLOSED = 2; - UNDEFINED_CLOSURE = -1; -} - -// Structure3D service definition -service Structure3DService { - // Create a structure3D - rpc Create(ObjectNameInLayoutMessage) returns (EDBObjMessage) {} - - // Get material - rpc GetMaterial(BoolPropertyMessage) returns (google.protobuf.StringValue) {} - - // Set material - rpc SetMaterial(StringPropertyMessage) returns (google.protobuf.Empty) {} - - // Get thickness - rpc GetThickness(EDBObjMessage) returns (ValueMessage) {} - - // Set thickness - rpc SetThickness(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - // Get mesh closure property - rpc GetMeshClosureProp(EDBObjMessage) returns (ClosureMessage) {} - - // Set mesh closure property - rpc SetMeshClosureProp(SetClosureMessage) returns (google.protobuf.Empty) {} -} - - -message ClosureMessage { - Closure closure_type = 1; -} - -message SetClosureMessage { - EDBObjMessage target = 1; - ClosureMessage closure_type = 2; -} - - - diff --git a/protos/ansys/api/edb/v1/term.proto b/protos/ansys/api/edb/v1/term.proto deleted file mode 100644 index 10b63d2aee..0000000000 --- a/protos/ansys/api/edb/v1/term.proto +++ /dev/null @@ -1,138 +0,0 @@ -// Proto file representing the EDB Term class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "edb_defs.proto"; -import "refs.proto"; -import "rlc.proto"; -import "port_post_processing_prop.proto"; - -enum TerminalType { - EDGE_TERM = 0; - POINT_TERM = 1; - TERM_INST_TERM = 2; - PADSTACK_INST_TERM = 3; - BUNDLE_TERM = 4; - PIN_GROUP_TERM = 5; -} - -enum TerminalBoundaryType { - PORT_BOUNDARY = 0; - PEC_BOUNDARY = 1; - RLC_BOUNDARY = 2; - CURRENT_SOURCE = 3; - VOLTAGE_SOURCE = 4; - NEXXIM_GROUND = 5; - NEXXIM_PORT = 6; - DC_TERMINAL = 7; - VOLTAGE_PROBE = 8; - INVALID_BOUNDARY = -1; -} - -enum SourceTermToGroundType { - NO_GROUND = 0; - NEGATIVE = 1; - POSITIVE = 2; -} - -enum HfssPIType { - PI_DEFAULT = 0; - PI_COAXIAL_OPEN = 1; - PI_COAXIAL_SHORTENED = 2; - PI_GAP = 3; - PI_LUMPED = 4; - PI_INVALID = -1; -} - -service TerminalService { - rpc FindByName (TermFindByNameMessage) returns (EDBObjMessage) {} - - rpc GetParams (EDBObjMessage) returns (TermParamsMessage) {} - - rpc SetParams (TermSetParamsMessage) returns (google.protobuf.Empty) {} - - rpc GetProductSolvers (TermGetProductSolversMessage) returns (TermProductSolversMessage) {} - - rpc SetProductSolverOptions (TermSetSolverOptionMessage) returns (google.protobuf.Empty) {} -} - -message TermParamsMessage { - TerminalType term_type = 1; - TerminalBoundaryType boundary_type = 2; - SourceTermToGroundType term_to_ground = 3; - HfssPIType hfss_pi_type = 4; - EDBObjMessage ref_term = 5; - EDBObjMessage ref_layer = 6; - EDBObjMessage bundle_term = 7; - bool is_interface = 8; - bool is_reference = 9; - bool is_auto_port = 10; - bool is_circuit_port = 11; - bool use_ref_from_hierarchy = 12; - string name = 13; - ValueMessage impedance = 14; - ValueMessage source_amplitude = 15; - ValueMessage source_phase = 16; - string s_param_model = 17; - RlcMessage rlc = 18; - PortPostProcessingPropMessage port_post_processing_prop = 19; -} - -message TermSetParamsMessage { - EDBObjMessage term = 1; - oneof optional_boundary_type { TerminalBoundaryType boundary_type = 2; } - oneof optional_term_to_ground { SourceTermToGroundType term_to_ground = 3; } - oneof optional_hfss_pi_type { HfssPIType hfss_pi_type = 4; } - TermSetRefMessage ref = 5; - oneof optional_is_auto_port { google.protobuf.BoolValue is_auto_port = 6; } - oneof optional_is_circuit_port { google.protobuf.BoolValue is_circuit_port = 7; } - oneof optional_use_ref_from_hierarchy { google.protobuf.BoolValue use_ref_from_hierarchy = 8; } - google.protobuf.StringValue name = 9; - ValueMessage impedance = 10; - ValueMessage source_amplitude = 11; - ValueMessage source_phase = 12; - google.protobuf.StringValue s_param_model = 13; - RlcMessage rlc = 14; - PortPostProcessingPropMessage port_post_processing_prop = 15; -} - -message TermSetRefMessage { - oneof ref { - EDBObjMessage ref_term = 1; - TermSetLayerMessage ref_layer = 2; - } -} - -message TermSetLayerMessage { - LayerRefMessage layer = 1; - repeated google.protobuf.StringValue contexts = 2; -} - -message TermFindByNameMessage { - EDBObjMessage layout = 1; - string name = 2; -} - -message TermGetProductSolversMessage { - EDBObjMessage term = 1; - ProductIdType product_id = 2; -} - -message TermProductSolverMessage { - string name = 1; - string option = 2; -} - -message TermProductSolversMessage { - repeated TermProductSolverMessage solvers = 1; -} - -message TermSetSolverOptionMessage { - EDBObjMessage term = 1; - ProductIdType product_id = 2; - string name = 3; - string option = 4; -} diff --git a/protos/ansys/api/edb/v1/term_inst.proto b/protos/ansys/api/edb/v1/term_inst.proto deleted file mode 100644 index 264c31400f..0000000000 --- a/protos/ansys/api/edb/v1/term_inst.proto +++ /dev/null @@ -1,25 +0,0 @@ -// Proto file representing the EDB Term instance class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; - -service TerminalInstanceService { - rpc Create (TermInstCreationMessage) returns (EDBObjMessage) {} - - rpc GetOwningCellInstance (EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetDefinitionTerminal (EDBObjMessage) returns (EDBObjMessage) {} - - rpc GetDefinitionTerminalName (EDBObjMessage) returns (google.protobuf.StringValue) {} -} - -message TermInstCreationMessage { - EDBObjMessage layout = 1; - NetRefMessage net = 2; - EDBObjMessage cell_inst = 3; - string name = 4; -} diff --git a/protos/ansys/api/edb/v1/term_inst_term.proto b/protos/ansys/api/edb/v1/term_inst_term.proto deleted file mode 100644 index d5edcbed98..0000000000 --- a/protos/ansys/api/edb/v1/term_inst_term.proto +++ /dev/null @@ -1,27 +0,0 @@ -// Proto file representing the EDB TermInstTerm class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; - -service TerminalInstanceTerminalService { - rpc Create (TermInstTermCreationMessage) returns (EDBObjMessage) {} - rpc GetTerminalInstance (EDBObjMessage) returns (EDBObjMessage) {} - rpc SetTerminalInstance (TermInstTermSetInstanceMessage) returns (google.protobuf.Empty) {} -} - -message TermInstTermCreationMessage { - EDBObjMessage layout = 1; - NetRefMessage net = 2; - string name = 3; - EDBObjMessage term_inst = 4; - bool is_ref = 5; -} - -message TermInstTermSetInstanceMessage { - EDBObjMessage term = 1; - EDBObjMessage term_inst = 2; -} diff --git a/protos/ansys/api/edb/v1/text.proto b/protos/ansys/api/edb/v1/text.proto deleted file mode 100644 index afa97b2f57..0000000000 --- a/protos/ansys/api/edb/v1/text.proto +++ /dev/null @@ -1,42 +0,0 @@ -// Proto file representing the EDB Text class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "refs.proto"; - -// Text service definition -service TextService { - // Create a text - rpc Create (TextCreationMessage) returns (EDBObjMessage) {} - - // Get text values - rpc GetTextData (EDBObjMessage) returns (TextDataMessage) {} - - // Set text values - rpc SetTextData (SetTextDataMessage) returns (google.protobuf.Empty) {} -} - -// Message for Create -message TextCreationMessage { - EDBObjMessage layout = 1; - LayerRefMessage layer = 2; - ValueMessage center_x = 3; - ValueMessage center_y = 4; - string text = 5; -} - -// Message for Get Data -message TextDataMessage { - ValueMessage center_x = 1; - ValueMessage center_y = 2; - string text = 3; -} - -// Message for Set Data -message SetTextDataMessage { - EDBObjMessage target = 1; - TextDataMessage data = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/transform.proto b/protos/ansys/api/edb/v1/transform.proto deleted file mode 100644 index 7f30642ca0..0000000000 --- a/protos/ansys/api/edb/v1/transform.proto +++ /dev/null @@ -1,55 +0,0 @@ -// Proto file for Transforms - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "point_data.proto"; -import "polygon_data.proto"; - -service TransformService { - rpc Rotate (PointDataRotateMessage) returns (PointMessage) {} - rpc Create (TransformMessage) returns (EDBObjMessage) {} - - rpc GetScale (EDBObjMessage) returns (ValueMessage) {} - rpc SetScale (ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetMirror (EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetMirror (BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetRotation (EDBObjMessage) returns (ValueMessage) {} - rpc SetRotation (ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetOffsetX (EDBObjMessage) returns (ValueMessage) {} - rpc SetOffsetX (ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetOffsetY (EDBObjMessage) returns (ValueMessage) {} - rpc SetOffsetY (ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc TransformPlus (TransformOperatorMessage) returns (EDBObjMessage) {} - rpc IsIdentity (EDBObjMessage) returns (google.protobuf.BoolValue) {} - - rpc TransformPoint (PointPropertyMessage) returns (PointMessage) {} - rpc TransformPolygon (PolygonDataPropertyMessage) returns (PolygonDataMessage) {} -} - -message TransformMessage { - ValueMessage scale = 1; - ValueMessage angle = 2; - bool mirror = 3; - ValueMessage offset_x = 4; - ValueMessage offset_y = 5; -} - -message TransformPropertyMessage { - EDBObjMessage target = 1; - TransformMessage transf = 2; -} - -message TransformOperatorMessage { - EDBObjMessage target_1 = 1; - EDBObjMessage target_2 = 2; -} \ No newline at end of file diff --git a/protos/ansys/api/edb/v1/transform3d.proto b/protos/ansys/api/edb/v1/transform3d.proto deleted file mode 100644 index 1db1a8aa04..0000000000 --- a/protos/ansys/api/edb/v1/transform3d.proto +++ /dev/null @@ -1,58 +0,0 @@ -// Proto file for 3D Transforms - -syntax = "proto3"; - -// Package -package ansys.api.edb.v1; - -// Imports -import "edb_messages.proto"; -import "point_3d_data.proto"; - -service Transform3DService { - rpc CreateIdentity (google.protobuf.Empty) returns (EDBObjMessage) {} - - rpc CreateCopy (EDBObjMessage) returns (EDBObjMessage) {} - rpc CreateOffset (CPos3DMessage) returns (EDBObjMessage) {} - - rpc CreateCenterScale (CPos3DDoubleMessage) returns (EDBObjMessage) {} - rpc CreateRotationFromAngle (CPos3DMessage) returns (EDBObjMessage) {} - - rpc CreateRotationFromAxis (CPos3DTripleMessage) returns (EDBObjMessage) {} - rpc CreateRotationFromAxisAndAngle (CPos3DDoubleMessage) returns (EDBObjMessage) {} - - rpc CreateRotationFromToAxis (CPos3DPairMessage) returns (EDBObjMessage) {} - rpc CreateTransform2D (DoublePropertyMessage) returns (EDBObjMessage) {} - - rpc OperatorPlus (PointerPropertyMessage) returns (EDBObjMessage) {} - - rpc TransformPoint (CPos3DPropertyMessage) returns (CPos3DMessage) {} - - rpc GetZYXRotation (EDBObjMessage) returns (CPos3DMessage) {} - rpc GetAxis (EDBObjMessage) returns (CPos3DTripleMessage) {} - - rpc Transpose (EDBObjMessage) returns (google.protobuf.Empty) {} - rpc Invert (EDBObjMessage) returns (google.protobuf.Empty) {} - - rpc IsIdentity (IsIdentityMessage) returns (google.protobuf.BoolValue) {} - rpc IsEqual (IsEqualMessage) returns (google.protobuf.BoolValue) {} - - rpc GetScaling (EDBObjMessage) returns (CPos3DMessage) {} - rpc GetShift (EDBObjMessage) returns (CPos3DMessage) {} - - rpc SetMatrix (DoublesPropertyMessage) returns (google.protobuf.Empty) {} - rpc GetMatrix (EDBObjMessage) returns (DoublesMessage) {} -} - -message IsIdentityMessage { - EDBObjMessage target = 1; - double eps = 2; - bool rotation = 3; -} - -message IsEqualMessage { - EDBObjMessage target = 1; - EDBObjMessage value = 2; - double eps = 3; - bool rotation = 4; -} diff --git a/protos/ansys/api/edb/v1/value.proto b/protos/ansys/api/edb/v1/value.proto deleted file mode 100644 index c3e7cf7a1e..0000000000 --- a/protos/ansys/api/edb/v1/value.proto +++ /dev/null @@ -1,21 +0,0 @@ -// Proto file representing the EDB Value class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service ValueService { - - rpc CreateValue (ValueTextMessage) returns (ValueMessage) {} - - rpc GetDouble (ValueTextMessage) returns (google.protobuf.DoubleValue) {} - - rpc GetComplex (ValueTextMessage) returns (ComplexMessage) {} -} - -message ValueTextMessage { - string text = 1; - EDBObjMessage variable_owner = 2; -} diff --git a/protos/ansys/api/edb/v1/variable_server.proto b/protos/ansys/api/edb/v1/variable_server.proto deleted file mode 100644 index 7ea405749f..0000000000 --- a/protos/ansys/api/edb/v1/variable_server.proto +++ /dev/null @@ -1,63 +0,0 @@ -// Proto file representing the EDB VariableServer class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service VariableServerService { - rpc AddVariable (AddVariableMessage) returns (google.protobuf.Empty) {} - - rpc AddMenuVariable (AddMenuVariableMessage) returns (google.protobuf.Empty) {} - - rpc DeleteVariable (VariableNameMessage) returns (google.protobuf.Empty) {} - - rpc SetVariableValue (SetVariableMessage) returns (google.protobuf.Empty) {} - - rpc GetVariableValue (VariableNameMessage) returns (ValueMessage) {} - - rpc IsParameter (VariableNameMessage) returns (google.protobuf.BoolValue) {} - - rpc GetAllVariableNames (EDBObjMessage) returns (GetVariableNamesMessage) {} - - rpc GetVariableDesc (VariableNameMessage) returns (google.protobuf.StringValue) {} - - rpc SetVariableDesc (SetDescriptionMessage) returns (google.protobuf.Empty) {} -} - -message AddVariableMessage { - EDBObjMessage variable_owner = 1; - string name = 2; - ValueMessage value = 3; - bool isparam = 4; -} - -message AddMenuVariableMessage { - EDBObjMessage variable_owner = 1; - string name = 2; - uint64 index = 3; - repeated ValueMessage values = 4; - bool isparam = 5; -} - -message VariableNameMessage { - EDBObjMessage variable_owner = 1; - string name = 2; -} - -message SetVariableMessage { - EDBObjMessage variable_owner = 1; - string name = 2; - ValueMessage value = 3; -} - -message SetDescriptionMessage { - EDBObjMessage variable_owner = 1; - string name = 2; - string desc = 3; -} - -message GetVariableNamesMessage { - repeated string names = 2; -} diff --git a/protos/ansys/api/edb/v1/via_group.proto b/protos/ansys/api/edb/v1/via_group.proto deleted file mode 100644 index c6ff64d02e..0000000000 --- a/protos/ansys/api/edb/v1/via_group.proto +++ /dev/null @@ -1,45 +0,0 @@ -// Proto file representing the EDB ViaGroup class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; -import "polygon_data.proto"; -import "refs.proto"; -import "hierarchy_obj.proto"; - -// ViaGroup service definition -service ViaGroupService { - // Creates ViaGroups - rpc CreateWithPrimitives(ViaGroupCreateWithPrimitivesMessage) returns (EDBObjCollectionMessage) {} - - // Creates a ViaGroup with outline - rpc CreateWithOutline(ViaGroupCreateWithOutlineMessage) returns (EDBObjMessage) {} - - // Find the ViaGroup by name in the given layout - rpc FindByName(ObjectNameInLayoutMessage) returns (EDBObjMessage) {} - - // Get the ViaGroup outline - rpc GetOutline(EDBObjMessage) returns (PolygonDataMessage) {} - - // Get conductor percentage of the ViaGroup - rpc GetConductorPercentage(EDBObjMessage) returns (google.protobuf.DoubleValue) {} - - // Check if the ViaGroup is persistent - rpc IsPersistent(EDBObjMessage) returns (google.protobuf.BoolValue) {} -} - -message ViaGroupCreateWithPrimitivesMessage { - EDBObjMessage layout = 1; - EDBObjCollectionMessage primitives = 2; - bool is_persistent = 3; -} - -message ViaGroupCreateWithOutlineMessage { - EDBObjMessage layout = 1; - PolygonDataMessage points = 2; - double conductivity_ratio = 3; - LayerRefMessage layer = 4; - NetRefMessage net = 5; -} diff --git a/protos/ansys/api/edb/v1/via_layer.proto b/protos/ansys/api/edb/v1/via_layer.proto deleted file mode 100644 index c176800d73..0000000000 --- a/protos/ansys/api/edb/v1/via_layer.proto +++ /dev/null @@ -1,37 +0,0 @@ -// Proto file representing the via layers - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -// Via layer service definition -service ViaLayerService { - // Creates a via layer - rpc Create (ViaLayerCreationMessage) returns (EDBObjMessage) {} - - // Get the name of the upper or lower reference layer of the via layer. - rpc GetRefLayerName (ViaLayerRefLayerIdMessage) returns (google.protobuf.StringValue) {} - - // Sets the upper or lower reference layer of the via layer - rpc SetRefLayer (SetViaLayerRefLayerMessage) returns (google.protobuf.Empty) {} -} - -// Message for ViaLayerService::Create -message ViaLayerCreationMessage { - string via_layer_name = 1; - string lower_ref_layer_name = 2; - string upper_ref_layer_name = 3; - string material_name = 4; -} - -message ViaLayerRefLayerIdMessage { - EDBObjMessage via_layer = 1; - bool is_upper_ref = 2; -} - -message SetViaLayerRefLayerMessage { - ViaLayerRefLayerIdMessage via_layer_ref_layer_id = 1; - EDBObjMessage new_ref_layer = 2; -} diff --git a/protos/ansys/api/edb/v1/voltage_regulator.proto b/protos/ansys/api/edb/v1/voltage_regulator.proto deleted file mode 100644 index 461ba90bd1..0000000000 --- a/protos/ansys/api/edb/v1/voltage_regulator.proto +++ /dev/null @@ -1,78 +0,0 @@ -// Proto file representing the EDB Circle class - -syntax = "proto3"; - -package ansys.api.edb.v1; - -import "edb_messages.proto"; - -service VoltageRegulatorService { - rpc Create (VoltageRegulatorMessage) returns (EDBObjMessage) {} - - rpc GetName(EDBObjMessage) returns (google.protobuf.StringValue) {} - rpc SetName(EDBObjNameMessage) returns (google.protobuf.Empty) {} - - rpc IsActive(EDBObjMessage) returns (google.protobuf.BoolValue) {} - rpc SetIsActive(BoolPropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetVoltage(EDBObjMessage) returns (ValueMessage) {} - rpc SetVoltage(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetLoadRegulationCurrent(EDBObjMessage) returns (ValueMessage) {} - rpc SetLoadRegulationCurrent(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetLoadRegulationPercent(EDBObjMessage) returns (ValueMessage) {} - rpc SetLoadRegulationPercent(ValuePropertyMessage) returns (google.protobuf.Empty) {} - - rpc GetPosRemoteSensePin(EDBObjMessage) returns (EDBObjMessage) {} - rpc SetPosRemoteSensePin(EDBObjCollectionMessage) returns (google.protobuf.Empty) {} - - rpc GetNegRemoteSensePin(EDBObjMessage) returns (EDBObjMessage) {} - rpc SetNegRemoteSensePin(EDBObjCollectionMessage) returns (google.protobuf.Empty) {} - - rpc GetNPowerModules(EDBObjMessage) returns (google.protobuf.Int64Value){} - rpc GetNActivePowerModules(EDBObjMessage) returns (google.protobuf.Int64Value) {} - - rpc GetPowerModule(StringPropertyMessage) returns (PowerModuleMessage) {} - rpc GetAllPowerModules(EDBObjMessage) returns (PowerModulesMessage) {} - - rpc AddPowerModule(PowerModulePropertyMessage) returns (google.protobuf.Empty) {} - rpc RemovePowerModule(StringPropertyMessage) returns (google.protobuf.Empty) {} - - rpc AddPowerModules(PowerModulesPropertyMessage) returns (google.protobuf.Empty) {} - rpc RemovePowerModules(StringsPropertyMessage) returns (google.protobuf.Empty) {} - rpc RemoveAllPowerModules(EDBObjMessage) returns (google.protobuf.Empty) {} -} - -message VoltageRegulatorMessage { - EDBObjMessage layout = 1; - string name = 2; - bool active = 3; - ValueMessage voltage = 4; - ValueMessage lrc = 5; - ValueMessage lrp = 6; -} - -message PowerModuleMessage { - string comp_group_name = 1; - string pos_output_terminal = 2; - string neg_output_terminal = 3; - ValueMessage relative_strength = 4; - bool active = 5; - bool needs_sync = 6; -} - -message PowerModulesMessage { - repeated PowerModuleMessage data = 1; -} - -message PowerModulePropertyMessage { - EDBObjMessage vrm = 1; - PowerModuleMessage module = 2; -} - -message PowerModulesPropertyMessage { - EDBObjMessage vrm = 1; - PowerModulesMessage modules = 2; -} - diff --git a/protos/requirements/requirements_build.txt b/protos/requirements/requirements_build.txt deleted file mode 100644 index 9bf89644a2..0000000000 --- a/protos/requirements/requirements_build.txt +++ /dev/null @@ -1,5 +0,0 @@ -grpcio>=1.44.0,<1.48.0 -grpcio-tools>=1.44.0,<1.48.0 -protobuf>=3.20,<4 -wheel - diff --git a/protos/setup.py b/protos/setup.py deleted file mode 100644 index 3c0de80f84..0000000000 --- a/protos/setup.py +++ /dev/null @@ -1,97 +0,0 @@ -"""Installation file for the ansys-api-edb-v1 package""" - -import glob -import os -import re - -from setuptools import setup -from setuptools.command.develop import develop - -install_requires = ["grpcio>=1.44.0,<1.48.0", "grpcio-tools>=1.44.0,<1.48.0", "protobuf>=3.20,<4"] - -# Get the long description from the README file -HERE = os.path.abspath(os.path.dirname(__file__)) -with open(os.path.join(HERE, "README.rst"), encoding="utf-8") as fd: - long_description = fd.read() - -desc = "python gRPC interface package for ansys-api-edb-v1" - - -def compile_proto(): - """Compile proto files.""" - package_name = "ansys.api.edb.v1" - proto_dir = os.path.join(os.getcwd(), *package_name.split(".")) - proto_files = os.path.join(proto_dir, "*.proto") - out_dir = proto_dir - - # import grpc_tools - - cmds = [ - "python", - "-m grpc_tools.protoc", - f"-I {proto_dir}", - f"--python_out={out_dir}", - f"--grpc_python_out={out_dir}", - proto_files, - ] - cmd = " ".join(cmds) - os.system(cmd) - - replace_imports(package_name) - - -def replace_imports(package_name): - """Replace relative imports from auto-generated pb2 files with absolute imports.""" - root = os.path.join(os.getcwd(), *package_name.split(".")) - files_path = os.path.join(root, "*.py") - files = glob.glob(files_path, recursive=True) - source = {} - for filename in files: - relative_path = filename.replace(root, "") - module_name = ".".join(re.split(r"\\|/", relative_path)) - module_name = module_name.rstrip(".py") - module_name = module_name.strip(".") - source[module_name] = open(filename).read() - - packages = set() - for module_name in source: - find_str = "import %s" % module_name - repl_str = "import %s.%s" % (package_name, module_name) - packages.add(package_name) - - for mod_name, mod_source in source.items(): - source[mod_name] = mod_source.replace(find_str, repl_str) - - for module_name, module_source in source.items(): - relative_module_path = module_name.split(".") - relative_module_path[-1] = "%s.py" % relative_module_path[-1] - filename = os.path.join(root, *relative_module_path) - - with open(filename, "w") as f: - f.write(module_source) - - -class CustomDevelopCommand(develop): - """Custom command that also compiles proto files on editable mode.""" - - def run(self): - """Compile proto files before proceeding.""" - compile_proto() - develop.run(self) - - -setup( - name="ansys-api-edb-v1", - packages=["ansys.api.edb.v1"], - version="0.0.0", - license="MIT", - url="https://github.com/ansys/", - author="Ansys Inc.", - author_email="support@ansys.com", - description=desc, - long_description=long_description, - long_description_content_type="text/markdown", - python_requires=">=3.5", - install_requires=install_requires, - cmdclass={"develop": CustomDevelopCommand}, -) diff --git a/pyproject.toml b/pyproject.toml index d1c1c6b142..0baa525d28 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,40 +1,66 @@ [build-system] -requires = ["flit_core >=3.2,<4", "grpcio-tools>=1.39.0"] +requires = ["flit_core >=3.2,<4"] build-backend = "flit_core.buildapi" [project] # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections -name = "ansys-edb" +name = "ansys-edb-core" version = "0.1" -description = "Ansys electronics database python client" +description = "A python wrapper for Ansys Edb service" readme = "README.rst" -requires-python = ">=3.7" +requires-python = ">=3.8" license = {file = "LICENSE"} -authors = [ - {name = "ANSYS, Inc.", email = "pyansys.support@ansys.com"}, -] -maintainers = [ - {name = "PyAnsys developers", email = "pyansys.maintainers@ansys.com"}, -] - +authors = [{name = "ANSYS, Inc.", email = "pyansys.support@ansys.com"}] +maintainers = [{name = "PyAnsys developers", email = "pyansys.maintainers@ansys.com"}] classifiers = [ "Development Status :: 4 - Beta", - "Programming Language :: Python :: 3", + "Intended Audience :: Science/Research", + "Topic :: Scientific/Engineering :: Information Analysis", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", + "Programming Language :: Python :: 3.9", ] + + +# FIXME: add ansys-api-edb version dependencies = [ - "importlib-metadata >=4.0", - "protobuf>=3.20,<4", + "ansys-api-edb", + "protobuf>=3.19.3,<4", "grpcio>=1.44.0" ] -[tool.flit.module] -name = "ansys.edb" +# FIXME: add versions +[project.optional-dependencies] +notebook = [ + "notebook", + "matplotlib", + "ipynbname" +] + +# FIXME: update to newer versions +tests = [ + "pytest==7.4.3", + "pytest-cov==4.1.0", + "pytest-mock==3.11.1", + "python-dotenv>=0.20.0", + "tox", +] + +# FIXME: update to newer versions +doc = [ + "sphinx==7.1.2", + "numpydoc==1.6.0", + "ansys_sphinx_theme>=0.12.2", + "sphinx-copybutton==0.5.2", +] [project.urls] Source = "https://github.com/ansys/pyedb" + +[tool.flit.module] +name = "ansys.edb.core" + [tool.black] line-length = 100 diff --git a/requirements/requirements_build.txt b/requirements/requirements_build.txt deleted file mode 100644 index 473ebb1f60..0000000000 --- a/requirements/requirements_build.txt +++ /dev/null @@ -1,3 +0,0 @@ -build>=0.7.0 -twine>=3.8 -wheel \ No newline at end of file diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt deleted file mode 100644 index b43a379af6..0000000000 --- a/requirements/requirements_doc.txt +++ /dev/null @@ -1,4 +0,0 @@ -Sphinx>=4.4 -numpydoc>=1.2 -ansys_sphinx_theme>=0.8 -Sphinx-copybutton>=0.4 \ No newline at end of file diff --git a/requirements/requirements_notebook.txt b/requirements/requirements_notebook.txt deleted file mode 100644 index 04838338bb..0000000000 --- a/requirements/requirements_notebook.txt +++ /dev/null @@ -1,3 +0,0 @@ -notebook -matplotlib -ipynbname diff --git a/requirements/requirements_tests.txt b/requirements/requirements_tests.txt deleted file mode 100644 index 360b6154ec..0000000000 --- a/requirements/requirements_tests.txt +++ /dev/null @@ -1,4 +0,0 @@ -pytest>=7.1.0 -pytest-cov>=3.0.0 -pytest-mock>=3.7.0 -python-dotenv>=0.20.0 diff --git a/requirements/requirements_tox.txt b/requirements/requirements_tox.txt deleted file mode 100644 index 0695f72640..0000000000 --- a/requirements/requirements_tox.txt +++ /dev/null @@ -1,3 +0,0 @@ -pip -flit -tox \ No newline at end of file diff --git a/src/ansys/edb/__init__.py b/src/ansys/edb/__init__.py deleted file mode 100644 index 5408bead52..0000000000 --- a/src/ansys/edb/__init__.py +++ /dev/null @@ -1,8 +0,0 @@ -"""Ansys Electronics Database Python Package.""" - -try: - import importlib.metadata as importlib_metadata -except ModuleNotFoundError: - import importlib_metadata - -__version__ = importlib_metadata.version(__name__.replace(".", "-")) diff --git a/src/ansys/edb/core/__init__.py b/src/ansys/edb/core/__init__.py index 56031bb0d6..b02d9f3ae1 100644 --- a/src/ansys/edb/core/__init__.py +++ b/src/ansys/edb/core/__init__.py @@ -1,8 +1,8 @@ -"""This package contains code unavailable to API users.""" +"""Ansys Electronics Database Python Package.""" -import logging +try: + import importlib.metadata as importlib_metadata +except ModuleNotFoundError: + import importlib_metadata -from ansys.edb.core.base import ObjBase, TypeField -from ansys.edb.core.edb_logging import EDBLogger - -LOGGER = EDBLogger(level=logging.DEBUG, to_file=False, to_stdout=True) +__version__ = importlib_metadata.version("ansys-edb-core") diff --git a/src/ansys/edb/database.py b/src/ansys/edb/core/database.py similarity index 91% rename from src/ansys/edb/database.py rename to src/ansys/edb/core/database.py index e932827449..4e71b7e954 100644 --- a/src/ansys/edb/database.py +++ b/src/ansys/edb/core/database.py @@ -6,18 +6,7 @@ import ansys.api.edb.v1.edb_defs_pb2 as edb_defs_pb2 import google.protobuf.wrappers_pb2 as proto_wrappers -from ansys.edb.core import ObjBase, variable_server -from ansys.edb.core.messages import ( - double_property_message, - edb_obj_collection_message, - edb_obj_name_message, - get_product_property_ids_message, - get_product_property_message, - set_product_property_message, - str_message, -) -from ansys.edb.core.utils import map_list -from ansys.edb.definition import ( +from ansys.edb.core.definition import ( ApdBondwireDef, BondwireDefType, ComponentDef, @@ -28,9 +17,20 @@ PackageDef, PadstackDef, ) -from ansys.edb.edb_defs import DefinitionObjType -from ansys.edb.layout import Cell -from ansys.edb.session import DatabaseServiceStub, StubAccessor, StubType +from ansys.edb.core.edb_defs import DefinitionObjType +from ansys.edb.core.inner import ObjBase, variable_server +from ansys.edb.core.inner.messages import ( + double_property_message, + edb_obj_collection_message, + edb_obj_name_message, + get_product_property_ids_message, + get_product_property_message, + set_product_property_message, + str_message, +) +from ansys.edb.core.inner.utils import map_list +from ansys.edb.core.layout import Cell +from ansys.edb.core.session import DatabaseServiceStub, StubAccessor, StubType class ProductIdType(Enum): @@ -142,7 +142,7 @@ def top_circuit_cells(self): Returns ------- - list[:class:`Cell `] + list[:class:`Cell `] """ return Database._map_cell_edb_obj_collection(self.__stub.GetTopCircuits(self.msg)) @@ -152,7 +152,7 @@ def circuit_cells(self): Returns ------- - list[:class:`Cell `] + list[:class:`Cell `] """ return Database._map_cell_edb_obj_collection(self.__stub.GetCircuits(self.msg)) @@ -162,7 +162,7 @@ def footprint_cells(self): Returns ------- - list[:class:`Cell `] + list[:class:`Cell `] """ return Database._map_cell_edb_obj_collection(self.__stub.GetFootprints(self.msg)) @@ -383,12 +383,12 @@ def copy_cells(self, cells_to_copy): Parameters ---------- - cells_to_copy : list[:class:`Cell `] + cells_to_copy : list[:class:`Cell `] Cells to copy. Returns ------- - list[:class:`Cell `] + list[:class:`Cell `] New Cells created in this Database. """ return Database._map_cell_edb_obj_collection( @@ -422,7 +422,7 @@ def apd_bondwire_defs(self): Returns ------- - list[:class:`ApdBondwireDef `] + list[:class:`ApdBondwireDef `] """ return self._get_bondwire_definition_objs(ApdBondwireDef, BondwireDefType.APD_BONDWIRE_DEF) @@ -432,7 +432,7 @@ def jedec4_bondwire_defs(self): Returns ------- - list[:class:`Jedec4BondwireDef `] + list[:class:`Jedec4BondwireDef `] """ return self._get_bondwire_definition_objs( Jedec4BondwireDef, BondwireDefType.JEDEC4_BONDWIRE_DEF @@ -444,7 +444,7 @@ def jedec5_bondwire_defs(self): Returns ------- - list[:class:`Jedec5BondwireDef `] + list[:class:`Jedec5BondwireDef `] """ return self._get_bondwire_definition_objs( Jedec5BondwireDef, BondwireDefType.JEDEC5_BONDWIRE_DEF @@ -456,7 +456,7 @@ def padstack_defs(self): Returns ------- - list[:class:`PadstackDef `] + list[:class:`PadstackDef `] """ return self._get_definition_objs(PadstackDef, DefinitionObjType.PADSTACK_DEF) @@ -466,7 +466,7 @@ def package_defs(self): Returns ------- - list[:class:`PackageDef `] + list[:class:`PackageDef `] """ return self._get_definition_objs(PackageDef, DefinitionObjType.PACKAGE_DEF) @@ -476,7 +476,7 @@ def component_defs(self): Returns ------- - list[:class:`ComponentDef `] + list[:class:`ComponentDef `] """ return self._get_definition_objs(ComponentDef, DefinitionObjType.COMPONENT_DEF) @@ -486,7 +486,7 @@ def material_defs(self): Returns ------- - list[:class:`MaterialDef `] + list[:class:`MaterialDef `] """ return self._get_definition_objs(MaterialDef, DefinitionObjType.MATERIAL_DEF) @@ -496,6 +496,6 @@ def dataset_defs(self): Returns ------- - list[:class:`DatasetDef `] + list[:class:`DatasetDef `] """ return self._get_definition_objs(DatasetDef, DefinitionObjType.DATASET_DEF) diff --git a/src/ansys/edb/core/definition/__init__.py b/src/ansys/edb/core/definition/__init__.py new file mode 100644 index 0000000000..c5bd269e0a --- /dev/null +++ b/src/ansys/edb/core/definition/__init__.py @@ -0,0 +1,46 @@ +"""Import definition classes.""" + +from ansys.edb.core.definition.bondwire_def import ( + ApdBondwireDef, + BondwireDef, + BondwireDefType, + Jedec4BondwireDef, + Jedec5BondwireDef, +) +from ansys.edb.core.definition.component_def import ComponentDef +from ansys.edb.core.definition.component_model import ( + ComponentModel, + DynamicLinkComponentModel, + NPortComponentModel, +) +from ansys.edb.core.definition.component_pin import ComponentPin +from ansys.edb.core.definition.component_property import ComponentProperty +from ansys.edb.core.definition.dataset_def import DatasetDef +from ansys.edb.core.definition.debye_model import DebyeModel +from ansys.edb.core.definition.die_property import DieOrientation, DieProperty, DieType +from ansys.edb.core.definition.dielectric_material_model import ( + DielectricMaterialModel, + DielectricMaterialModelType, +) +from ansys.edb.core.definition.djordjecvic_sarkar_model import DjordjecvicSarkarModel +from ansys.edb.core.definition.ic_component_property import ICComponentProperty +from ansys.edb.core.definition.io_component_property import IOComponentProperty +from ansys.edb.core.definition.material_def import MaterialDef, MaterialProperty, ThermalModifier +from ansys.edb.core.definition.material_property_thermal_modifier import ( + MaterialPropertyThermalModifier, +) +from ansys.edb.core.definition.multipole_debye_model import MultipoleDebyeModel +from ansys.edb.core.definition.package_def import PackageDef +from ansys.edb.core.definition.padstack_def import PadstackDef +from ansys.edb.core.definition.padstack_def_data import ( + PadGeometryType, + PadstackDefData, + PadstackHoleRange, + PadType, + SolderballPlacement, + SolderballShape, +) +from ansys.edb.core.definition.port_property import PortProperty +from ansys.edb.core.definition.rlc_component_property import RLCComponentProperty +from ansys.edb.core.definition.solder_ball_property import SolderBallProperty +from ansys.edb.core.edb_defs import DefinitionObjType diff --git a/src/ansys/edb/definition/bondwire_def.py b/src/ansys/edb/core/definition/bondwire_def.py similarity index 89% rename from src/ansys/edb/definition/bondwire_def.py rename to src/ansys/edb/core/definition/bondwire_def.py index c39d6a945b..53a17af9c9 100644 --- a/src/ansys/edb/definition/bondwire_def.py +++ b/src/ansys/edb/core/definition/bondwire_def.py @@ -5,10 +5,10 @@ from ansys.api.edb.v1 import bondwire_def_pb2_grpc import ansys.api.edb.v1.bondwire_def_pb2 as pb -from ansys.edb.core import ObjBase, messages -from ansys.edb.edb_defs import DefinitionObjType -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.edb_defs import DefinitionObjType +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class _QueryBuilder: @@ -96,7 +96,7 @@ def create(cls, database, name): Parameters ---------- - database : :class:`Database `. + database : :class:`Database `. Database in which Apd Bondwire definition will be searched. name : str Name of the Apd Bondwire definition. @@ -115,7 +115,7 @@ def load_definitions_from_file(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database in which Apd Bondwire definition will be load. name : str Name of the Apd Bondwire definition. @@ -128,7 +128,7 @@ def find_by_name(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database in which Apd Bondwire definition will be searched. name : str Name of the Apd Bondwire definition. @@ -193,7 +193,7 @@ def create(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database in which Jedec4 Bondwire definition will be created. name : str Name of the Jedec4 Bondwire definition. @@ -213,7 +213,7 @@ def find_by_name(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database in which Jedec4 Bondwire definition will be searched. name : str Name of the Jedec4 Bondwire definition. @@ -232,7 +232,7 @@ def get_parameters(self): Returns ------- - :class:`Value ` + :class:`Value ` Bondwire top to die distance. """ return Value(self.__stub.GetParameters(self.msg)) @@ -242,7 +242,7 @@ def set_parameters(self, top_to_die_distance): Parameters ---------- - top_to_die_distance : :class:`Value ` + top_to_die_distance : :class:`Value ` Bondwire top to die distance. """ self.__stub.SetParameters( @@ -297,7 +297,7 @@ def create(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database in which Jedec5 Bondwire definition will be created. name : str Name of the Jedec5 Bondwire definition. @@ -317,7 +317,7 @@ def find_by_name(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database in which Jedec5 Bondwire definition will be searched. name : str Name of the Jedec5 Bondwire definition. @@ -337,9 +337,9 @@ def get_parameters(self): Returns ------- tuple[ - :class:`Value `, - :class:`Value `, - :class:`Value ` + :class:`Value `, + :class:`Value `, + :class:`Value ` ] Returns a tuple of the following format: @@ -364,11 +364,11 @@ def set_parameters(self, top_to_die_distance, die_pad_angle, lead_pad_angle): Parameters ---------- - top_to_die_distance : :class:`Value ` + top_to_die_distance : :class:`Value ` Bondwire top to die distance. - die_pad_angle : :class:`Value ` + die_pad_angle : :class:`Value ` Bondwire die pad angle. - lead_pad_angle : :class:`Value ` + lead_pad_angle : :class:`Value ` Bondwire lead pad angle. """ self.__stub.SetParameters( diff --git a/src/ansys/edb/definition/component_def.py b/src/ansys/edb/core/definition/component_def.py similarity index 76% rename from src/ansys/edb/definition/component_def.py rename to src/ansys/edb/core/definition/component_def.py index b44a55ea8f..ac5febe955 100644 --- a/src/ansys/edb/definition/component_def.py +++ b/src/ansys/edb/core/definition/component_def.py @@ -1,12 +1,12 @@ """Component Def Definition.""" from ansys.api.edb.v1.component_def_pb2_grpc import ComponentDefServiceStub -from ansys.edb.core import ObjBase, messages -from ansys.edb.core.utils import map_list -from ansys.edb.definition import component_model, component_pin -from ansys.edb.edb_defs import DefinitionObjType -from ansys.edb.layout import cell -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.definition import component_model, component_pin +from ansys.edb.core.edb_defs import DefinitionObjType +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.inner.utils import map_list +from ansys.edb.core.layout import cell +from ansys.edb.core.session import StubAccessor, StubType class ComponentDef(ObjBase): @@ -20,11 +20,11 @@ def create(cls, db, comp_def_name, fp): Parameters ---------- - db : :class:`Database ` + db : :class:`Database ` Database that the component definition should belong to. comp_def_name : str Name of the component definition to be created. - fp : :class:`Cell ` + fp : :class:`Cell ` Footprint cell of the component definition. Returns @@ -42,7 +42,7 @@ def find(cls, db, comp_def_name): Parameters ---------- - db : :class:`Database ` + db : :class:`Database ` Database to search the component definition in. comp_def_name : str Name of the component definition to be searched. @@ -72,7 +72,7 @@ def name(self, value): @property def footprint(self): - """:class:`Cell `: Footprint of the component definition.""" + """:class:`Cell `: Footprint of the component definition.""" return cell.Cell(self.__stub.GetFootprintCell(self.msg)) @footprint.setter @@ -81,7 +81,7 @@ def footprint(self, value): @property def component_models(self): - """:obj:`list` of :class:`ComponentModel `: \ + """:obj:`list` of :class:`ComponentModel `: \ List of component models associated with this component definition. Read-Only. @@ -91,7 +91,7 @@ def component_models(self): @property def component_pins(self): - """:obj:`list` of :class:`ComponentPin `: \ + """:obj:`list` of :class:`ComponentPin `: \ List of component pins of this component definition. Read-Only. diff --git a/src/ansys/edb/definition/component_model.py b/src/ansys/edb/core/definition/component_model.py similarity index 91% rename from src/ansys/edb/definition/component_model.py rename to src/ansys/edb/core/definition/component_model.py index be99ca86dd..24c542e20d 100644 --- a/src/ansys/edb/definition/component_model.py +++ b/src/ansys/edb/core/definition/component_model.py @@ -6,8 +6,8 @@ ) import google.protobuf.wrappers_pb2 as proto_wrappers -from ansys.edb.core import ObjBase, messages -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import StubAccessor, StubType class ComponentModel(ObjBase): @@ -47,7 +47,7 @@ def create(cls, name): Notes ----- The component model will not belong to a specific database until it is added to a - :class:`ComponentDef `. + :class:`ComponentDef `. """ return NPortComponentModel(cls.__stub.Create(proto_wrappers.StringValue(value=name))) @@ -74,7 +74,7 @@ def create(cls, name): Notes ----- The component model will not belong to a specific database until it is added to a - :class:`ComponentDef `. + :class:`ComponentDef `. """ return DynamicLinkComponentModel(cls.__stub.Create(proto_wrappers.StringValue(value=name))) diff --git a/src/ansys/edb/definition/component_pin.py b/src/ansys/edb/core/definition/component_pin.py similarity index 81% rename from src/ansys/edb/definition/component_pin.py rename to src/ansys/edb/core/definition/component_pin.py index cc52717259..739fd7e336 100644 --- a/src/ansys/edb/definition/component_pin.py +++ b/src/ansys/edb/core/definition/component_pin.py @@ -1,9 +1,9 @@ """Component Pin Definition.""" from ansys.api.edb.v1.component_pin_pb2_grpc import ComponentPinServiceStub -from ansys.edb.core import ObjBase, messages -from ansys.edb.definition import component_def -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.definition import component_def +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import StubAccessor, StubType class ComponentPin(ObjBase): @@ -17,7 +17,7 @@ def create(cls, comp_def, name): Parameters ---------- - comp_def : :class:`ComponentDef ` + comp_def : :class:`ComponentDef ` Component definition that the component pin should belong to. name : str Name of the component pin to be created. @@ -35,7 +35,7 @@ def find(cls, comp_def, name): Parameters ---------- - comp_def : :class:`ComponentDef ` + comp_def : :class:`ComponentDef ` Component definition to search the component pin in. name : str Name of the component pin to be searched. @@ -66,7 +66,7 @@ def number(self): @property def component_def(self): - """:class:`ComponentDef `: Component definition this component pin \ + """:class:`ComponentDef `: Component definition this component pin \ belongs to. Read-Only. diff --git a/src/ansys/edb/definition/component_property.py b/src/ansys/edb/core/definition/component_property.py similarity index 80% rename from src/ansys/edb/definition/component_property.py rename to src/ansys/edb/core/definition/component_property.py index 078466ad3b..67fb1941db 100644 --- a/src/ansys/edb/definition/component_property.py +++ b/src/ansys/edb/core/definition/component_property.py @@ -3,10 +3,10 @@ from ansys.api.edb.v1.component_property_pb2_grpc import ComponentPropertyServiceStub import ansys.api.edb.v1.model_pb2 as model_pb2 -from ansys.edb.core import ObjBase, messages -from ansys.edb.definition import package_def -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.definition import package_def +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class ComponentProperty(ObjBase): @@ -25,7 +25,7 @@ def clone(self): @property def package_mounting_offset(self): - """:class:`Value `: Offset of the package definition object. + """:class:`Value `: Offset of the package definition object. Property can be set with :term:`ValueLike` """ @@ -48,14 +48,19 @@ def package_def(self, value): @property def model(self): - """:class:`Model ` : Model object. + """:class:`Model ` : Model object. A copy is returned. Use the setter for any modifications to be reflected. """ comp_model_msg = self.__stub.GetModel(messages.edb_obj_message(self)) def get_model_obj_type(): - from ansys.edb.hierarchy import NetlistModel, PinPairModel, SParameterModel, SPICEModel + from ansys.edb.core.hierarchy import ( + NetlistModel, + PinPairModel, + SParameterModel, + SPICEModel, + ) if comp_model_msg.model_type == model_pb2.SPICE_MODEL_TYPE: return SPICEModel diff --git a/src/ansys/edb/definition/dataset_def.py b/src/ansys/edb/core/definition/dataset_def.py similarity index 80% rename from src/ansys/edb/definition/dataset_def.py rename to src/ansys/edb/core/definition/dataset_def.py index e4374e21f5..9394379426 100644 --- a/src/ansys/edb/definition/dataset_def.py +++ b/src/ansys/edb/core/definition/dataset_def.py @@ -1,16 +1,16 @@ """Dataset Def Definition.""" from ansys.api.edb.v1.dataset_def_pb2_grpc import DatasetDefServiceStub -from ansys.edb.core import ObjBase -from ansys.edb.core.messages import ( +from ansys.edb.core.edb_defs import DefinitionObjType +from ansys.edb.core.inner import ObjBase +from ansys.edb.core.inner.messages import ( edb_obj_message, edb_obj_name_message, points_property_message, string_property_message, ) -from ansys.edb.core.parser import to_point_data_list -from ansys.edb.edb_defs import DefinitionObjType -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.inner.parser import to_point_data_list +from ansys.edb.core.session import StubAccessor, StubType class DatasetDef(ObjBase): @@ -24,7 +24,7 @@ def create(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database that the dataset definition should belong to. name : :obj:`str` Name of the dataset to be created. @@ -42,7 +42,7 @@ def find_by_name(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database that owns the dataset definition. name : :obj:`str` Name of the dataset definition. @@ -75,7 +75,7 @@ def get_data(self): Returns ------- - list[:class:`PointData `] + list[:class:`PointData `] """ msg = self.__stub.GetData(edb_obj_message(self)) return msg.points @@ -85,6 +85,6 @@ def set_data(self, points): Parameters ---------- - points : list[:class:`PointData `] + points : list[:class:`PointData `] """ self.__stub.SetData(points_property_message(self, points)) diff --git a/src/ansys/edb/definition/debye_model.py b/src/ansys/edb/core/definition/debye_model.py similarity index 96% rename from src/ansys/edb/definition/debye_model.py rename to src/ansys/edb/core/definition/debye_model.py index 1c171160c1..8805abd859 100644 --- a/src/ansys/edb/definition/debye_model.py +++ b/src/ansys/edb/core/definition/debye_model.py @@ -3,9 +3,9 @@ import ansys.api.edb.v1.debye_model_pb2 as pb from google.protobuf import empty_pb2 -from ansys.edb import session -from ansys.edb.core import messages -from ansys.edb.definition.dielectric_material_model import DielectricMaterialModel +from ansys.edb.core import session +from ansys.edb.core.definition.dielectric_material_model import DielectricMaterialModel +from ansys.edb.core.inner import messages class _DebyeModelQueryBuilder: diff --git a/src/ansys/edb/definition/die_property.py b/src/ansys/edb/core/definition/die_property.py similarity index 90% rename from src/ansys/edb/definition/die_property.py rename to src/ansys/edb/core/definition/die_property.py index c43257a2b3..36f29ad759 100644 --- a/src/ansys/edb/definition/die_property.py +++ b/src/ansys/edb/core/definition/die_property.py @@ -6,9 +6,9 @@ from ansys.api.edb.v1.die_property_pb2_grpc import DiePropertyServiceStub import google.protobuf.empty_pb2 as empty_pb2 -from ansys.edb.core import ObjBase, messages -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class DieOrientation(Enum): @@ -74,7 +74,7 @@ def die_type(self, value): @property def height(self): - """:class:`Value `: Height of the die property. + """:class:`Value `: Height of the die property. Property can be set with :term:`ValueLike` """ diff --git a/src/ansys/edb/definition/dielectric_material_model.py b/src/ansys/edb/core/definition/dielectric_material_model.py similarity index 91% rename from src/ansys/edb/definition/dielectric_material_model.py rename to src/ansys/edb/core/definition/dielectric_material_model.py index c3bfddef11..d0bf25ecbb 100644 --- a/src/ansys/edb/definition/dielectric_material_model.py +++ b/src/ansys/edb/core/definition/dielectric_material_model.py @@ -3,8 +3,8 @@ from ansys.api.edb.v1 import dielectric_material_model_pb2_grpc -from ansys.edb import session -from ansys.edb.core import ObjBase +from ansys.edb.core import session +from ansys.edb.core.inner import ObjBase class DielectricMaterialModelType(Enum): diff --git a/src/ansys/edb/definition/djordjecvic_sarkar_model.py b/src/ansys/edb/core/definition/djordjecvic_sarkar_model.py similarity index 94% rename from src/ansys/edb/definition/djordjecvic_sarkar_model.py rename to src/ansys/edb/core/definition/djordjecvic_sarkar_model.py index 38fcf69d7b..1bd6353e38 100644 --- a/src/ansys/edb/definition/djordjecvic_sarkar_model.py +++ b/src/ansys/edb/core/definition/djordjecvic_sarkar_model.py @@ -2,9 +2,9 @@ from ansys.api.edb.v1 import djordjecvic_sarkar_model_pb2_grpc from google.protobuf import empty_pb2 -from ansys.edb import session -from ansys.edb.core import messages -from ansys.edb.definition.dielectric_material_model import DielectricMaterialModel +from ansys.edb.core import session +from ansys.edb.core.definition.dielectric_material_model import DielectricMaterialModel +from ansys.edb.core.inner import messages class DjordjecvicSarkarModel(DielectricMaterialModel): diff --git a/src/ansys/edb/definition/ic_component_property.py b/src/ansys/edb/core/definition/ic_component_property.py similarity index 94% rename from src/ansys/edb/definition/ic_component_property.py rename to src/ansys/edb/core/definition/ic_component_property.py index 830b6d5313..ce01088e5b 100644 --- a/src/ansys/edb/definition/ic_component_property.py +++ b/src/ansys/edb/core/definition/ic_component_property.py @@ -3,14 +3,14 @@ from ansys.api.edb.v1.ic_component_property_pb2_grpc import ICComponentPropertyServiceStub import google.protobuf.empty_pb2 as empty_pb2 -from ansys.edb.core import messages -from ansys.edb.definition import ( +from ansys.edb.core.definition import ( component_property, die_property, port_property, solder_ball_property, ) -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.inner import messages +from ansys.edb.core.session import StubAccessor, StubType class ICComponentProperty(component_property.ComponentProperty): diff --git a/src/ansys/edb/definition/io_component_property.py b/src/ansys/edb/core/definition/io_component_property.py similarity index 89% rename from src/ansys/edb/definition/io_component_property.py rename to src/ansys/edb/core/definition/io_component_property.py index 2257913cdf..45b0c533d8 100644 --- a/src/ansys/edb/definition/io_component_property.py +++ b/src/ansys/edb/core/definition/io_component_property.py @@ -3,9 +3,9 @@ from ansys.api.edb.v1.io_component_property_pb2_grpc import IOComponentPropertyServiceStub import google.protobuf.empty_pb2 as empty_pb2 -from ansys.edb.core import messages -from ansys.edb.definition import component_property, port_property, solder_ball_property -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.definition import component_property, port_property, solder_ball_property +from ansys.edb.core.inner import messages +from ansys.edb.core.session import StubAccessor, StubType class IOComponentProperty(component_property.ComponentProperty): diff --git a/src/ansys/edb/definition/material_def.py b/src/ansys/edb/core/definition/material_def.py similarity index 92% rename from src/ansys/edb/definition/material_def.py rename to src/ansys/edb/core/definition/material_def.py index ca09cf5549..0ef5a23a19 100644 --- a/src/ansys/edb/definition/material_def.py +++ b/src/ansys/edb/core/definition/material_def.py @@ -4,11 +4,11 @@ import ansys.api.edb.v1.material_def_pb2 as pb -from ansys.edb.core import ObjBase, messages -from ansys.edb.definition import DielectricMaterialModel -from ansys.edb.edb_defs import DefinitionObjType -from ansys.edb.session import MaterialDefServiceStub, StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.definition import DielectricMaterialModel +from ansys.edb.core.edb_defs import DefinitionObjType +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import MaterialDefServiceStub, StubAccessor, StubType +from ansys.edb.core.utility import Value class MaterialProperty(Enum): @@ -149,11 +149,11 @@ def create(cls, database, name, **kwargs): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database that will own the material definition. name : str Name of the material definition being created. - kwargs : dict{ str : :class:`Value ` } + kwargs : dict{ str : :class:`Value ` } Dictionary to be converted to MaterialDefPropertiesMessage.\ Dict key is the material property name.\ Dict value is the material property value.\ @@ -183,7 +183,7 @@ def find_by_name(cls, database, name): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database that owns the material definition. name : str Name of the material definition. @@ -210,7 +210,8 @@ def name(self): @property def dielectric_material_model(self): - """:class:`DielectricMaterialModel `: \ + """:class:`DielectricMaterialModel \ + `: \ Dielectric material model of the material definition.""" return DielectricMaterialModel( self.__stub.GetDielectricMaterialModel(messages.edb_obj_message(self)) @@ -231,7 +232,7 @@ def set_property(self, material_property, value, component_id=None, col=None, ro ---------- material_property : :class:`MaterialProperty` Property id. - value : :class:`Value ` + value : :class:`Value ` Property value returned. component_id : int, optional Component id. @@ -260,7 +261,7 @@ def get_property(self, material_property, component_id=None, row=None, col=None) Returns ------- - :class:`Value ` + :class:`Value ` Value of the material property. """ return Value( @@ -370,7 +371,7 @@ def get_anisotropic_thermal_modifier(self, material_property_id, component_id): Returns ------- - :class:`ThermalModifier ` + :class:`ThermalModifier ` Anisotropic thermal modifier of the material definition. """ return ThermalModifier( @@ -393,7 +394,7 @@ def set_anisotropic_thermal_modifier( Property id. component_id : int Component id - thermal_modifier : :class:`ThermalModifier ` + thermal_modifier : :class:`ThermalModifier ` Anisotropic thermal modifier to be set to the material definition """ self.__stub.SetAnisotropicThermalModifier( diff --git a/src/ansys/edb/definition/material_property_thermal_modifier.py b/src/ansys/edb/core/definition/material_property_thermal_modifier.py similarity index 84% rename from src/ansys/edb/definition/material_property_thermal_modifier.py rename to src/ansys/edb/core/definition/material_property_thermal_modifier.py index f1b33f446f..b211724a05 100644 --- a/src/ansys/edb/definition/material_property_thermal_modifier.py +++ b/src/ansys/edb/core/definition/material_property_thermal_modifier.py @@ -3,9 +3,9 @@ from ansys.api.edb.v1 import material_property_thermal_modifier_pb2_grpc import ansys.api.edb.v1.material_def_pb2 as pb -from ansys.edb.core import ObjBase, messages -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import AdvancedQuadraticParams, BasicQuadraticParams, Value +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import AdvancedQuadraticParams, BasicQuadraticParams, Value class _QueryBuilder: @@ -40,9 +40,9 @@ def create(cls, basic_quadratic_params=None, advanced_quadratic_params=None): Parameters ---------- - basic_quadratic_params: :class:`BasicQuadraticParams ` + basic_quadratic_params: :class:`BasicQuadraticParams ` Thermal Modifier basic parameters needed. - advanced_quadratic_params : :class:`AdvancedQuadraticParams ` + advanced_quadratic_params : :class:`AdvancedQuadraticParams ` Thermal Modifier advanced parameters. Returns @@ -62,9 +62,9 @@ def create(cls, basic_quadratic_params=None, advanced_quadratic_params=None): @property def quadratic_model_params(self): - """:class:`BasicQuadraticParams `, \ - :class:`AdvancedQuadraticParams `: Quadratic model parameters of \ - the thermal modifier. + """:class:`BasicQuadraticParams `, \ + :class:`AdvancedQuadraticParams `: \ + Quadratic model parameters of the thermal modifier. The quadratic model is of the following form: PropVal(Temp) = PropValRef[1 + C1(Temp - TempRef) + C2(Temp - TempRef)^2] @@ -87,7 +87,7 @@ def quadratic_model_params(self): @property def expression(self): - """:class:`Value `: Expression value representing the thermal modifier. + """:class:`Value `: Expression value representing the thermal modifier. Read-Only. """ diff --git a/src/ansys/edb/definition/multipole_debye_model.py b/src/ansys/edb/core/definition/multipole_debye_model.py similarity index 94% rename from src/ansys/edb/definition/multipole_debye_model.py rename to src/ansys/edb/core/definition/multipole_debye_model.py index a6b9b93c7e..ea3174b071 100644 --- a/src/ansys/edb/definition/multipole_debye_model.py +++ b/src/ansys/edb/core/definition/multipole_debye_model.py @@ -3,9 +3,9 @@ import ansys.api.edb.v1.multipole_debye_model_pb2 as pb from google.protobuf import empty_pb2 -from ansys.edb import session -from ansys.edb.core import messages -from ansys.edb.definition.dielectric_material_model import DielectricMaterialModel +from ansys.edb.core import session +from ansys.edb.core.definition.dielectric_material_model import DielectricMaterialModel +from ansys.edb.core.inner import messages class _MultipoleDebyeModelQueryBuilder: diff --git a/src/ansys/edb/definition/package_def.py b/src/ansys/edb/core/definition/package_def.py similarity index 82% rename from src/ansys/edb/definition/package_def.py rename to src/ansys/edb/core/definition/package_def.py index 37a54baed0..9ca598068c 100644 --- a/src/ansys/edb/definition/package_def.py +++ b/src/ansys/edb/core/definition/package_def.py @@ -2,8 +2,9 @@ from ansys.api.edb.v1 import package_def_pb2_grpc -from ansys.edb.core import ObjBase, parser -from ansys.edb.core.messages import ( +from ansys.edb.core.edb_defs import DefinitionObjType +from ansys.edb.core.inner import ObjBase, parser +from ansys.edb.core.inner.messages import ( edb_obj_message, get_product_property_ids_message, get_product_property_message, @@ -15,10 +16,9 @@ value_message, value_property_message, ) -from ansys.edb.edb_defs import DefinitionObjType -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value -from ansys.edb.utility.heat_sink import HeatSink, HeatSinkFinOrientation +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value +from ansys.edb.core.utility.heat_sink import HeatSink, HeatSinkFinOrientation class PackageDef(ObjBase): @@ -32,7 +32,7 @@ def create(cls, db, name): Parameters ---------- - db :class:`Database ` + db :class:`Database ` Database in which we save the Package Definition. name : str Name of the Package Definition. @@ -80,7 +80,7 @@ def name(self, value): @property @parser.to_polygon_data def exterior_boundary(self): - """:class:`PolygonData `: Exterior boundary for package definition.""" + """:class:`PolygonData `: Exterior boundary for package definition.""" return self.__stub.GetExteriorBoundary(edb_obj_message(self)) @exterior_boundary.setter @@ -89,7 +89,7 @@ def exterior_boundary(self, boundary): @property def height(self): - """:class:`Value `: Height of the package definition object.""" + """:class:`Value `: Height of the package definition object.""" return Value(self.__stub.GetHeight(edb_obj_message(self))) @height.setter @@ -98,7 +98,7 @@ def height(self, height): @property def operating_power(self): - """:class:`Value `: Operating power of the package.""" + """:class:`Value `: Operating power of the package.""" return Value(self.__stub.GetOperatingPower(edb_obj_message(self))) @operating_power.setter @@ -107,7 +107,7 @@ def operating_power(self, power): @property def maximum_power(self): - """:class:`Value `: Maximum power of the package.""" + """:class:`Value `: Maximum power of the package.""" return Value(self.__stub.GetMaximumPower(edb_obj_message(self))) @maximum_power.setter @@ -116,7 +116,7 @@ def maximum_power(self, power): @property def thermal_conductivity(self): - """:class:`Value `: Thermal conductivity of the package.""" + """:class:`Value `: Thermal conductivity of the package.""" return Value(self.__stub.GetTherm_Cond(edb_obj_message(self))) @thermal_conductivity.setter @@ -125,7 +125,7 @@ def thermal_conductivity(self, conductivity): @property def theta_jb(self): - """:class:`Value `: Theta_JB (junction to board) of the package.""" + """:class:`Value `: Theta_JB (junction to board) of the package.""" return Value(self.__stub.GetTheta_JB(edb_obj_message(self))) @theta_jb.setter @@ -134,7 +134,7 @@ def theta_jb(self, theta): @property def theta_jc(self): - """:class:`Value `: Theta_JC (junction to case) of the package.""" + """:class:`Value `: Theta_JC (junction to case) of the package.""" return Value(self.__stub.GetTheta_JC(edb_obj_message(self))) @theta_jc.setter @@ -143,7 +143,7 @@ def theta_jc(self, theta): @property def heat_sink(self): - """:class:`HeatSink `: Assigned heat sink model for the package definition.""" + """:class:`HeatSink `: Assigned heat sink model for the package definition.""" heat_sink_paramaters = self.__stub.GetHeatSink(edb_obj_message(self)) return HeatSink( heat_sink_paramaters.thickness, diff --git a/src/ansys/edb/definition/padstack_def.py b/src/ansys/edb/core/definition/padstack_def.py similarity index 81% rename from src/ansys/edb/definition/padstack_def.py rename to src/ansys/edb/core/definition/padstack_def.py index 61be91d609..c63b15422e 100644 --- a/src/ansys/edb/definition/padstack_def.py +++ b/src/ansys/edb/core/definition/padstack_def.py @@ -3,10 +3,10 @@ from ansys.api.edb.v1 import padstack_def_pb2_grpc import ansys.api.edb.v1.padstack_def_pb2 as pb -from ansys.edb.core import ObjBase -from ansys.edb.definition.padstack_def_data import PadstackDefData -from ansys.edb.edb_defs import DefinitionObjType -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.definition.padstack_def_data import PadstackDefData +from ansys.edb.core.edb_defs import DefinitionObjType +from ansys.edb.core.inner import ObjBase +from ansys.edb.core.session import StubAccessor, StubType class _PadstackDefQueryBuilder: @@ -18,7 +18,7 @@ def padstack_def_string_message(target, name): Parameters ---------- - target: :class:`Database ` or PadstackDef + target: :class:`Database ` or PadstackDef name : str Returns @@ -35,7 +35,7 @@ def padstack_def_set_data_message(target, data): ---------- target: PadstackDef PadstackDef target to change. - data : :class:`PadstackDefData ` + data : :class:`PadstackDefData ` PadstackDefData data to be set on the PadstackDef Returns @@ -56,7 +56,7 @@ def create(cls, db, name): Parameters ---------- - db : :class:`Database ` + db : :class:`Database ` Database object which will create the PadstackDef. name : str Data to be set on the PadstackDef. @@ -76,7 +76,7 @@ def find_by_name(cls, db, name): Parameters ---------- - db : :class:`Database `. + db : :class:`Database `. Database in which we search for the PadstackDef. name : str Name of PadstackDef. @@ -104,7 +104,7 @@ def name(self): @property def data(self): - """:class:`PadstackDefData `: \ + """:class:`PadstackDefData `: \ PadstackDefData of the PadstackDef.""" return PadstackDefData(self.__stub.GetData(self.msg)) diff --git a/src/ansys/edb/definition/padstack_def_data.py b/src/ansys/edb/core/definition/padstack_def_data.py similarity index 91% rename from src/ansys/edb/definition/padstack_def_data.py rename to src/ansys/edb/core/definition/padstack_def_data.py index 46ea207181..52c2df23bd 100644 --- a/src/ansys/edb/definition/padstack_def_data.py +++ b/src/ansys/edb/core/definition/padstack_def_data.py @@ -9,9 +9,9 @@ from ansys.api.edb.v1.padstack_def_data_pb2_grpc import PadstackDefDataServiceStub import google.protobuf.empty_pb2 as empty_pb2 -from ansys.edb.core import ObjBase, messages, parser -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.inner import ObjBase, messages, parser +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class _PadstackDefDataQueryBuilder: @@ -343,17 +343,17 @@ def get_pad_parameters(self, layer, pad_type): Returns ------- tuple[:class:`PadGeometryType`, - list[:class:`Value `], - :class:`Value `, - :class:`Value `, - :class:`Value `] + list[:class:`Value `], + :class:`Value `, + :class:`Value `, + :class:`Value `] or - tuple[:class:`PolygonData `, - :class:`Value `, - :class:`Value `, - :class:`Value `] + tuple[:class:`PolygonData `, + :class:`Value `, + :class:`Value `, + :class:`Value `] Returns a tuple of the following format: @@ -408,17 +408,17 @@ def set_pad_parameters( Layer name. pad_type : PadType Pad type. - offset_x : :class:`Value ` + offset_x : :class:`Value ` X offset. - offset_y : :class:`Value ` + offset_y : :class:`Value ` Y offset. - rotation : :class:`Value ` + rotation : :class:`Value ` Rotation. type_geom : PadGeometryType Pad geometry type. None if setting polygonal pad parameters. - sizes : List[:class:`Value `] + sizes : List[:class:`Value `] Pad parameters. None if setting polygonal pad parameters. - fp : :class:`PolygonData ` + fp : :class:`PolygonData ` Polygon geometry. None if not setting polygonal pad parameters. """ self.__stub.SetPadParameters( @@ -434,10 +434,10 @@ def get_hole_parameters(self): Returns ------- tuple[ - :class:`PolygonData `, - :class:`Value `, - :class:`Value `, - :class:`Value ` + :class:`PolygonData `, + :class:`Value `, + :class:`Value `, + :class:`Value ` ] Returns a tuple of the following format: @@ -462,13 +462,13 @@ def set_hole_parameters(self, offset_x, offset_y, rotation, type_geom, sizes): ---------- type_geom : PadGeometryType Pad geometry type. - sizes : List[:class:`Value `] + sizes : List[:class:`Value `] Pad parameters. - offset_x : :class:`Value ` + offset_x : :class:`Value ` X offset. - offset_y : :class:`Value ` + offset_y : :class:`Value ` Y offset. - rotation : :class:`Value ` + rotation : :class:`Value ` Rotation. """ return self.set_pad_parameters( @@ -488,7 +488,7 @@ def hole_range(self, hole_range): @property def plating_percentage(self): - """:class:`Value `:Hole plating percentage.""" + """:class:`Value `:Hole plating percentage.""" return Value(self.__stub.GetPlatingPercentage(self.msg)) @plating_percentage.setter @@ -533,8 +533,8 @@ def solder_ball_param(self): Returns ------- tuple[ - :class:`Value `, - :class:`Value ` + :class:`Value `, + :class:`Value ` ] Returns a tuple of the following format: diff --git a/src/ansys/edb/definition/port_property.py b/src/ansys/edb/core/definition/port_property.py similarity index 86% rename from src/ansys/edb/definition/port_property.py rename to src/ansys/edb/core/definition/port_property.py index 6b9f03c3a0..f94a234bbc 100644 --- a/src/ansys/edb/definition/port_property.py +++ b/src/ansys/edb/core/definition/port_property.py @@ -3,9 +3,9 @@ from ansys.api.edb.v1.port_property_pb2_grpc import PortPropertyServiceStub import google.protobuf.empty_pb2 as empty_pb2 -from ansys.edb.core import ObjBase, messages -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class PortProperty(ObjBase): @@ -38,7 +38,7 @@ def clone(self): @property def reference_height(self): - """:class:`Value `: Reference height of the port property. + """:class:`Value `: Reference height of the port property. Property can be set with :term:`ValueLike` """ @@ -65,8 +65,8 @@ def get_reference_size(self): Returns ------- tuple[ - :class:`Value `, - :class:`Value ` + :class:`Value `, + :class:`Value ` ] X and Y reference sizes. """ diff --git a/src/ansys/edb/definition/rlc_component_property.py b/src/ansys/edb/core/definition/rlc_component_property.py similarity index 84% rename from src/ansys/edb/definition/rlc_component_property.py rename to src/ansys/edb/core/definition/rlc_component_property.py index a4b216d1db..b315ee0e73 100644 --- a/src/ansys/edb/definition/rlc_component_property.py +++ b/src/ansys/edb/core/definition/rlc_component_property.py @@ -3,9 +3,9 @@ from ansys.api.edb.v1.rlc_component_property_pb2_grpc import RLCComponentPropertyServiceStub import google.protobuf.empty_pb2 as empty_pb2 -from ansys.edb.core import messages -from ansys.edb.definition.component_property import ComponentProperty -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.definition.component_property import ComponentProperty +from ansys.edb.core.inner import messages +from ansys.edb.core.session import StubAccessor, StubType class RLCComponentProperty(ComponentProperty): diff --git a/src/ansys/edb/definition/solder_ball_property.py b/src/ansys/edb/core/definition/solder_ball_property.py similarity index 94% rename from src/ansys/edb/definition/solder_ball_property.py rename to src/ansys/edb/core/definition/solder_ball_property.py index a1cb32092d..d3ecefb7e0 100644 --- a/src/ansys/edb/definition/solder_ball_property.py +++ b/src/ansys/edb/core/definition/solder_ball_property.py @@ -5,20 +5,20 @@ from ansys.api.edb.v1.solder_ball_property_pb2_grpc import SolderBallPropertyServiceStub import google.protobuf.empty_pb2 as empty_pb2 -from ansys.edb.core import ObjBase -from ansys.edb.core.messages import ( +from ansys.edb.core.definition.padstack_def_data import ( + SolderballPlacement, + SolderballShape, + _PadstackDefDataQueryBuilder, +) +from ansys.edb.core.inner import ObjBase +from ansys.edb.core.inner.messages import ( edb_obj_message, string_property_message, value_message, value_property_message, ) -from ansys.edb.definition.padstack_def_data import ( - SolderballPlacement, - SolderballShape, - _PadstackDefDataQueryBuilder, -) -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class _QueryBuilder: diff --git a/src/ansys/edb/edb_defs.py b/src/ansys/edb/core/edb_defs.py similarity index 100% rename from src/ansys/edb/edb_defs.py rename to src/ansys/edb/core/edb_defs.py diff --git a/src/ansys/edb/core/geometry/__init__.py b/src/ansys/edb/core/geometry/__init__.py new file mode 100644 index 0000000000..f3c23d0dcc --- /dev/null +++ b/src/ansys/edb/core/geometry/__init__.py @@ -0,0 +1,8 @@ +"""Import geometry classes.""" + +from ansys.edb.core.geometry.arc_data import ArcData +from ansys.edb.core.geometry.point3d_data import Point3DData +from ansys.edb.core.geometry.point_data import PointData +from ansys.edb.core.geometry.polygon_data import ExtentType, PolygonData, PolygonSenseType +from ansys.edb.core.geometry.r_tree import RTree +from ansys.edb.core.geometry.triangle3d_data import Triangle3DData diff --git a/src/ansys/edb/geometry/arc_data.py b/src/ansys/edb/core/geometry/arc_data.py similarity index 94% rename from src/ansys/edb/geometry/arc_data.py rename to src/ansys/edb/core/geometry/arc_data.py index 7aa2865484..61a5be5ef8 100644 --- a/src/ansys/edb/geometry/arc_data.py +++ b/src/ansys/edb/core/geometry/arc_data.py @@ -4,9 +4,9 @@ from ansys.api.edb.v1 import arc_data_pb2_grpc -from ansys.edb import geometry, session -from ansys.edb.core import messages, parser -from ansys.edb.utility import conversions +from ansys.edb.core import geometry, session +from ansys.edb.core.inner import messages, parser +from ansys.edb.core.utility import conversions class RotationDirection(enum.Enum): @@ -27,13 +27,13 @@ def __init__(self, start, end, **kwargs): Parameters ---------- - start : ansys.edb.typing.PointLike - end : ansys.edb.typing.PointLike + start : ansys.edb.core.typing.PointLike + end : ansys.edb.core.typing.PointLike height: float, int, optional - thru : ansys.edb.typing.PointLike, optional + thru : ansys.edb.core.typing.PointLike, optional direction : Literal["cw", "ccw", "colinear"], optional radius : float, optional - center : ansys.edb.typing.PointLike, optional + center : ansys.edb.core.typing.PointLike, optional is_big : bool, optional """ self._start = conversions.to_point(start) @@ -265,7 +265,7 @@ def tangent_at(self, point): Parameters ---------- - point : ansys.edb.typing.PointLike + point : ansys.edb.core.typing.PointLike Returns ------- diff --git a/src/ansys/edb/geometry/point3d_data.py b/src/ansys/edb/core/geometry/point3d_data.py similarity index 93% rename from src/ansys/edb/geometry/point3d_data.py rename to src/ansys/edb/core/geometry/point3d_data.py index 27658a88db..abfc3b3380 100644 --- a/src/ansys/edb/geometry/point3d_data.py +++ b/src/ansys/edb/core/geometry/point3d_data.py @@ -1,5 +1,5 @@ """Point3D Data.""" -from ansys.edb.utility import conversions +from ansys.edb.core.utility import conversions class Point3DData: @@ -61,7 +61,7 @@ def __neg__(self): @property def x(self): - """:class:`Value`: x coordinate.""" + """:class:`Value`: x coordinate.""" return self._x @x.setter @@ -70,7 +70,7 @@ def x(self, x): @property def y(self): - """:class:`Value`: y coordinate.""" + """:class:`Value`: y coordinate.""" return self._y @y.setter @@ -79,7 +79,7 @@ def y(self, y): @property def z(self): - """:class:`Value`: z coordinate.""" + """:class:`Value`: z coordinate.""" return self._z @z.setter diff --git a/src/ansys/edb/geometry/point_data.py b/src/ansys/edb/core/geometry/point_data.py similarity index 90% rename from src/ansys/edb/geometry/point_data.py rename to src/ansys/edb/core/geometry/point_data.py index dcffd78fa5..da24b27922 100644 --- a/src/ansys/edb/geometry/point_data.py +++ b/src/ansys/edb/core/geometry/point_data.py @@ -6,9 +6,9 @@ from ansys.api.edb.v1 import point_data_pb2_grpc -from ansys.edb import session, utility -from ansys.edb.core import messages, parser -from ansys.edb.utility import conversions +from ansys.edb.core import session, utility +from ansys.edb.core.inner import messages, parser +from ansys.edb.core.utility import conversions class PointData: @@ -23,7 +23,7 @@ def __init__(self, *data): Parameters ---------- - data : Iterable[Iterable[ansys.edb.typing.ValueLike], ansys.edb.typing.ValueLike] + data : Iterable[Iterable[ansys.edb.core.typing.ValueLike], ansys.edb.core.typing.ValueLike] """ self._x = self._y = self._arc_h = None @@ -76,7 +76,7 @@ def __add__(self, other): Parameters ---------- - other : ansys.edb.typing.PointLike + other : ansys.edb.core.typing.PointLike Returns ------- @@ -89,7 +89,7 @@ def __sub__(self, other): Parameters ---------- - other : ansys.edb.typing.PointLike + other : ansys.edb.core.typing.PointLike Returns ------- @@ -112,7 +112,7 @@ def equals(self, other, tolerance=0.0): Parameters ---------- - other : ansys.edb.typing.PointLike + other : ansys.edb.core.typing.PointLike tolerance : float, optional Returns @@ -222,8 +222,8 @@ def closest(self, start, end): Parameters ---------- - start : ansys.edb.typing.PointLike - end : ansys.edb.typing.PointLike + start : ansys.edb.core.typing.PointLike + end : ansys.edb.core.typing.PointLike Returns ------- @@ -238,8 +238,8 @@ def distance(self, start, end=None): Parameters ---------- - start : ansys.edb.typing.PointLike - end : ansys.edb.typing.PointLike, optional + start : ansys.edb.core.typing.PointLike + end : ansys.edb.core.typing.PointLike, optional Returns ------- @@ -259,7 +259,7 @@ def cross(self, other): Parameters ---------- - other : ansys.edb.typing.PointLike + other : ansys.edb.core.typing.PointLike Returns ------- @@ -276,7 +276,7 @@ def move(self, vector): Parameters ---------- - vector : ansys.edb.typing.PointLike + vector : ansys.edb.core.typing.PointLike Returns ------- @@ -296,7 +296,7 @@ def rotate(self, angle, center): ---------- angle : float in radians. - center : ansys.edb.typing.PointLike + center : ansys.edb.core.typing.PointLike Returns ------- @@ -310,7 +310,7 @@ def dot(self, other): Parameters ---------- - other : ansys.edb.typing.PointLike + other : ansys.edb.core.typing.PointLike Returns ------- @@ -323,7 +323,7 @@ def angle(self, other): Parameters ---------- - other : ansys.edb.typing.PointLike + other : ansys.edb.core.typing.PointLike Returns ------- diff --git a/src/ansys/edb/geometry/polygon_data.py b/src/ansys/edb/core/geometry/polygon_data.py similarity index 92% rename from src/ansys/edb/geometry/polygon_data.py rename to src/ansys/edb/core/geometry/polygon_data.py index c4ca7ddb23..420826c113 100644 --- a/src/ansys/edb/geometry/polygon_data.py +++ b/src/ansys/edb/core/geometry/polygon_data.py @@ -6,10 +6,10 @@ from ansys.api.edb.v1 import edb_defs_pb2, point_data_pb2, polygon_data_pb2_grpc -from ansys.edb import session -from ansys.edb.core import messages, parser -from ansys.edb.geometry.arc_data import ArcData -from ansys.edb.utility import conversions +from ansys.edb.core import session +from ansys.edb.core.geometry.arc_data import ArcData +from ansys.edb.core.inner import messages, parser +from ansys.edb.core.utility import conversions class PolygonSenseType(Enum): @@ -57,12 +57,12 @@ def __init__( Parameters ---------- - points : list[ansys.edb.typing.PointLike], optional + points : list[ansys.edb.core.typing.PointLike], optional arcs : list[ArcData], optional - lower_left : ansys.edb.typing.PointLike, optional - upper_right : ansys.edb.typing.PointLike, optional - holes : List[ansys.edb.geometry.PolygonData] - sense : ansys.edb.geometry.PolygonSenseType, optional + lower_left : ansys.edb.core.typing.PointLike, optional + upper_right : ansys.edb.core.typing.PointLike, optional + holes : List[ansys.edb.core.geometry.PolygonData] + sense : ansys.edb.core.geometry.PolygonSenseType, optional closed : bool, optional """ self._holes, self._sense, self._is_closed = ( @@ -103,7 +103,7 @@ def points(self): Returns ------- - list[ansys.edb.geometry.PointData] + list[ansys.edb.core.geometry.PointData] """ return self._points @@ -271,7 +271,7 @@ def normalized(self): Returns ------- - list[ansys.edb.geometry.PointData] + list[ansys.edb.core.geometry.PointData] """ return self.__stub.GetNormalizedPoints(messages.polygon_data_message(self)) @@ -281,7 +281,7 @@ def move(self, vector): Parameters ---------- - vector : ansys.edb.typing.PointLikeT + vector : ansys.edb.core.typing.PointLikeT Returns ------- @@ -297,7 +297,7 @@ def rotate(self, angle, center): ---------- angle : float in radian. - center : ansys.edb.typing.PoinyLikeT + center : ansys.edb.core.typing.PoinyLikeT Returns ------- @@ -314,7 +314,7 @@ def scale(self, factor, center): Parameters ---------- factor : float - center : ansys.edb.typing.PointLikeT + center : ansys.edb.core.typing.PointLikeT Returns ------- @@ -344,7 +344,7 @@ def bbox(self): Returns ------- - tuple[ansys.edb.geometry.PointData, ansys.edb.geometry.PointData] + tuple[ansys.edb.core.geometry.PointData, ansys.edb.core.geometry.PointData] """ return self.__stub.GetBBox(messages.polygon_data_list_message([self])) @@ -359,7 +359,7 @@ def bbox_of_polygons(cls, polygons): Returns ------- - tuple[ansys.edb.geometry.PointData, ansys.edb.geometry.PointData] + tuple[ansys.edb.core.geometry.PointData, ansys.edb.core.geometry.PointData] """ return cls.__stub.GetBBox(messages.polygon_data_list_message(polygons)) @@ -369,7 +369,7 @@ def bounding_circle(self): Returns ------- - tuple[ansys.edb.geometry.PointData, ansys.edb.utility.Value] + tuple[ansys.edb.core.geometry.PointData, ansys.edb.core.utility.Value] """ return self.__stub.GetBoundingCircle(messages.polygon_data_message(self)) @@ -427,7 +427,7 @@ def is_inside(self, point): Parameters ---------- - point : ansys.edb.typing.PointLikeT + point : ansys.edb.core.typing.PointLikeT Returns ------- @@ -456,7 +456,7 @@ def circle_intersect(self, center, radius): Parameters ---------- - center : ansys.edb.typing.PointLikeT + center : ansys.edb.core.typing.PointLikeT radius : float Returns @@ -473,11 +473,11 @@ def closest_point(self, point): Parameters ---------- - point : ansys.edb.typing.PointLikeT + point : ansys.edb.core.typing.PointLikeT Returns ------- - ansys.edb.geometry.PointData + ansys.edb.core.geometry.PointData """ return self.__stub.GetClosestPoints( messages.polygon_data_with_points_message(self, point=point) @@ -493,7 +493,7 @@ def closest_points(self, polygon): Returns ------- - tuple[ansys.edb.geometry.PointData, ansys.edb.geometry.PointData] + tuple[ansys.edb.core.geometry.PointData, ansys.edb.core.geometry.PointData] """ return self.__stub.GetClosestPoints( messages.polygon_data_with_points_message(self, polygon=polygon) @@ -597,7 +597,7 @@ def alpha_shape(cls, points, alpha): Parameters ---------- - points : list[ansys.edb.typing.PointLikeT] + points : list[ansys.edb.core.typing.PointLikeT] alpha : float Returns diff --git a/src/ansys/edb/geometry/r_tree.py b/src/ansys/edb/core/geometry/r_tree.py similarity index 96% rename from src/ansys/edb/geometry/r_tree.py rename to src/ansys/edb/core/geometry/r_tree.py index 2c130b1bd1..f638184bb4 100644 --- a/src/ansys/edb/geometry/r_tree.py +++ b/src/ansys/edb/core/geometry/r_tree.py @@ -3,8 +3,8 @@ from ansys.api.edb.v1 import r_tree_pb2_grpc import ansys.api.edb.v1.r_tree_pb2 as pb -from ansys.edb.core import ObjBase, messages, parser -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.inner import ObjBase, messages, parser +from ansys.edb.core.session import StubAccessor, StubType class _QueryBuilder: @@ -52,7 +52,7 @@ def __init__( Parameters ---------- - polygon: :class:`PolygonData ` + polygon: :class:`PolygonData ` The polygon representation for the object in the spatial index. obj: ObjBase The object to be stored in the index. @@ -154,8 +154,8 @@ def search(self, box, bb_search): The testing region, described as a (lower-left, upper-right) box. bb_search: bool If true, an RTreeObj intersects when the bounding-box of it's \ - :class:`PolygonData ` intersects the testing object. If false, an explicit\ - intersection is required for a hit. + :class:`PolygonData ` \ + intersects the testing object. If false, an explicit intersection is required for a hit. Returns ------- diff --git a/src/ansys/edb/geometry/triangle3d_data.py b/src/ansys/edb/core/geometry/triangle3d_data.py similarity index 100% rename from src/ansys/edb/geometry/triangle3d_data.py rename to src/ansys/edb/core/geometry/triangle3d_data.py diff --git a/src/ansys/edb/core/hierarchy/__init__.py b/src/ansys/edb/core/hierarchy/__init__.py new file mode 100644 index 0000000000..127579fead --- /dev/null +++ b/src/ansys/edb/core/hierarchy/__init__.py @@ -0,0 +1,14 @@ +"""Import hierarchy classes.""" + +from ansys.edb.core.hierarchy.cell_instance import CellInstance +from ansys.edb.core.hierarchy.component_group import ComponentGroup, ComponentType +from ansys.edb.core.hierarchy.group import Group +from ansys.edb.core.hierarchy.inst_array import InstArray +from ansys.edb.core.hierarchy.model import Model +from ansys.edb.core.hierarchy.netlist_model import NetlistModel +from ansys.edb.core.hierarchy.pin_group import PinGroup +from ansys.edb.core.hierarchy.pin_pair_model import PinPairModel +from ansys.edb.core.hierarchy.sparameter_model import SParameterModel +from ansys.edb.core.hierarchy.spice_model import SPICEModel +from ansys.edb.core.hierarchy.structure3d import MeshClosure, Structure3D +from ansys.edb.core.hierarchy.via_group import ViaGroup diff --git a/src/ansys/edb/hierarchy/cell_instance.py b/src/ansys/edb/core/hierarchy/cell_instance.py similarity index 78% rename from src/ansys/edb/hierarchy/cell_instance.py rename to src/ansys/edb/core/hierarchy/cell_instance.py index e59e3a687d..1ed5147b24 100644 --- a/src/ansys/edb/hierarchy/cell_instance.py +++ b/src/ansys/edb/core/hierarchy/cell_instance.py @@ -2,12 +2,12 @@ from ansys.api.edb.v1.cell_instance_pb2_grpc import CellInstanceServiceStub -from ansys.edb import layout -from ansys.edb.core import messages -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.hierarchy import hierarchy_obj -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Transform3D, Value +from ansys.edb.core import layout +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.hierarchy import hierarchy_obj +from ansys.edb.core.inner import messages +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Transform3D, Value class CellInstance(hierarchy_obj.HierarchyObj): @@ -22,11 +22,11 @@ def create(cls, layout, name, ref): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the cell instance. name : str Name of cell instance to be created. - ref : :class:`Layout ` + ref : :class:`Layout ` Layout that the cell instance refers to. Returns @@ -44,11 +44,11 @@ def create_with_component(cls, layout, name, ref): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the cell instance. name : str Name of the cell instance to be created. - ref : :class:`ComponentDef ` + ref : :class:`ComponentDef ` The component this cell instance refers to. Returns @@ -68,7 +68,7 @@ def find(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout to search the cell instance in. name : str Name of the cell instance to be searched. @@ -84,7 +84,7 @@ def find(cls, layout, name): @property def reference_layout(self): - """:class:`Layout `: Reference layout of the cell instance. + """:class:`Layout `: Reference layout of the cell instance. Read-Only. """ @@ -92,12 +92,12 @@ def reference_layout(self): @property def term_instances(self): - """:obj:`list` of :class:`TerminalInstances `: List of terminal \ + """:obj:`list` of :class:`TerminalInstances `: List of terminal \ instances associated with this cell instance. Read-Only. """ - from ansys.edb.terminal import TerminalInstance + from ansys.edb.core.terminal import TerminalInstance terms = self.__stub.GetTermInsts(self.msg).items return [TerminalInstance(ti) for ti in terms] @@ -117,7 +117,8 @@ def placement_3d(self, value): @property def transform3d(self): - """:class:`Transform3D `: 3D transformation information of this cell instance. + """:class:`Transform3D `: \ + 3D transformation information of this cell instance. :obj:`placement_3d` must be True for the transformation to be applied. """ @@ -138,7 +139,7 @@ def get_parameter_override(self, param_name): Returns ------- - :class:`Value ` + :class:`Value ` Override value for the parameter. """ return Value( @@ -152,7 +153,7 @@ def set_parameter_override(self, param_name, param_value): ---------- param_name : str Name of the parameter to override. - param_value : :class:`Value ` + param_value : :class:`Value ` Value to override with. """ self.__stub.SetParameterOverride( diff --git a/src/ansys/edb/hierarchy/component_group.py b/src/ansys/edb/core/hierarchy/component_group.py similarity index 82% rename from src/ansys/edb/hierarchy/component_group.py rename to src/ansys/edb/core/hierarchy/component_group.py index 1e61004ac9..3674f58c8d 100644 --- a/src/ansys/edb/hierarchy/component_group.py +++ b/src/ansys/edb/core/hierarchy/component_group.py @@ -5,10 +5,10 @@ from ansys.api.edb.v1.component_group_pb2_grpc import ComponentGroupServiceStub import ansys.api.edb.v1.edb_defs_pb2 as edb_defs_pb2 -from ansys.edb.core import messages -from ansys.edb.definition import component_property -from ansys.edb.hierarchy.group import Group -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.definition import component_property +from ansys.edb.core.hierarchy.group import Group +from ansys.edb.core.inner import messages +from ansys.edb.core.session import StubAccessor, StubType class ComponentType(Enum): @@ -43,12 +43,12 @@ def create_with_component(cls, layout, name, comp_name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the component group. name : str Name of the component group to be created. comp_name : str - Name of the :class:`ComponentDef ` the component group \ + Name of the :class:`ComponentDef ` the component group \ refers to. Returns @@ -74,9 +74,9 @@ def component_property(self): A copy is returned. Use the setter for any modifications to be reflected. """ - from ansys.edb.definition.ic_component_property import ICComponentProperty - from ansys.edb.definition.io_component_property import IOComponentProperty - from ansys.edb.definition.rlc_component_property import RLCComponentProperty + from ansys.edb.core.definition.ic_component_property import ICComponentProperty + from ansys.edb.core.definition.io_component_property import IOComponentProperty + from ansys.edb.core.definition.rlc_component_property import RLCComponentProperty comp_prop = component_property.ComponentProperty(self.__stub.GetComponentProperty(self.msg)) comp_type = self.__stub.GetComponentType(self.msg).comp_type @@ -116,10 +116,10 @@ def find_by_def(cls, layout, comp_def_name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout to search the component group(s) in. comp_def_name : str - Name of the :class:`ComponentDef `. + Name of the :class:`ComponentDef `. Returns ------- diff --git a/src/ansys/edb/hierarchy/group.py b/src/ansys/edb/core/hierarchy/group.py similarity index 86% rename from src/ansys/edb/hierarchy/group.py rename to src/ansys/edb/core/hierarchy/group.py index fdd4dcb3ed..e842375a4f 100644 --- a/src/ansys/edb/hierarchy/group.py +++ b/src/ansys/edb/core/hierarchy/group.py @@ -3,10 +3,10 @@ from ansys.api.edb.v1.group_pb2 import GroupTypeMessage from ansys.api.edb.v1.group_pb2_grpc import GroupServiceStub -from ansys.edb.core import messages -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.hierarchy.hierarchy_obj import HierarchyObj -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.hierarchy.hierarchy_obj import HierarchyObj +from ansys.edb.core.inner import messages +from ansys.edb.core.session import StubAccessor, StubType class Group(HierarchyObj): @@ -22,7 +22,7 @@ def cast(self): ------- Group """ - from ansys.edb.hierarchy import ComponentGroup, Structure3D, ViaGroup + from ansys.edb.core.hierarchy import ComponentGroup, Structure3D, ViaGroup if self.is_null: return @@ -43,7 +43,7 @@ def create(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the group. name : str Name of group to be created. @@ -61,7 +61,7 @@ def find(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout to search the group in. name : str Name of the group to be searched. @@ -111,7 +111,7 @@ def members(self): Read-Only. """ - from ansys.edb.core import factory + from ansys.edb.core.inner import factory objs = self.__stub.GetMembers(self.msg).items return [factory.create_conn_obj(co) for co in objs] diff --git a/src/ansys/edb/hierarchy/hierarchy_obj.py b/src/ansys/edb/core/hierarchy/hierarchy_obj.py similarity index 70% rename from src/ansys/edb/hierarchy/hierarchy_obj.py rename to src/ansys/edb/core/hierarchy/hierarchy_obj.py index 658cff37c8..6555543f3a 100644 --- a/src/ansys/edb/hierarchy/hierarchy_obj.py +++ b/src/ansys/edb/core/hierarchy/hierarchy_obj.py @@ -1,10 +1,10 @@ """Hierarchy Obj.""" -from ansys.edb.core import conn_obj, messages -from ansys.edb.definition import component_def -from ansys.edb.layer import Layer -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Transform, Value +from ansys.edb.core.definition import component_def +from ansys.edb.core.inner import conn_obj, messages +from ansys.edb.core.layer import Layer +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Transform, Value class HierarchyObj(conn_obj.ConnObj): @@ -14,9 +14,9 @@ class HierarchyObj(conn_obj.ConnObj): @property def transform(self): - """:class:`Transform `: Transformation information of the object.""" + """:class:`Transform `: Transformation information of the object.""" transform_msg = self.__stub.GetTransform(self.msg) - return Transform.create( + return Transform( transform_msg.scale, transform_msg.angle, transform_msg.mirror, @@ -41,7 +41,7 @@ def name(self, value): @property def component_def(self): - """:class:`ComponentDef `: Component definition for this \ + """:class:`ComponentDef `: Component definition for this \ object if it exists, None otherwise. Read-Only. @@ -50,7 +50,7 @@ def component_def(self): @property def placement_layer(self): - """:class:`Layer `: Placement layer for this object.""" + """:class:`Layer `: Placement layer for this object.""" return Layer(self.__stub.GetPlacementLayer(self.msg)).cast() @placement_layer.setter @@ -60,8 +60,9 @@ def placement_layer(self, value): @property def location(self): - """:obj:`tuple` (:class:`Value `, :class:`Value `): \ - [x, y] location of the object on the :obj:`placement_layer`.""" + """:obj:`tuple` (:class:`Value `, \ + :class:`Value `): \ + [x, y] location of the object on the :obj:`placement_layer`.""" pnt_msg = self.__stub.GetLocation(self.msg) return [Value(pnt_msg.x), Value(pnt_msg.y)] @@ -78,9 +79,9 @@ def solve_independent_preference(self): Notes ----- - For a :class:`ComponentModel `, this flag indicates if the + For a :class:`ComponentModel `, this flag indicates if the model is embedded with the field-solver or not, when applicable. - For a :class:`CellInstance `, it indicates if the design's + For a :class:`CellInstance `, it indicates if the design's geometry is flattened/meshed with the parent or not, when applicable. """ return self.__stub.GetSolveIndependentPreference(self.msg).value diff --git a/src/ansys/edb/hierarchy/inst_array.py b/src/ansys/edb/core/hierarchy/inst_array.py similarity index 76% rename from src/ansys/edb/hierarchy/inst_array.py rename to src/ansys/edb/core/hierarchy/inst_array.py index 85ac394ed1..e19872c8de 100644 --- a/src/ansys/edb/hierarchy/inst_array.py +++ b/src/ansys/edb/core/hierarchy/inst_array.py @@ -2,11 +2,11 @@ from ansys.api.edb.v1.inst_array_pb2_grpc import InstArrayServiceStub -from ansys.edb.core import messages, parser -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.hierarchy import cell_instance -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.hierarchy import cell_instance +from ansys.edb.core.inner import messages, parser +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class InstArray(cell_instance.CellInstance): @@ -21,21 +21,21 @@ def create(cls, layout, name, ref, orig, xaxis, yaxis, xcount, ycount): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the instance array. name : str Name of instance array to be created. - ref : :class:`Layout ` + ref : :class:`Layout ` Layout that the instance array refers to. - orig : :class:`PointData ` + orig : :class:`PointData ` PointData that represents the origin of the instance array. - xaxis : :class:`PointData ` + xaxis : :class:`PointData ` PointData that represents the xaxis of the instance array. - yaxis : :class:`PointData ` + yaxis : :class:`PointData ` PointData that represents the yaxis of the instance array. - xcount : :class:`Value ` + xcount : :class:`Value ` Value of x count of the instance array. - ycount : :class:`Value ` + ycount : :class:`Value ` Value of y count of the instance array. Returns @@ -57,7 +57,7 @@ def find(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout to search for the instance array in. name : str Name of the instance array to be searched for. @@ -97,7 +97,7 @@ def y_axis(self, value): @property def x_count(self): - """:class:`Value `: x count of the instance array.""" + """:class:`Value `: x count of the instance array.""" return Value(self.__stub.GetXCount(self.msg)) @x_count.setter @@ -106,7 +106,7 @@ def x_count(self, value): @property def y_count(self): - """:class:`Value `: y count of the instance array.""" + """:class:`Value `: y count of the instance array.""" return Value(self.__stub.GetYCount(self.msg)) @y_count.setter diff --git a/src/ansys/edb/hierarchy/model.py b/src/ansys/edb/core/hierarchy/model.py similarity index 73% rename from src/ansys/edb/hierarchy/model.py rename to src/ansys/edb/core/hierarchy/model.py index 7fe74c7f94..2f4c7b1d1f 100644 --- a/src/ansys/edb/hierarchy/model.py +++ b/src/ansys/edb/core/hierarchy/model.py @@ -1,6 +1,6 @@ """Base Hierarchy Model.""" -from ansys.edb.core import ObjBase, messages -from ansys.edb.session import ModelServiceStub, StubAccessor, StubType +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import ModelServiceStub, StubAccessor, StubType class Model(ObjBase): diff --git a/src/ansys/edb/hierarchy/netlist_model.py b/src/ansys/edb/core/hierarchy/netlist_model.py similarity index 81% rename from src/ansys/edb/hierarchy/netlist_model.py rename to src/ansys/edb/core/hierarchy/netlist_model.py index 82b82117e8..aea495c0ff 100644 --- a/src/ansys/edb/hierarchy/netlist_model.py +++ b/src/ansys/edb/core/hierarchy/netlist_model.py @@ -1,7 +1,7 @@ """Netlist Model.""" -from ansys.edb.core import messages -from ansys.edb.hierarchy.model import Model -from ansys.edb.session import NetlistModelServiceStub, StubAccessor, StubType +from ansys.edb.core.hierarchy.model import Model +from ansys.edb.core.inner import messages +from ansys.edb.core.session import NetlistModelServiceStub, StubAccessor, StubType class NetlistModel(Model): diff --git a/src/ansys/edb/hierarchy/pin_group.py b/src/ansys/edb/core/hierarchy/pin_group.py similarity index 76% rename from src/ansys/edb/hierarchy/pin_group.py rename to src/ansys/edb/core/hierarchy/pin_group.py index 75226c007e..f67501c607 100644 --- a/src/ansys/edb/hierarchy/pin_group.py +++ b/src/ansys/edb/core/hierarchy/pin_group.py @@ -1,9 +1,9 @@ """Pin Group.""" -from ansys.edb.core import ObjBase, messages -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.primitive import PadstackInstance -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.primitive import PadstackInstance +from ansys.edb.core.session import StubAccessor, StubType class PinGroup(ObjBase): @@ -18,11 +18,11 @@ def create(cls, layout, name, padstack_instances): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the pin group. name : str Name of pin group to be created. - padstack_instances : list[:class:`PadstackInstance `] + padstack_instances : list[:class:`PadstackInstance `] Returns ------- @@ -39,7 +39,7 @@ def find(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout to search the pin group in. name : str Name of the pin group. @@ -57,7 +57,7 @@ def unique_name(cls, layout, prefix): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout to search the pin group in. prefix : str Prefix of the unique name. @@ -80,7 +80,8 @@ def name(self): @property def pins(self): - """:obj:`list` of :class:`PadstackInstances `: List of padstack instances. + """:obj:`list` of :class:`PadstackInstances `: \ + List of padstack instances. Read-Only. """ @@ -92,7 +93,7 @@ def add_pins(self, pins): Parameters ---------- - pins : list[:class:`PadstackInstance `] + pins : list[:class:`PadstackInstance `] """ self.__stub.AddPins(messages.pin_group_pins_modify_message(self, pins)) @@ -101,6 +102,6 @@ def remove_pins(self, pins): Parameters ---------- - pins : list[:class:`PadstackInstance `] + pins : list[:class:`PadstackInstance `] """ self.__stub.RemovePins(messages.pin_group_pins_modify_message(self, pins)) diff --git a/src/ansys/edb/hierarchy/pin_pair_model.py b/src/ansys/edb/core/hierarchy/pin_pair_model.py similarity index 84% rename from src/ansys/edb/hierarchy/pin_pair_model.py rename to src/ansys/edb/core/hierarchy/pin_pair_model.py index ec4544b650..9038ea2b84 100644 --- a/src/ansys/edb/hierarchy/pin_pair_model.py +++ b/src/ansys/edb/core/hierarchy/pin_pair_model.py @@ -2,9 +2,9 @@ import google.protobuf.empty_pb2 as empty_pb2 -from ansys.edb.core import messages, parser -from ansys.edb.hierarchy.model import Model -from ansys.edb.session import PinPairModelServiceStub, StubAccessor, StubType +from ansys.edb.core.hierarchy.model import Model +from ansys.edb.core.inner import messages, parser +from ansys.edb.core.session import PinPairModelServiceStub, StubAccessor, StubType class PinPairModel(Model): @@ -31,7 +31,7 @@ def rlc(self, pin_pair): Returns ------- - :class:`Rlc` + :class:`Rlc` """ res = self.__stub.GetRlc(messages.string_pair_property_message(self, pin_pair)) if res.found: @@ -45,7 +45,7 @@ def set_rlc(self, pin_pair, rlc): Parameters ---------- pin_pair : tuple[str, str] - rlc : :class:`Rlc` + rlc : :class:`Rlc` """ self.__stub.SetRlc(messages.pin_pair_model_rlc_message(self, pin_pair, rlc)) diff --git a/src/ansys/edb/hierarchy/sparameter_model.py b/src/ansys/edb/core/hierarchy/sparameter_model.py similarity index 87% rename from src/ansys/edb/hierarchy/sparameter_model.py rename to src/ansys/edb/core/hierarchy/sparameter_model.py index a11ccf97ae..8a9c8d9869 100644 --- a/src/ansys/edb/hierarchy/sparameter_model.py +++ b/src/ansys/edb/core/hierarchy/sparameter_model.py @@ -1,7 +1,7 @@ """S-Parameter Model.""" -from ansys.edb.core import messages -from ansys.edb.hierarchy.model import Model -from ansys.edb.session import SParameterModelServiceStub, StubAccessor, StubType +from ansys.edb.core.hierarchy.model import Model +from ansys.edb.core.inner import messages +from ansys.edb.core.session import SParameterModelServiceStub, StubAccessor, StubType class SParameterModel(Model): diff --git a/src/ansys/edb/hierarchy/spice_model.py b/src/ansys/edb/core/hierarchy/spice_model.py similarity index 92% rename from src/ansys/edb/hierarchy/spice_model.py rename to src/ansys/edb/core/hierarchy/spice_model.py index 6ec3555de4..3822d57aab 100644 --- a/src/ansys/edb/hierarchy/spice_model.py +++ b/src/ansys/edb/core/hierarchy/spice_model.py @@ -1,7 +1,7 @@ """SPICE Model.""" -from ansys.edb.core import messages -from ansys.edb.hierarchy.model import Model -from ansys.edb.session import SpiceModelServiceStub, StubAccessor, StubType +from ansys.edb.core.hierarchy.model import Model +from ansys.edb.core.inner import messages +from ansys.edb.core.session import SpiceModelServiceStub, StubAccessor, StubType class SPICEModel(Model): diff --git a/src/ansys/edb/hierarchy/structure3d.py b/src/ansys/edb/core/hierarchy/structure3d.py similarity index 87% rename from src/ansys/edb/hierarchy/structure3d.py rename to src/ansys/edb/core/hierarchy/structure3d.py index 477b9854c4..60eb3146b5 100644 --- a/src/ansys/edb/hierarchy/structure3d.py +++ b/src/ansys/edb/core/hierarchy/structure3d.py @@ -5,10 +5,10 @@ import ansys.api.edb.v1.structure3d_pb2 as structure3d_pb2 from ansys.api.edb.v1.structure3d_pb2_grpc import Structure3DServiceStub -from ansys.edb.core import messages -from ansys.edb.hierarchy.group import Group -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.hierarchy.group import Group +from ansys.edb.core.inner import messages +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class MeshClosure(Enum): @@ -37,7 +37,7 @@ def create(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the structure3d. name : str Name of the structure3d object. @@ -74,7 +74,7 @@ def set_material(self, mat_name): @property def thickness(self): - """:class:`Value `: Thickness for the structure3d.""" + """:class:`Value `: Thickness for the structure3d.""" return Value(self.__stub.GetThickness(self.msg)) @thickness.setter diff --git a/src/ansys/edb/hierarchy/via_group.py b/src/ansys/edb/core/hierarchy/via_group.py similarity index 77% rename from src/ansys/edb/hierarchy/via_group.py rename to src/ansys/edb/core/hierarchy/via_group.py index ba4e729d1e..cc7df6aed2 100644 --- a/src/ansys/edb/hierarchy/via_group.py +++ b/src/ansys/edb/core/hierarchy/via_group.py @@ -2,9 +2,9 @@ from ansys.api.edb.v1.via_group_pb2_grpc import ViaGroupServiceStub -from ansys.edb.core import messages, parser -from ansys.edb.hierarchy.group import Group -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.hierarchy.group import Group +from ansys.edb.core.inner import messages, parser +from ansys.edb.core.session import StubAccessor, StubType class ViaGroup(Group): @@ -18,9 +18,9 @@ def create_with_primitives(cls, layout, primitives, is_persistent): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the via group. - primitives : list[:class:`Primitive `] + primitives : list[:class:`Primitive `] List of primitives that will be used to create the via groups. is_persistent : bool Primitives are preserved during via group creation if True, deleted otherwise. @@ -41,15 +41,15 @@ def create_with_outline(cls, layout, outline, conductivity_ratio, layer, net=Non Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout that owns the via group. - outline : list[:class:`Point2D `] or \ - list[:class:`PolygonData `] + outline : list[:class:`Point2D `] or \ + list[:class:`PolygonData `] List of primitives that will be used to create the via groups. conductivity_ratio : float - layer : str or :class:`Layer ` + layer : str or :class:`Layer ` Placement layer for the via group. - net : str or :class:`Net `, optional + net : str or :class:`Net `, optional Net the via group should belong to. Returns @@ -71,7 +71,7 @@ def find(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout to search the via group in. name : str Name of the via group. @@ -86,7 +86,7 @@ def find(cls, layout, name): @property @parser.to_polygon_data def outline(self): - """:class:`PolygonData `: Via group outline. + """:class:`PolygonData `: Via group outline. Read-Only. """ diff --git a/src/ansys/edb/core/inner/__init__.py b/src/ansys/edb/core/inner/__init__.py new file mode 100644 index 0000000000..8d7813dc48 --- /dev/null +++ b/src/ansys/edb/core/inner/__init__.py @@ -0,0 +1,8 @@ +"""This package contains code unavailable to API users.""" + +import logging + +from ansys.edb.core.inner.base import ObjBase, TypeField +from ansys.edb.core.inner.edb_logging import EDBLogger + +LOGGER = EDBLogger(level=logging.DEBUG, to_file=False, to_stdout=True) diff --git a/src/ansys/edb/core/base.py b/src/ansys/edb/core/inner/base.py similarity index 100% rename from src/ansys/edb/core/base.py rename to src/ansys/edb/core/inner/base.py diff --git a/src/ansys/edb/core/conn_obj.py b/src/ansys/edb/core/inner/conn_obj.py similarity index 81% rename from src/ansys/edb/core/conn_obj.py rename to src/ansys/edb/core/inner/conn_obj.py index 3eaf30eb36..87aafe1930 100644 --- a/src/ansys/edb/core/conn_obj.py +++ b/src/ansys/edb/core/inner/conn_obj.py @@ -1,10 +1,10 @@ """ConnObj.""" from ansys.api.edb.v1 import connectable_pb2 -from ansys.edb.core import layout_obj, messages -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.layout import mcad_model as mm -from ansys.edb.session import ConnectableServiceStub, StubAccessor, StubType +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import layout_obj, messages +from ansys.edb.core.layout import mcad_model as mm +from ansys.edb.core.session import ConnectableServiceStub, StubAccessor, StubType class _QueryBuilder: @@ -33,7 +33,7 @@ def _validate_edb_obj_type(cls, edb_obj_msg): """Verify that the object type received from the server matches the object type requested by the client.""" client_obj = cls(edb_obj_msg) if cls.layout_obj_type == LayoutObjType.PRIMITIVE: - import ansys.edb.primitive as primitive + import ansys.edb.core.primitive as primitive def get_client_prim_type_from_class(): if cls == primitive.Circle: @@ -54,7 +54,7 @@ def get_client_prim_type_from_class(): if get_client_prim_type_from_class() == primitive.Primitive(edb_obj_msg).primitive_type: return client_obj elif cls.layout_obj_type == LayoutObjType.TERMINAL: - import ansys.edb.terminal as terminal + import ansys.edb.core.terminal as terminal server_term_type = terminal.Terminal(edb_obj_msg).type if client_obj.type == server_term_type: @@ -69,7 +69,7 @@ def find_by_id(cls, layout, uid): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` The owning Layout. uid : int Database ID @@ -99,15 +99,16 @@ def edb_uid(self): @property def component(self): - """:class:`ComponentGroup `: Component of the :term:`Connectable` object.""" - from ansys.edb.hierarchy import ComponentGroup + """:class:`ComponentGroup `: \ + Component of the :term:`Connectable` object.""" + from ansys.edb.core.hierarchy import ComponentGroup return ComponentGroup(self.__stub.GetComponent(self.msg)) @property def group(self): - """:class:`Group `: Group of the :term:`Connectable` object.""" - from ansys.edb.hierarchy import Group + """:class:`Group `: Group of the :term:`Connectable` object.""" + from ansys.edb.core.hierarchy import Group return Group(self.__stub.GetGroup(self.msg)).cast() @@ -118,11 +119,11 @@ def group(self, group): @property def net(self): - """:class:`Net `: Net of the :term:`Connectable` object. + """:class:`Net `: Net of the :term:`Connectable` object. - This property can be set with :class:`Net `, str, None. + This property can be set with :class:`Net `, str, None. """ - from ansys.edb.net import Net + from ansys.edb.core.net import Net return Net(self.__stub.GetNet(self.msg)) @@ -136,7 +137,7 @@ def create_stride(self): Returns ------- - :class:`McadModel ` + :class:`McadModel ` """ return mm.McadModel.create_stride(connectable=self) @@ -145,7 +146,7 @@ def create_hfss(self): Returns ------- - :class:`McadModel ` + :class:`McadModel ` """ return mm.McadModel.create_hfss(connectable=self) @@ -154,7 +155,7 @@ def create_3d_comp(self): Returns ------- - :class:`McadModel ` + :class:`McadModel ` """ return mm.McadModel.create_3d_comp(connectable=self) diff --git a/src/ansys/edb/core/decorators.py b/src/ansys/edb/core/inner/decorators.py similarity index 100% rename from src/ansys/edb/core/decorators.py rename to src/ansys/edb/core/inner/decorators.py diff --git a/src/ansys/edb/core/edb_logging.py b/src/ansys/edb/core/inner/edb_logging.py similarity index 98% rename from src/ansys/edb/core/edb_logging.py rename to src/ansys/edb/core/inner/edb_logging.py index 8bd32c1d09..b8e5ac49a1 100644 --- a/src/ansys/edb/core/edb_logging.py +++ b/src/ansys/edb/core/inner/edb_logging.py @@ -15,7 +15,7 @@ If you want to use this global logger, you must call at the top of your module: .. code:: - from ansys.edb.utility import EDB_LOG + from ansys.edb.core.utility import EDB_LOG It should be noticed that the default logging level of ``LOG`` is ``ERROR``. To change this and output lower level messages you can use the next snippet: @@ -37,7 +37,7 @@ .. code:: import logging - from ansys.edb.utility import edb_logging + from ansys.edb.core.utility import edb_logging LOGGER = EDBLogger(level=logging.DEBUG, to_file=False, to_stdout=True) LOGGER.debug('This is LOG debug message.') diff --git a/src/ansys/edb/core/exceptions.py b/src/ansys/edb/core/inner/exceptions.py similarity index 100% rename from src/ansys/edb/core/exceptions.py rename to src/ansys/edb/core/inner/exceptions.py diff --git a/src/ansys/edb/core/factory.py b/src/ansys/edb/core/inner/factory.py similarity index 74% rename from src/ansys/edb/core/factory.py rename to src/ansys/edb/core/inner/factory.py index 6b9f20ae93..3fbe560447 100644 --- a/src/ansys/edb/core/factory.py +++ b/src/ansys/edb/core/inner/factory.py @@ -1,11 +1,11 @@ """This module allows for the creating of objects while avoid circular imports.""" -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.hierarchy import CellInstance, Group, PinGroup -import ansys.edb.layout as layout -from ansys.edb.primitive import PadstackInstance, Primitive -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.terminal import Terminal, TerminalInstance +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.hierarchy import CellInstance, Group, PinGroup +import ansys.edb.core.layout as layout +from ansys.edb.core.primitive import PadstackInstance, Primitive +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.terminal import Terminal, TerminalInstance def create_conn_obj(msg): @@ -17,7 +17,7 @@ def create_conn_obj(msg): Returns ------- - ansys.edb.core.ConnObj + ansys.edb.core.inner.ConnObj """ type = LayoutObjType(StubAccessor(StubType.connectable).__get__().GetObjType(msg).type) if type == LayoutObjType.PRIMITIVE: diff --git a/src/ansys/edb/core/interceptors.py b/src/ansys/edb/core/inner/interceptors.py similarity index 95% rename from src/ansys/edb/core/interceptors.py rename to src/ansys/edb/core/inner/interceptors.py index dc099cdc70..58e5ceaf6f 100644 --- a/src/ansys/edb/core/interceptors.py +++ b/src/ansys/edb/core/inner/interceptors.py @@ -5,7 +5,7 @@ from grpc import StatusCode, UnaryUnaryClientInterceptor -from ansys.edb.core.exceptions import EDBSessionException, ErrorCode, InvalidArgumentException +from ansys.edb.core.inner.exceptions import EDBSessionException, ErrorCode, InvalidArgumentException class Interceptor(UnaryUnaryClientInterceptor, metaclass=abc.ABCMeta): diff --git a/src/ansys/edb/core/layout_obj.py b/src/ansys/edb/core/inner/layout_obj.py similarity index 84% rename from src/ansys/edb/core/layout_obj.py rename to src/ansys/edb/core/inner/layout_obj.py index 6b6da16e40..dfe0fb3968 100644 --- a/src/ansys/edb/core/layout_obj.py +++ b/src/ansys/edb/core/inner/layout_obj.py @@ -2,11 +2,11 @@ import ansys.api.edb.v1.layout_obj_pb2 as layout_obj_pb2 -from ansys.edb.core import ObjBase -import ansys.edb.core.messages as messages -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.layout import layout -from ansys.edb.session import LayoutObjServiceStub, StubAccessor, StubType +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import ObjBase +import ansys.edb.core.inner.messages as messages +from ansys.edb.core.layout import layout +from ansys.edb.core.session import LayoutObjServiceStub, StubAccessor, StubType class _QueryBuilder: @@ -44,7 +44,7 @@ class LayoutObj(ObjBase): @property def obj_type(self): - """:class:`LayoutObjType `: Layout object type. + """:class:`LayoutObjType `: Layout object type. Read-Only. """ @@ -52,7 +52,7 @@ def obj_type(self): @property def layout(self): - """:class:`Layout `: Owning layout of the object. + """:class:`Layout `: Owning layout of the object. Read-Only. """ @@ -69,7 +69,7 @@ def get_product_property(self, prod_id, attr_id): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` ID representing a product that supports the EDB. attr_id : int A user-defined id that identifies the string value stored in the property @@ -90,7 +90,7 @@ def set_product_property(self, prod_id, attr_id, prop_value): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` ID representing a product that supports the EDB. attr_id : int A user-defined id that identifies the string value stored in the property @@ -108,7 +108,7 @@ def get_product_property_ids(self, prod_id): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` ID representing a product that supports the EDB. Returns diff --git a/src/ansys/edb/core/messages.py b/src/ansys/edb/core/inner/messages.py similarity index 99% rename from src/ansys/edb/core/messages.py rename to src/ansys/edb/core/inner/messages.py index 19aa07f0c6..9efb80c5a4 100644 --- a/src/ansys/edb/core/messages.py +++ b/src/ansys/edb/core/inner/messages.py @@ -145,9 +145,9 @@ from google.protobuf.empty_pb2 import Empty from google.protobuf.wrappers_pb2 import BoolValue, DoubleValue, FloatValue, Int64Value, StringValue -from ansys.edb import utility -from ansys.edb.simulation_setup import LengthMeshOperation, SkinDepthMeshOperation -from ansys.edb.utility import conversions +from ansys.edb.core import utility +from ansys.edb.core.simulation_setup import LengthMeshOperation, SkinDepthMeshOperation +from ansys.edb.core.utility import conversions def str_message(s: str): diff --git a/src/ansys/edb/core/parser.py b/src/ansys/edb/core/inner/parser.py similarity index 99% rename from src/ansys/edb/core/parser.py rename to src/ansys/edb/core/inner/parser.py index 2f50b08d20..7552f18bdd 100644 --- a/src/ansys/edb/core/parser.py +++ b/src/ansys/edb/core/inner/parser.py @@ -2,7 +2,7 @@ import functools -from ansys.edb import geometry, simulation_setup, utility +from ansys.edb.core import geometry, simulation_setup, utility def to_point_data(fn): diff --git a/src/ansys/edb/core/utils.py b/src/ansys/edb/core/inner/utils.py similarity index 100% rename from src/ansys/edb/core/utils.py rename to src/ansys/edb/core/inner/utils.py diff --git a/src/ansys/edb/core/variable_server.py b/src/ansys/edb/core/inner/variable_server.py similarity index 79% rename from src/ansys/edb/core/variable_server.py rename to src/ansys/edb/core/inner/variable_server.py index 44d4b6afe6..c7994c98a7 100644 --- a/src/ansys/edb/core/variable_server.py +++ b/src/ansys/edb/core/inner/variable_server.py @@ -3,9 +3,9 @@ from ansys.api.edb.v1.edb_messages_pb2 import EDBObjMessage import ansys.api.edb.v1.variable_server_pb2 as variable_server_msgs -from ansys.edb.core.messages import value_message -from ansys.edb.session import get_variable_server_stub -from ansys.edb.utility import Value +from ansys.edb.core.inner.messages import value_message +from ansys.edb.core.session import get_variable_server_stub +from ansys.edb.core.utility import Value class VariableServer: @@ -32,8 +32,8 @@ def add_variable(self, name, value, is_param=False): ---------- name : str Variable name - value : str, int, float, complex, :class:`Value ` - value can be any type that can be converted to a :class:`Value ` + value : str, int, float, complex, :class:`Value ` + value can be any type that can be converted to a :class:`Value ` is_param : bool, optional True means the new variable is a parameter, False means it is a local variable @@ -41,11 +41,11 @@ def add_variable(self, name, value, is_param=False): ----- Variables can be added to the following EDB objects - * :class:`Database `. Variable names must begin with a '$' - * :class:`ComponentDef ` - * :class:`Cell ` - * :class:`Layout ` -- adds variable - to corresponding :class:`Cell ` + * :class:`Database `. Variable names must begin with a '$' + * :class:`ComponentDef ` + * :class:`Cell ` + * :class:`Layout ` -- adds variable + to corresponding :class:`Cell ` Examples -------- @@ -73,8 +73,8 @@ def add_menu_variable(self, name, values, is_param=False, index=0): ---------- name : str Variable name - values : list[str, int, float, complex, :class:`Value `] - each element can be any type that can be converted to a :class:`Value ` + values : list[str, int, float, complex, :class:`Value `] + each element can be any type that can be converted to a :class:`Value ` is_param : bool, optional True means the new variable is a parameter, False means it is a local variable index : int, optional @@ -113,7 +113,7 @@ def set_variable_value(self, name, new_value): ---------- name : str Variable name - new_value : str, int, float, complex, :class:`Value ` + new_value : str, int, float, complex, :class:`Value ` """ temp = variable_server_msgs.SetVariableMessage( variable_owner=self.variable_owner, name=name, value=value_message(new_value) @@ -130,7 +130,7 @@ def get_variable_value(self, name): Returns ------- - :class:`Value ` + :class:`Value ` """ temp = variable_server_msgs.VariableNameMessage( variable_owner=self.variable_owner, name=name @@ -199,29 +199,29 @@ def set_variable_desc(self, name, desc): get_variable_server_stub().SetVariableDesc(temp) def create_value(self, val): - """Create a :class:`Value ` that can reference variables in this VariableServer. + """Create a :class:`Value ` that can reference variables in this VariableServer. Parameters ---------- val : str, int, float, complex - val can be any type that can be converted to a :class:`Value ` + val can be any type that can be converted to a :class:`Value ` Returns ------- - :class:`Value ` + :class:`Value ` Notes ----- - Creating a value from a :class:`Database ` can reference variables in the - :class:`Database `. + Creating a value from a :class:`Database ` can reference variables in the + :class:`Database `. - Creating a value from a :class:`Cell ` can reference variables in both the - :class:`Database ` and the :class:`Cell `. + Creating a value from a :class:`Cell ` can reference variables in both the + :class:`Database ` and the :class:`Cell `. - Creating a value from a :class:`ComponentDef ` can reference variables - in both the :class:`Database ` and - the :class:`ComponentDef `. + Creating a value from a :class:`ComponentDef ` can reference variables + in both the :class:`Database ` and + the :class:`ComponentDef `. """ if isinstance(val, str): return Value(val, self) diff --git a/src/ansys/edb/core/layer/__init__.py b/src/ansys/edb/core/layer/__init__.py new file mode 100644 index 0000000000..b8eede3128 --- /dev/null +++ b/src/ansys/edb/core/layer/__init__.py @@ -0,0 +1,17 @@ +"""Import layer classes.""" + +from ansys.edb.core.layer.layer import ( + DrawOverride, + Layer, + LayerType, + LayerVisibility, + TopBottomAssociation, +) +from ansys.edb.core.layer.layer_collection import ( + DielectricMergingMethod, + LayerCollection, + LayerCollectionMode, + LayerTypeSet, +) +from ansys.edb.core.layer.stackup_layer import DCThicknessType, RoughnessRegion, StackupLayer +from ansys.edb.core.layer.via_layer import ViaLayer diff --git a/src/ansys/edb/layer/layer.py b/src/ansys/edb/core/layer/layer.py similarity index 95% rename from src/ansys/edb/layer/layer.py rename to src/ansys/edb/core/layer/layer.py index c7f0d65d57..b7d279c490 100644 --- a/src/ansys/edb/layer/layer.py +++ b/src/ansys/edb/core/layer/layer.py @@ -5,14 +5,14 @@ import ansys.api.edb.v1.layer_pb2 as layer_pb2 from ansys.api.edb.v1.layer_pb2_grpc import LayerServiceStub -from ansys.edb.core import ObjBase -from ansys.edb.core.messages import ( +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import ObjBase +from ansys.edb.core.inner.messages import ( get_product_property_ids_message, get_product_property_message, set_product_property_message, ) -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.session import StubAccessor, StubType # Message creation helper method @@ -129,7 +129,7 @@ def cast(self): ------- Layer """ - from ansys.edb.layer import StackupLayer, ViaLayer + from ansys.edb.core.layer import StackupLayer, ViaLayer lyr = Layer(self.msg) if lyr.is_stackup_layer: @@ -308,7 +308,7 @@ def get_product_property(self, prod_id, attr_it): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` attr_it : int Returns @@ -324,7 +324,7 @@ def set_product_property(self, prod_id, attr_it, prop_value): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` attr_it : int prop_value : str """ @@ -337,7 +337,7 @@ def get_product_property_ids(self, prod_id): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` Returns ------- diff --git a/src/ansys/edb/layer/layer_collection.py b/src/ansys/edb/core/layer/layer_collection.py similarity index 96% rename from src/ansys/edb/layer/layer_collection.py rename to src/ansys/edb/core/layer/layer_collection.py index 9ed3a1351a..8f9600c3dc 100644 --- a/src/ansys/edb/layer/layer_collection.py +++ b/src/ansys/edb/core/layer/layer_collection.py @@ -4,15 +4,15 @@ import ansys.api.edb.v1.layer_collection_pb2 as layer_collection_pb2 -from ansys.edb.core import ObjBase -from ansys.edb.core.messages import ( +from ansys.edb.core.inner import ObjBase +from ansys.edb.core.inner.messages import ( get_product_property_ids_message, get_product_property_message, set_product_property_message, ) -from ansys.edb.layer.layer import Layer, LayerType -from ansys.edb.layer.stackup_layer import StackupLayer -from ansys.edb.session import get_layer_collection_stub +from ansys.edb.core.layer.layer import Layer, LayerType +from ansys.edb.core.layer.stackup_layer import StackupLayer +from ansys.edb.core.session import get_layer_collection_stub class LayerCollectionMode(Enum): @@ -367,7 +367,7 @@ def get_product_property(self, prod_id, attr_it): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` attr_it : int Returns @@ -385,7 +385,7 @@ def set_product_property(self, prod_id, attr_it, prop_value): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` attr_it : int prop_value : str """ @@ -398,7 +398,7 @@ def get_product_property_ids(self, prod_id): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` Returns ------- @@ -424,7 +424,7 @@ def merge_dielectrics( Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` start_layer_name : str end_layer_name : str merging_method : DielectricMergingMethod @@ -523,7 +523,7 @@ def simplify_dielectrics_for_phi( Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` layer_thickness_thresh : float merging_method : DielectricMergingMethod diff --git a/src/ansys/edb/layer/stackup_layer.py b/src/ansys/edb/core/layer/stackup_layer.py similarity index 94% rename from src/ansys/edb/layer/stackup_layer.py rename to src/ansys/edb/core/layer/stackup_layer.py index 41c2366291..cdabb858b7 100644 --- a/src/ansys/edb/layer/stackup_layer.py +++ b/src/ansys/edb/core/layer/stackup_layer.py @@ -4,10 +4,10 @@ import ansys.api.edb.v1.stackup_layer_pb2 as stackup_layer_pb2 -from ansys.edb.core import messages -from ansys.edb.layer import Layer -from ansys.edb.session import get_stackup_layer_stub -from ansys.edb.utility import Value +from ansys.edb.core.inner import messages +from ansys.edb.core.layer import Layer +from ansys.edb.core.session import get_stackup_layer_stub +from ansys.edb.core.utility import Value class DCThicknessType(Enum): @@ -105,7 +105,7 @@ def negative(self, is_negative): @property def thickness(self): - """:class:`Value `: Thickness value of the layer. + """:class:`Value `: Thickness value of the layer. Setter accepts a :term:`ValueLike` """ @@ -117,7 +117,7 @@ def thickness(self, thickness): @property def lower_elevation(self): - """:class:`Value `: Lower elevation value of the layer. + """:class:`Value `: Lower elevation value of the layer. Setter accepts a :term:`ValueLike` """ @@ -131,7 +131,7 @@ def lower_elevation(self, lower_elevation): @property def upper_elevation(self): - """:class:`Value `: Upper elevation value of the layer. + """:class:`Value `: Upper elevation value of the layer. Read-Only. """ @@ -257,7 +257,7 @@ def etch_factor_enabled(self, enable_etch_factor): @property def etch_factor(self): - """:class:`Value `: Etch factor of the layer. + """:class:`Value `: Etch factor of the layer. Setter accepts a :term:`ValueLike` """ @@ -274,7 +274,6 @@ def use_solver_properties(self): @use_solver_properties.setter def use_solver_properties(self, use_solver_properties): - get_stackup_layer_stub().SetUseSolverProperties( stackup_layer_pb2.SetLayerPropEnabledMessage( layer=self.msg, enabled=use_solver_properties diff --git a/src/ansys/edb/layer/via_layer.py b/src/ansys/edb/core/layer/via_layer.py similarity index 95% rename from src/ansys/edb/layer/via_layer.py rename to src/ansys/edb/core/layer/via_layer.py index a7c5ea7f10..c0276b8e9b 100644 --- a/src/ansys/edb/layer/via_layer.py +++ b/src/ansys/edb/core/layer/via_layer.py @@ -2,8 +2,8 @@ import ansys.api.edb.v1.via_layer_pb2 as via_layer_pb2 -from ansys.edb.layer import StackupLayer -from ansys.edb.session import get_via_layer_stub +from ansys.edb.core.layer import StackupLayer +from ansys.edb.core.session import get_via_layer_stub def _via_lyr_ref_lyr_id_msg(lyr, is_upper_ref): diff --git a/src/ansys/edb/core/layout/__init__.py b/src/ansys/edb/core/layout/__init__.py new file mode 100644 index 0000000000..8852859c66 --- /dev/null +++ b/src/ansys/edb/core/layout/__init__.py @@ -0,0 +1,6 @@ +"""Import layout classes.""" + +from ansys.edb.core.layout.cell import Cell, CellType, DesignMode +from ansys.edb.core.layout.layout import Layout +from ansys.edb.core.layout.mcad_model import McadModel +from ansys.edb.core.layout.voltage_regulator import PowerModule, VoltageRegulator diff --git a/src/ansys/edb/layout/cell.py b/src/ansys/edb/core/layout/cell.py similarity index 86% rename from src/ansys/edb/layout/cell.py rename to src/ansys/edb/core/layout/cell.py index a4ea0db013..41973f47c1 100644 --- a/src/ansys/edb/layout/cell.py +++ b/src/ansys/edb/core/layout/cell.py @@ -6,14 +6,14 @@ from ansys.api.edb.v1.cell_pb2_grpc import CellServiceStub import ansys.api.edb.v1.edb_defs_pb2 as edb_defs_pb2 -from ansys.edb.core import ObjBase, messages, variable_server -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.layout import layout -from ansys.edb.primitive import Primitive -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.simulation_setup import SimulationSetup -from ansys.edb.utility import TemperatureSettings, Value -from ansys.edb.utility.hfss_extent_info import HfssExtentInfo +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import ObjBase, messages, variable_server +from ansys.edb.core.layout import layout +from ansys.edb.core.primitive import Primitive +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.simulation_setup import SimulationSetup +from ansys.edb.core.utility import TemperatureSettings, Value +from ansys.edb.core.utility.hfss_extent_info import HfssExtentInfo class CellType(Enum): @@ -163,7 +163,7 @@ def create(cls, db, cell_type, cell_name): Parameters ---------- - db : :class:`Database ` + db : :class:`Database ` Database to create the cell in. cell_type : CellType Type of the cell to create. @@ -179,7 +179,7 @@ def create(cls, db, cell_type, cell_name): @property def layout(self): - """:class:`Layout `: Layout of the cell. + """:class:`Layout `: Layout of the cell. Read-Only. """ @@ -187,7 +187,7 @@ def layout(self): @property def flattened_layout(self): - """:class:`Layout `: Flattened layout of the cell. + """:class:`Layout `: Flattened layout of the cell. Read-Only. """ @@ -199,7 +199,7 @@ def find(cls, database, cell_type, name=None, cell_id=None): Parameters ---------- - database : :class:`Database ` + database : :class:`Database ` Database to search for the cell in. cell_type : CellType Type of the cell to create. @@ -222,11 +222,11 @@ def delete(self): @property def database(self): - """:class:`Database `: Owning database of cell. + """:class:`Database `: Owning database of cell. Read-Only. """ - from ansys.edb.database import Database + from ansys.edb.core.database import Database return Database(self.__stub.GetDatabase(self.msg)) @@ -302,7 +302,7 @@ def design_mode(self, value): @property def hfss_extent_info(self): - """:class: HfssExtentInfo : HFSS Extents for the cell.""" + """:class: HfssExtentInfo : HFSS Extents for the cell.""" msg = self.__stub.GetHfssExtentInfo(self.msg) return HfssExtentInfo(**parse_args(msg)) @@ -311,13 +311,13 @@ def set_hfss_extent_info(self, extents): Parameters ---------- - extents : :class: HfssExtentInfo + extents : :class: HfssExtentInfo """ self.__stub.SetHfssExtentInfo(_QueryBuilder.set_hfss_extents(self, extents)) @property def temperature_settings(self): - """:class:`TemperatureSettings ` :Temperature settings.""" + """:class:`TemperatureSettings ` :Temperature settings.""" msg = self.__stub.GetTemperatureSettings(self.msg) return TemperatureSettings( msg.include_temp_dependence, msg.enable_thermal_feedback, Value(msg.temperature) @@ -334,11 +334,11 @@ def cutout(self, included_nets, clipped_nets, clipping_polygon, clean_clipping=T Parameters ---------- - included_nets : list[:class:`Net `] + included_nets : list[:class:`Net `] Nets to be kept after cutout. - clipped_nets : list[:class:`Net `] + clipped_nets : list[:class:`Net `] Nets to be kept and clipped at the boundary after cutout. - clipping_polygon : :class:`PolygonData ` + clipping_polygon : :class:`PolygonData ` Clipping polygon. clean_clipping : bool, optional Whether to perform clean clipping. @@ -361,7 +361,7 @@ def get_product_property_ids(self, prod_id): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` ID representing a product that supports the EDB. Returns @@ -379,7 +379,7 @@ def get_product_property(self, prod_id, attr_id): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` ID representing a product that supports the EDB. attr_id : int A user-defined id that identifies the string value stored in the property. @@ -398,7 +398,7 @@ def set_product_property(self, prod_id, attr_id, prop_value): Parameters ---------- - prod_id : :class:`ProductIdType ` + prod_id : :class:`ProductIdType ` ID representing a product that supports the EDB. attr_id : int A user-defined id that identifies the string value stored in the property. @@ -427,7 +427,7 @@ def simulation_setups(self): Returns ------- - list[:class:`SimulationSetup `] + list[:class:`SimulationSetup `] """ return [ SimulationSetup(msg).cast() for msg in self.__stub.GetSimulationSetups(self.msg).items @@ -448,11 +448,11 @@ def generate_via_smart_box(self, net_name): Parameters ---------- net_name : str - Name of the :class:`Net ` to be crawled in the search for vias. + Name of the :class:`Net ` to be crawled in the search for vias. Returns ------- - list[:class:`PolygonData `] + list[:class:`PolygonData `] A list of boxes; one around each via discovered. """ self.__stub.GenerateViaSmartBox(messages.string_property_message(self, net_name)) diff --git a/src/ansys/edb/layout/layout.py b/src/ansys/edb/core/layout/layout.py similarity index 70% rename from src/ansys/edb/layout/layout.py rename to src/ansys/edb/core/layout/layout.py index c2cba2656b..795fc9e5f9 100644 --- a/src/ansys/edb/layout/layout.py +++ b/src/ansys/edb/core/layout/layout.py @@ -3,17 +3,17 @@ from ansys.api.edb.v1 import layout_pb2 from ansys.api.edb.v1.layout_pb2_grpc import LayoutServiceStub -from ansys.edb.core import ObjBase, messages, parser, utils, variable_server -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.hierarchy import CellInstance, Group, PinGroup -from ansys.edb.layer import LayerCollection -import ansys.edb.layout as layout -from ansys.edb.layout.mcad_model import McadModel -from ansys.edb.layout_instance import LayoutInstance -from ansys.edb.net import DifferentialPair, ExtendedNet, Net, NetClass -from ansys.edb.primitive import BoardBendDef, PadstackInstance, Primitive -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.terminal import Terminal +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.hierarchy import CellInstance, Group, PinGroup +from ansys.edb.core.inner import ObjBase, messages, parser, utils, variable_server +from ansys.edb.core.layer import LayerCollection +import ansys.edb.core.layout as layout +from ansys.edb.core.layout.mcad_model import McadModel +from ansys.edb.core.layout_instance import LayoutInstance +from ansys.edb.core.net import DifferentialPair, ExtendedNet, Net, NetClass +from ansys.edb.core.primitive import BoardBendDef, PadstackInstance, Primitive +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.terminal import Terminal class Layout(ObjBase, variable_server.VariableServer): @@ -33,17 +33,17 @@ def __init__(self, msg): @property def cell(self): - """:class:`Cell `: Owning cell for this layout. + """:class:`Cell `: Owning cell for this layout. Read-Only. """ - from ansys.edb.layout.cell import Cell + from ansys.edb.core.layout.cell import Cell return Cell(self.__stub.GetCell(self.msg)) @property def layer_collection(self): - """:class:`LayerCollection ` : Layer collection of this layout.""" + """:class:`LayerCollection ` : Layer collection of this layout.""" return LayerCollection(self.__stub.GetLayerCollection(self.msg)) @layer_collection.setter @@ -65,7 +65,7 @@ def _get_items(self, obj_type, lyt_obj_type_enum, do_cast=False): @property def primitives(self): - """:obj:`list` of :class:`Primitive ` : List of all the primitives in this \ + """:obj:`list` of :class:`Primitive ` : List of all the primitives in this \ layout. Read-Only. @@ -74,7 +74,7 @@ def primitives(self): @property def padstack_instances(self): - """:obj:`list` of :class:`PadstackInstance ` : List of all padstack \ + """:obj:`list` of :class:`PadstackInstance ` : List of all padstack \ instances in this layout. Read-Only. @@ -83,7 +83,8 @@ def padstack_instances(self): @property def terminals(self): - """:obj:`list` of :class:`Terminal ` : List of all the terminals in this layout. + """:obj:`list` of :class:`Terminal ` : \ + List of all the terminals in this layout. Read-Only. """ @@ -91,8 +92,8 @@ def terminals(self): @property def cell_instances(self): - """:obj:`list` of :class:`CellInstance ` : List of the cell instances in \ - this layout. + """:obj:`list` of :class:`CellInstance ` : \ + List of the cell instances in this layout. Read-Only. """ @@ -100,7 +101,7 @@ def cell_instances(self): @property def nets(self): - """:obj:`list` of :class:`Net ` : List of all the nets in this layout. + """:obj:`list` of :class:`Net ` : List of all the nets in this layout. Read-Only. """ @@ -108,7 +109,7 @@ def nets(self): @property def groups(self): - """:obj:`list` of :class:`Group ` : List of all the groups in this layout. + """:obj:`list` of :class:`Group ` : List of all the groups in this layout. Read-Only. """ @@ -116,7 +117,7 @@ def groups(self): @property def net_classes(self): - """:obj:`list` of :class:`NetClass ` : List of all the netclassses in this layout. + """:obj:`list` of :class:`NetClass ` : List of all the netclassses in this layout. Read-Only. """ @@ -124,8 +125,8 @@ def net_classes(self): @property def differential_pairs(self): - """:obj:`list` of :class:`DifferentialPair ` : List of all the differential \ - pairs in this layout. + """:obj:`list` of :class:`DifferentialPair ` : \ + List of all the differential pairs in this layout. Read-Only. """ @@ -133,7 +134,7 @@ def differential_pairs(self): @property def pin_groups(self): - """:obj:`list` of :class:`PinGroup ` : List of all the pin groups in this \ + """:obj:`list` of :class:`PinGroup ` : List of all the pin groups in this \ layout. Read-Only. @@ -142,8 +143,8 @@ def pin_groups(self): @property def voltage_regulators(self): - """:obj:`list` of :class:`VoltageRegulator ` : List of all the voltage \ - regulators in this layout. + """:obj:`list` of :class:`VoltageRegulator ` : \ + List of all the voltage regulators in this layout. Read-Only. """ @@ -151,8 +152,8 @@ def voltage_regulators(self): @property def extended_nets(self): - """:obj:`list` of :class:`ExtendedNet ` : List of all the extended nets in this \ - layout. + """:obj:`list` of :class:`ExtendedNet ` : \ + List of all the extended nets in this layout. Read-Only. """ @@ -166,9 +167,9 @@ def expanded_extent( Parameters ---------- - nets : list[:class:`Net `] + nets : list[:class:`Net `] A list of nets. - extent : :class:`ExtentType ` + extent : :class:`ExtentType ` Geometry extent type for expansion. expansion_factor : float Expansion factor for the polygon union. No expansion occurs if the `expansion_factor` is less than or \ @@ -184,7 +185,7 @@ def expanded_extent( Returns ------- - :class:`PolygonData ` + :class:`PolygonData ` Notes ----- @@ -207,7 +208,7 @@ def convert_primitives_to_vias(self, primitives, is_pins=False): Parameters ---------- - primitives : list[:class:`Primitive `] + primitives : list[:class:`Primitive `] List of primitives to convert. is_pins : bool, optional True for pins, false for vias (default). @@ -227,7 +228,7 @@ def port_reference_terminals_connected(self): @property def zone_primitives(self): - """:obj:`list` of :class:`Primitive ` : List of all the primitives in \ + """:obj:`list` of :class:`Primitive ` : List of all the primitives in \ :term:`zones `. Read-Only. @@ -236,7 +237,7 @@ def zone_primitives(self): @property def fixed_zone_primitive(self): - """:class:`Primitive ` : Fixed :term:`zones ` primitive.""" + """:class:`Primitive ` : Fixed :term:`zones ` primitive.""" msg = self.__stub.GetFixedZonePrimitive(self.msg) return None if msg is None else Primitive(msg).cast() @@ -246,7 +247,7 @@ def fixed_zone_primitive(self, value): @property def board_bend_defs(self): - """:obj:`list` of :class:`BoardBendDef ` : List of all the board bend \ + """:obj:`list` of :class:`BoardBendDef ` : List of all the board bend \ definitions in this layout. Read-Only. @@ -259,7 +260,7 @@ def synchronize_bend_manager(self): @property def layout_instance(self): - """:class:`LayoutInstance ` : Layout instance of this layout. + """:class:`LayoutInstance ` : Layout instance of this layout. Read-Only. """ diff --git a/src/ansys/edb/layout/mcad_model.py b/src/ansys/edb/core/layout/mcad_model.py similarity index 88% rename from src/ansys/edb/layout/mcad_model.py rename to src/ansys/edb/core/layout/mcad_model.py index 69284059fc..3940072040 100644 --- a/src/ansys/edb/layout/mcad_model.py +++ b/src/ansys/edb/core/layout/mcad_model.py @@ -1,8 +1,8 @@ """Mcad Model.""" -from ansys.edb import hierarchy -from ansys.edb.core import ObjBase, messages, parser -from ansys.edb.session import McadModelServiceStub, StubAccessor, StubType +from ansys.edb.core import hierarchy +from ansys.edb.core.inner import ObjBase, messages, parser +from ansys.edb.core.session import McadModelServiceStub, StubAccessor, StubType class McadModel(ObjBase): @@ -14,7 +14,7 @@ class McadModel(ObjBase): def create_stride(cls, connectable=None, layout=None, filename=None): """Create a Stride model. - call directly on :term:`Connectable` or :func:`Layout`. + call directly on :term:`Connectable` or :func:`Layout`. """ return cls( cls.__stub.CreateStride( @@ -26,7 +26,7 @@ def create_stride(cls, connectable=None, layout=None, filename=None): def create_hfss(cls, connectable=None, layout=None, filename=None, design=None): """Create a HFSS model. - call directly on :term:`Connectable` or :func:`Layout`. + call directly on :term:`Connectable` or :func:`Layout`. """ return cls( cls.__stub.CreateHfss( @@ -38,7 +38,7 @@ def create_hfss(cls, connectable=None, layout=None, filename=None, design=None): def create_3d_comp(cls, connectable=None, layout=None, filename=None): """Create a 3D Component model. - call directly on :term:`Connectable` or :func:`Layout`. + call directly on :term:`Connectable` or :func:`Layout`. """ return cls( cls.__stub.Create3dComp( @@ -80,7 +80,7 @@ def is_mcad_3d_comp(cls, connectable): @property def cell_instance(self): - """:class:`CellInstance ` Cell instance of a Mcad model. + """:class:`CellInstance ` Cell instance of a Mcad model. Read-Only. """ @@ -104,7 +104,7 @@ def design_name(self): @property def origin(self): - """:class:`Point3DData ` Origin 3D point of a Mcad model.""" + """:class:`Point3DData ` Origin 3D point of a Mcad model.""" return self.__stub.GetOrigin(messages.edb_obj_message(self)) @origin.setter @@ -113,7 +113,7 @@ def origin(self, pnt): @property def rotation(self): - r""":obj:`tuple`\[:class:`Point3DData `, :class:`Point3DData `, :obj:`float`\] Rotation from/to axis and angle.""" # noqa + r""":obj:`tuple`\[:class:`Point3DData `, :class:`Point3DData `, :obj:`float`\] Rotation from/to axis and angle.""" # noqa msg = self.__stub.GetRotation(messages.edb_obj_message(self)) return ( parser.to_point3d_data(msg.axis_from), @@ -130,8 +130,8 @@ def set_rotation(self, axis_from, axis_to, angle): Parameters ---------- - axis_from : :class:`Point3DData ` - axis_to : :class:`Point3DData ` + axis_from : :class:`Point3DData ` + axis_to : :class:`Point3DData ` angle : float """ self.__stub.SetRotation( diff --git a/src/ansys/edb/layout/voltage_regulator.py b/src/ansys/edb/core/layout/voltage_regulator.py similarity index 90% rename from src/ansys/edb/layout/voltage_regulator.py rename to src/ansys/edb/core/layout/voltage_regulator.py index a2d0d10003..1ca7c8bbb3 100644 --- a/src/ansys/edb/layout/voltage_regulator.py +++ b/src/ansys/edb/core/layout/voltage_regulator.py @@ -1,11 +1,11 @@ """Voltage regulator.""" import ansys.api.edb.v1.voltage_regulator_pb2 as vr_pb2 -from ansys.edb.core import conn_obj, messages -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.primitive import PadstackInstance -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import conn_obj, messages +from ansys.edb.core.primitive import PadstackInstance +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value class PowerModule: @@ -19,7 +19,7 @@ class PowerModule: Name of the Positive Output Terminal. neg_output_terminal : str Name of the Negative Output Terminal - relative_strength : :class:`Value ` + relative_strength : :class:`Value ` Relative strength in % active : bool True if active @@ -70,7 +70,7 @@ def neg_output_terminal(self, neg_output_terminal): @property def relative_strength(self): - """:class:`Value ` : Relative Strength for this Power Module in percent. + """:class:`Value ` : Relative Strength for this Power Module in percent. Property can be set with :term:`ValueLike` """ @@ -129,7 +129,7 @@ def create(cls, layout, name, active, voltage, lrc, lrp): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout the voltage regulator will be in. name : str The name of the voltage regulator. @@ -180,7 +180,7 @@ def active(self, newactive): @property def voltage(self): - """:class:`Value `: Voltage of the Voltage Regulator. + """:class:`Value `: Voltage of the Voltage Regulator. Property can be set with :term:`ValueLike` """ @@ -194,7 +194,7 @@ def voltage(self, newvoltage): @property def lrc(self): - """:class:`Value `: Load regulation current of the Voltage Regulator. + """:class:`Value `: Load regulation current of the Voltage Regulator. Property can be set with :term:`ValueLike` """ @@ -208,7 +208,7 @@ def lrc(self, newlrc): @property def lrp(self): - """:class:`Value `: Load regulation percent of the Voltage Regulator. + """:class:`Value `: Load regulation percent of the Voltage Regulator. Property can be set with :term:`ValueLike` """ @@ -222,7 +222,7 @@ def lrp(self, newlrp): @property def pos_remote_sense_pin(self): - """:class:`PadstackInstance `: Positive remote sense pin of the \ + """:class:`PadstackInstance `: Positive remote sense pin of the \ Voltage Regulator. .. seealso:: :obj:`neg_remote_sense_pin` @@ -235,7 +235,7 @@ def pos_remote_sense_pin(self, newpin): @property def neg_remote_sense_pin(self): - """:class:`PadstackInstance `: Negative remote sense pin of the \ + """:class:`PadstackInstance `: Negative remote sense pin of the \ Voltage Regulator. .. seealso:: :obj:`pos_remote_sense_pin` diff --git a/src/ansys/edb/core/layout_instance/__init__.py b/src/ansys/edb/core/layout_instance/__init__.py new file mode 100644 index 0000000000..2305ce4f8d --- /dev/null +++ b/src/ansys/edb/core/layout_instance/__init__.py @@ -0,0 +1,12 @@ +"""Import layout instance classes.""" + +from ansys.edb.core.layout_instance.layout_instance import LayoutInstance +from ansys.edb.core.layout_instance.layout_instance_context import LayoutInstanceContext +from ansys.edb.core.layout_instance.layout_obj_instance import LayoutObjInstance +from ansys.edb.core.layout_instance.layout_obj_instance_2d_geometry import ( + LayoutObjInstance2DGeometry, +) +from ansys.edb.core.layout_instance.layout_obj_instance_3d_geometry import ( + LayoutObjInstance3DGeometry, +) +from ansys.edb.core.layout_instance.layout_obj_instance_geometry import LayoutObjInstanceGeometry diff --git a/src/ansys/edb/layout_instance/layout_instance.py b/src/ansys/edb/core/layout_instance/layout_instance.py similarity index 84% rename from src/ansys/edb/layout_instance/layout_instance.py rename to src/ansys/edb/core/layout_instance/layout_instance.py index 4a663cb118..8de05cfb16 100644 --- a/src/ansys/edb/layout_instance/layout_instance.py +++ b/src/ansys/edb/core/layout_instance/layout_instance.py @@ -1,17 +1,17 @@ """Layout Instance.""" import ansys.api.edb.v1.layout_instance_pb2 as layout_instance_pb2 -from ansys.edb.core import ObjBase, utils -from ansys.edb.core.messages import ( +from ansys.edb.core.geometry import PointData +from ansys.edb.core.inner import ObjBase, utils +from ansys.edb.core.inner.messages import ( layer_ref_message, net_ref_message, point_message, polygon_data_message, strings_message, ) -from ansys.edb.geometry import PointData -from ansys.edb.layout_instance.layout_obj_instance import LayoutObjInstance -from ansys.edb.session import LayoutInstanceServiceStub, StubAccessor, StubType +from ansys.edb.core.layout_instance.layout_obj_instance import LayoutObjInstance +from ansys.edb.core.session import LayoutInstanceServiceStub, StubAccessor, StubType class LayoutInstance(ObjBase): @@ -28,12 +28,12 @@ def query_layout_obj_instances(self, layer_filter=None, net_filter=None, spatial Parameters ---------- - layer_filter : list[:class:`Layer ` or str or None], optional + layer_filter : list[:class:`Layer ` or str or None], optional Specifies which layers to query. If :obj:`None`, all layers will be queried. - net_filter : list[:class:`Net ` or str or None], optional + net_filter : list[:class:`Net ` or str or None], optional Specifies which nets to query. If :obj:`None`, all nets will be queried. - spatial_filter : :class:`PolygonData ` or \ - :class:`PointData ` or None, optional + spatial_filter : :class:`PolygonData ` or \ + :class:`PointData ` or None, optional Specifies which area of the design to query. If :obj:`None`, the entire spatial domain of the design will \ be queried. @@ -116,9 +116,9 @@ def get_connected_objects(self, origin_layout_obj_inst, touching_only): from. touching_only : bool If touching_only is true, only :class:`layout object instances ` touching \ - origin_layout_obj_inst on the placement :class:`layer ` of origin_layout_obj_inst \ - will be returned. Otherwise, all layout object instances across all layers that are electrically connected \ - to origin_layout_obj_inst will be returned. + origin_layout_obj_inst on the placement :class:`layer ` of \ + origin_layout_obj_inst will be returned. Otherwise, all layout object instances across all layers that \ + are electrically connected to origin_layout_obj_inst will be returned. Returns ------- diff --git a/src/ansys/edb/layout_instance/layout_instance_context.py b/src/ansys/edb/core/layout_instance/layout_instance_context.py similarity index 85% rename from src/ansys/edb/layout_instance/layout_instance_context.py rename to src/ansys/edb/core/layout_instance/layout_instance_context.py index 363d0711cd..8560c51819 100644 --- a/src/ansys/edb/layout_instance/layout_instance_context.py +++ b/src/ansys/edb/core/layout_instance/layout_instance_context.py @@ -1,9 +1,9 @@ """Layout Instance Context.""" -from ansys.edb.core import ObjBase, parser -from ansys.edb.core.messages import bool_property_message -import ansys.edb.layout as layout -from ansys.edb.session import LayoutInstanceContextServiceStub, StubAccessor, StubType +from ansys.edb.core.inner import ObjBase, parser +from ansys.edb.core.inner.messages import bool_property_message +import ansys.edb.core.layout as layout +from ansys.edb.core.session import LayoutInstanceContextServiceStub, StubAccessor, StubType class LayoutInstanceContext(ObjBase): @@ -13,7 +13,7 @@ class LayoutInstanceContext(ObjBase): @property def layout(self): - """:class:`Layout `: Layout of the context. + """:class:`Layout `: Layout of the context. Read-Only. """ @@ -31,7 +31,7 @@ def get_bbox(self, local): Returns ------- - :class:`PolygonData ` + :class:`PolygonData ` """ return self.__stub.GetBBox(bool_property_message(self, local)) diff --git a/src/ansys/edb/layout_instance/layout_obj_instance.py b/src/ansys/edb/core/layout_instance/layout_obj_instance.py similarity index 65% rename from src/ansys/edb/layout_instance/layout_obj_instance.py rename to src/ansys/edb/core/layout_instance/layout_obj_instance.py index 693788ef61..aae0941ea9 100644 --- a/src/ansys/edb/layout_instance/layout_obj_instance.py +++ b/src/ansys/edb/core/layout_instance/layout_obj_instance.py @@ -1,13 +1,17 @@ """Layout Obj Instance.""" -from ansys.edb.core import ObjBase, parser, utils -from ansys.edb.core.factory import create_conn_obj -from ansys.edb.core.messages import bool_property_message, layer_ref_property_message -from ansys.edb.layer import Layer -from ansys.edb.layout_instance.layout_instance_context import LayoutInstanceContext -from ansys.edb.layout_instance.layout_obj_instance_2d_geometry import LayoutObjInstance2DGeometry -from ansys.edb.layout_instance.layout_obj_instance_3d_geometry import LayoutObjInstance3DGeometry -from ansys.edb.session import LayoutObjInstanceServiceStub, StubAccessor, StubType +from ansys.edb.core.inner import ObjBase, parser, utils +from ansys.edb.core.inner.factory import create_conn_obj +from ansys.edb.core.inner.messages import bool_property_message, layer_ref_property_message +from ansys.edb.core.layer import Layer +from ansys.edb.core.layout_instance.layout_instance_context import LayoutInstanceContext +from ansys.edb.core.layout_instance.layout_obj_instance_2d_geometry import ( + LayoutObjInstance2DGeometry, +) +from ansys.edb.core.layout_instance.layout_obj_instance_3d_geometry import ( + LayoutObjInstance3DGeometry, +) +from ansys.edb.core.session import LayoutObjInstanceServiceStub, StubAccessor, StubType def _parse_layout_obj_instance_geometry_message(lyt_obj_inst_geom_msg): @@ -29,9 +33,14 @@ class LayoutObjInstance(ObjBase): @property def layers(self): - r""":obj:`list`\[:class:`Layer `\]: Layers this layout object instance has geometry on. + """Return a list of Layer instances. - Read-Only. + This list contains the :class:`Layer ` instances that this layout + object instance has geometry on. + + Returns + ------- + list[ansys.edb.core.layer.Layer] """ return [Layer(msg).cast() for msg in self.__stub.GetLayers(self.msg).items] @@ -40,7 +49,7 @@ def get_geometries(self, layer): Parameters ---------- - layer : :class:`Layer ` or str + layer : :class:`Layer ` or str Returns ------- @@ -53,10 +62,10 @@ def get_geometries(self, layer): def context(self): r""":obj:`list`\[:obj:`str`\]: List of strings representing the context of the layout object instance. - The list of strings is a list of :class:`cell instance ` names representing \ - the hierarchy level this layout obj instance's :class:`context ` resides on. The the \ - first entry in the list represents the top level context and the last entry represents the context the layout \ - obj instance exists in. + The list of strings is a list of :class:`cell instance ` names \ + representing the hierarchy level this layout obj instance's :class:`context ` \ + resides on. The the first entry in the list represents the top level context and the last entry \ + represents the context the layout obj instance exists in. Read-Only """ @@ -91,6 +100,6 @@ def get_bbox(self, local=False): Returns ------- - :class:`PolygonData ` + :class:`PolygonData ` """ return self.__stub.GetBBox(bool_property_message(self, local)) diff --git a/src/ansys/edb/layout_instance/layout_obj_instance_2d_geometry.py b/src/ansys/edb/core/layout_instance/layout_obj_instance_2d_geometry.py similarity index 73% rename from src/ansys/edb/layout_instance/layout_obj_instance_2d_geometry.py rename to src/ansys/edb/core/layout_instance/layout_obj_instance_2d_geometry.py index e8fb86658b..afc29ca218 100644 --- a/src/ansys/edb/layout_instance/layout_obj_instance_2d_geometry.py +++ b/src/ansys/edb/core/layout_instance/layout_obj_instance_2d_geometry.py @@ -2,9 +2,9 @@ from ansys.api.edb.v1.layout_obj_instance_2d_geometry_pb2 import GetPolygonDataMessage -from ansys.edb.core.parser import to_polygon_data -from ansys.edb.layout_instance.layout_obj_instance_geometry import LayoutObjInstanceGeometry -from ansys.edb.session import LayoutObjInstance2DGeometryServiceStub, StubAccessor, StubType +from ansys.edb.core.inner.parser import to_polygon_data +from ansys.edb.core.layout_instance.layout_obj_instance_geometry import LayoutObjInstanceGeometry +from ansys.edb.core.session import LayoutObjInstance2DGeometryServiceStub, StubAccessor, StubType class LayoutObjInstance2DGeometry(LayoutObjInstanceGeometry): @@ -28,7 +28,7 @@ def get_polygon_data(self, apply_negatives=False): Returns ------- - :class:`PolygonData ` + :class:`PolygonData ` """ return self.__stub.GetPolygonData( GetPolygonDataMessage(layout_obj_inst_geom=self.msg, apply_neg=apply_negatives) diff --git a/src/ansys/edb/layout_instance/layout_obj_instance_3d_geometry.py b/src/ansys/edb/core/layout_instance/layout_obj_instance_3d_geometry.py similarity index 53% rename from src/ansys/edb/layout_instance/layout_obj_instance_3d_geometry.py rename to src/ansys/edb/core/layout_instance/layout_obj_instance_3d_geometry.py index 1f3fbbf65e..1082a658f1 100644 --- a/src/ansys/edb/layout_instance/layout_obj_instance_3d_geometry.py +++ b/src/ansys/edb/core/layout_instance/layout_obj_instance_3d_geometry.py @@ -1,10 +1,10 @@ """Layout Obj Instance 3D Geometry.""" -from ansys.edb.core import utils -from ansys.edb.core.parser import to_point3d_data -from ansys.edb.geometry import Triangle3DData -from ansys.edb.layout_instance.layout_obj_instance_geometry import LayoutObjInstanceGeometry -from ansys.edb.session import LayoutObjInstance3DGeometryServiceStub, StubAccessor, StubType +from ansys.edb.core.geometry import Triangle3DData +from ansys.edb.core.inner import utils +from ansys.edb.core.inner.parser import to_point3d_data +from ansys.edb.core.layout_instance.layout_obj_instance_geometry import LayoutObjInstanceGeometry +from ansys.edb.core.session import LayoutObjInstance3DGeometryServiceStub, StubAccessor, StubType class LayoutObjInstance3DGeometry(LayoutObjInstanceGeometry): @@ -16,9 +16,14 @@ class LayoutObjInstance3DGeometry(LayoutObjInstanceGeometry): @property def tesselation_data(self): - r""":obj:`list`\[:class:`ansys.edb.geometry.Triangle3DData`\]: The underlying tessellation data of the geometry. + """Return a list of Triangle3DData instances. - Read-Only. + This list contains :class:`Triangle3DData ` instances + that correspond to the underlying tessellation data of the geometry. + + Returns + ------- + list[ansys.edb.core.geometry.Triangle3DData] """ tesselation_data = self.__stub.GetTesselationData(self.msg) diff --git a/src/ansys/edb/layout_instance/layout_obj_instance_geometry.py b/src/ansys/edb/core/layout_instance/layout_obj_instance_geometry.py similarity index 88% rename from src/ansys/edb/layout_instance/layout_obj_instance_geometry.py rename to src/ansys/edb/core/layout_instance/layout_obj_instance_geometry.py index ce37020c6b..3d9d86b970 100644 --- a/src/ansys/edb/layout_instance/layout_obj_instance_geometry.py +++ b/src/ansys/edb/core/layout_instance/layout_obj_instance_geometry.py @@ -2,9 +2,9 @@ from ansys.api.edb.v1.layout_obj_instance_geometry_pb2 import LayoutObjInstanceGeometryMessage -from ansys.edb.core import ObjBase -from ansys.edb.core.messages import edb_obj_message -from ansys.edb.session import LayoutObjInstanceGeometryServiceStub, StubAccessor, StubType +from ansys.edb.core.inner import ObjBase +from ansys.edb.core.inner.messages import edb_obj_message +from ansys.edb.core.session import LayoutObjInstanceGeometryServiceStub, StubAccessor, StubType class LayoutObjInstanceGeometry(ObjBase): diff --git a/src/ansys/edb/core/net/__init__.py b/src/ansys/edb/core/net/__init__.py new file mode 100644 index 0000000000..c68bb6282b --- /dev/null +++ b/src/ansys/edb/core/net/__init__.py @@ -0,0 +1,6 @@ +"""Import net classes.""" + +from ansys.edb.core.net.differential_pair import DifferentialPair +from ansys.edb.core.net.extended_net import ExtendedNet +from ansys.edb.core.net.net import Net +from ansys.edb.core.net.net_class import NetClass diff --git a/src/ansys/edb/net/differential_pair.py b/src/ansys/edb/core/net/differential_pair.py similarity index 82% rename from src/ansys/edb/net/differential_pair.py rename to src/ansys/edb/core/net/differential_pair.py index 2b5512ba95..0d882c3cd9 100644 --- a/src/ansys/edb/net/differential_pair.py +++ b/src/ansys/edb/core/net/differential_pair.py @@ -1,10 +1,10 @@ """Differential pair.""" -from ansys.edb.core import messages -from ansys.edb.core.layout_obj import LayoutObjType -from ansys.edb.net.net import Net -from ansys.edb.net.net_class import NetClass -from ansys.edb.session import DifferentialPairServiceStub, StubAccessor, StubType +from ansys.edb.core.inner import messages +from ansys.edb.core.inner.layout_obj import LayoutObjType +from ansys.edb.core.net.net import Net +from ansys.edb.core.net.net_class import NetClass +from ansys.edb.core.session import DifferentialPairServiceStub, StubAccessor, StubType class DifferentialPair(NetClass): @@ -21,7 +21,7 @@ def create(cls, layout, name, pos_net=None, neg_net=None): Parameters ---------- - layout : :class:`Layout` + layout : :class:`Layout` Layout on which new differential pair is placed. name : str Name of new differential pair. @@ -47,7 +47,7 @@ def find_by_name(cls, layout, name): Parameters ---------- - layout : :class:`Layout` + layout : :class:`Layout` Layout being searched for differential pair name : str Name of the differential pair to find @@ -56,7 +56,7 @@ def find_by_name(cls, layout, name): ------- DifferentialPair The differential pair that was found. Check the returned differential pair's \ - :obj:`is_null ` property to see if it exists. + :obj:`is_null ` property to see if it exists. """ return cls(cls.__stub.FindByName(messages.string_property_message(layout, name))) @@ -102,7 +102,7 @@ def is_power_ground(self): def add_net(self, net): """Invalid for differential pair. - Use :obj:`ansys.edb.net.DifferentialPair.differential_pair` = (pos_net, neg_net) instead. + Use :obj:`ansys.edb.core.net.DifferentialPair.differential_pair` = (pos_net, neg_net) instead. """ raise TypeError("net cannot be added to differential pair.") @@ -114,6 +114,6 @@ def remove_net(self, net): def nets(self): """Invalid for differential pair. - Use :obj:`ansys.edb.net.DifferentialPair.differential_pair` instead. + Use :obj:`ansys.edb.core.net.DifferentialPair.differential_pair` instead. """ return self.differential_pair diff --git a/src/ansys/edb/net/extended_net.py b/src/ansys/edb/core/net/extended_net.py similarity index 86% rename from src/ansys/edb/net/extended_net.py rename to src/ansys/edb/core/net/extended_net.py index c496192d69..fb1ae15f35 100644 --- a/src/ansys/edb/net/extended_net.py +++ b/src/ansys/edb/core/net/extended_net.py @@ -2,9 +2,9 @@ import ansys.api.edb.v1.extended_net_pb2 as enet_pb2 -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.net import net_class -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.net import net_class +from ansys.edb.core.session import StubAccessor, StubType class _ExtendedNetQueryBuilder: @@ -33,7 +33,7 @@ def create(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout containing new extended net. name : str Name of the new extended net @@ -53,7 +53,7 @@ def find_by_name(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout being searched for extended net name : str Name of the extended net to find @@ -62,7 +62,7 @@ def find_by_name(cls, layout, name): ------- ExtendedNet The extended net that was found. Check the returned extended net's \ - :obj:`is_null ` property to see if it exists. + :obj:`is_null ` property to see if it exists. """ return ExtendedNet( cls.__stub.FindByName(_ExtendedNetQueryBuilder.extenet_find_by_name_msg(layout, name)) diff --git a/src/ansys/edb/net/net.py b/src/ansys/edb/core/net/net.py similarity index 66% rename from src/ansys/edb/net/net.py rename to src/ansys/edb/core/net/net.py index dfc5dfa88a..e1d68d646f 100644 --- a/src/ansys/edb/net/net.py +++ b/src/ansys/edb/core/net/net.py @@ -1,12 +1,12 @@ """Net.""" -from ansys.edb.core import layout_obj, messages -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.net.extended_net import ExtendedNet -from ansys.edb.net.net_class import NetClass -from ansys.edb.primitive import PadstackInstance, Primitive -from ansys.edb.session import NetServiceStub, StubAccessor, StubType -from ansys.edb.terminal import Terminal, TerminalInstance +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import layout_obj, messages +from ansys.edb.core.net.extended_net import ExtendedNet +from ansys.edb.core.net.net_class import NetClass +from ansys.edb.core.primitive import PadstackInstance, Primitive +from ansys.edb.core.session import NetServiceStub, StubAccessor, StubType +from ansys.edb.core.terminal import Terminal, TerminalInstance class Net(layout_obj.LayoutObj): @@ -28,7 +28,7 @@ def create(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout containing new net. name : str Name of new net @@ -46,7 +46,7 @@ def find_by_name(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout being searched for net name : str Name of net being searched for. @@ -55,7 +55,7 @@ def find_by_name(cls, layout, name): ------- Net Net matching the requested name. Check the returned net's \ - :obj:`is_null ` property to see if it exists. + :obj:`is_null ` property to see if it exists. """ return Net(cls.__stub.FindByName(messages.string_property_message(layout, name))) @@ -82,7 +82,7 @@ def is_power_ground(self, value): @property def primitives(self): - r""":obj:`list`\[:class:`Primitive `\]: List of all primitives on this net. + r""":obj:`list`\[:class:`Primitive `\]: List of all primitives on this net. Read-Only. """ @@ -90,26 +90,40 @@ def primitives(self): @property def padstack_instances(self): - r""" - :obj:`list`\[:class:`PadstackInstance `\]: List of padstacks on this net. + """Return a list of PadstackInstance instances. - Read-Only. + This list contains the :class:`PadstackInstance ` \ + instances on this net object instance. + + Returns + ------- + list[ansys.edb.core.primitive.PadstackInstance] """ return [PadstackInstance(lo) for lo in self._layout_objs(LayoutObjType.PADSTACK_INSTANCE)] @property def terminals(self): - r""":obj:`list`\[:class:`Terminal `\]: List of all terminals on this net. + """Return a list of Terminal instances. - Read-Only. + This list contains the :class:`Terminal ` \ + instances on this net object instance. + + Returns + ------- + list[ansys.edb.core.terminal.Terminal] """ return [Terminal(lo).cast() for lo in self._layout_objs(LayoutObjType.TERMINAL)] @property def terminal_instances(self): - r""":obj:`list`\[:class:`TerminalInstance `\]: terminal instances on net. + """Return a list of TerminalInstance instances. - Read-Only. + This list contains the :class:`TerminalInstance ` instances \ + that are on this net object instance. + + Returns + ------- + list[ansys.edb.core.layer.Layer] """ return [TerminalInstance(lo) for lo in self._layout_objs(LayoutObjType.TERMINAL_INSTANCE)] diff --git a/src/ansys/edb/net/net_class.py b/src/ansys/edb/core/net/net_class.py similarity index 85% rename from src/ansys/edb/net/net_class.py rename to src/ansys/edb/core/net/net_class.py index bc7077bb9f..0553d7dd55 100644 --- a/src/ansys/edb/net/net_class.py +++ b/src/ansys/edb/core/net/net_class.py @@ -2,9 +2,9 @@ import ansys.api.edb.v1.netclass_pb2 as nc_pb2 -from ansys.edb.core import layout_obj, messages -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import layout_obj, messages +from ansys.edb.core.session import StubAccessor, StubType class _QueryBuilder: @@ -26,7 +26,7 @@ def create(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout containing new net class. name : str Name of the new net class. @@ -45,7 +45,7 @@ def find_by_name(cls, layout, name): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout being searched for net class. name : str Name of net class being searched for. @@ -54,7 +54,7 @@ def find_by_name(cls, layout, name): ------- NetClass Net class matching the requested name. Check the returned net class's \ - :obj:`is_null ` property to see if it exists. + :obj:`is_null ` property to see if it exists. """ return NetClass(cls.__stub.FindByName(messages.edb_obj_name_message(layout, name))) @@ -86,11 +86,11 @@ def is_power_ground(self): @property def nets(self): - """:obj:`list` of :class:`Net `: List of nets in this object. + """:obj:`list` of :class:`Net `: List of nets in this object. Read-Only. """ - from ansys.edb.net.net import Net + from ansys.edb.core.net.net import Net nets = self.__stub.GetNets(self.msg).items return [Net(n) for n in nets] diff --git a/src/ansys/edb/primitive/__init__.py b/src/ansys/edb/core/primitive/__init__.py similarity index 86% rename from src/ansys/edb/primitive/__init__.py rename to src/ansys/edb/core/primitive/__init__.py index b25e8a2ed3..12b745ad9a 100644 --- a/src/ansys/edb/primitive/__init__.py +++ b/src/ansys/edb/core/primitive/__init__.py @@ -1,6 +1,6 @@ """Import net classes.""" -from ansys.edb.primitive.primitive import ( +from ansys.edb.core.primitive.primitive import ( BackDrillType, BoardBendDef, Bondwire, diff --git a/src/ansys/edb/primitive/primitive.py b/src/ansys/edb/core/primitive/primitive.py similarity index 85% rename from src/ansys/edb/primitive/primitive.py rename to src/ansys/edb/core/primitive/primitive.py index 755c37f627..becf7b31b9 100644 --- a/src/ansys/edb/primitive/primitive.py +++ b/src/ansys/edb/core/primitive/primitive.py @@ -23,14 +23,14 @@ text_pb2_grpc, ) -from ansys.edb import hierarchy, terminal -from ansys.edb.core import conn_obj, messages, parser -from ansys.edb.definition.padstack_def import PadstackDef -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.layer import Layer -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import Value -from ansys.edb.utility.layer_map import LayerMap +from ansys.edb.core import hierarchy, terminal +from ansys.edb.core.definition.padstack_def import PadstackDef +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.inner import conn_obj, messages, parser +from ansys.edb.core.layer import Layer +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import Value +from ansys.edb.core.utility.layer_map import LayerMap class _PrimitiveQueryBuilder: @@ -237,7 +237,7 @@ def set_hfss_prop(self, material, solve_inside): @property def layer(self): - """:class:`Layer `: Layer that the primitive object is on.""" + """:class:`Layer `: Layer that the primitive object is on.""" layer_msg = self.__stub.GetLayer(self.msg) return Layer(layer_msg).cast() @@ -269,7 +269,7 @@ def has_voids(self): @property def voids(self): - """:obj:`list` of :class:`Primitive `: List of void\ + """:obj:`list` of :class:`Primitive `: List of void\ primitive objects inside the primitive. Read-Only. @@ -278,7 +278,7 @@ def voids(self): @property def owner(self): - """:class:`Primitive `: Owner of the primitive object. + """:class:`Primitive `: Owner of the primitive object. Read-Only. """ @@ -351,25 +351,25 @@ def create( Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout this rectangle will be in. - layer : str or :class:`Layer ` + layer : str or :class:`Layer ` Layer this rectangle will be on. - net : str or :class:`Net ` or None + net : str or :class:`Net ` or None Net this rectangle will have. rep_type : :class:`RectangleRepresentationType` Type that defines given parameters meaning. - param1 : :class:`Value ` + param1 : :class:`Value ` X value of lower left point or center point. - param2 : :class:`Value ` + param2 : :class:`Value ` Y value of lower left point or center point. - param3 : :class:`Value ` + param3 : :class:`Value ` X value of upper right point or width. - param4 : :class:`Value ` + param4 : :class:`Value ` Y value of upper right point or height. - corner_rad : :class:`Value ` + corner_rad : :class:`Value ` Corner radius. - rotation : :class:`Value ` + rotation : :class:`Value ` Rotation. Returns @@ -401,12 +401,12 @@ def get_parameters(self): ------- tuple[ :class:`RectangleRepresentationType`, - :class:`Value `, - :class:`Value `, - :class:`Value `, - :class:`Value `, - :class:`Value `, - :class:`Value ` + :class:`Value `, + :class:`Value `, + :class:`Value `, + :class:`Value `, + :class:`Value `, + :class:`Value ` ] Returns a tuple of the following format: @@ -445,17 +445,17 @@ def set_parameters(self, rep_type, param1, param2, param3, param4, corner_rad, r ---------- rep_type : :class:`RectangleRepresentationType` Type that defines given parameters meaning. - param1 : :class:`Value ` + param1 : :class:`Value ` X value of lower left point or center point. - param2 : :class:`Value ` + param2 : :class:`Value ` Y value of lower left point or center point. - param3 : :class:`Value ` + param3 : :class:`Value ` X value of upper right point or width. - param4 : :class:`Value ` + param4 : :class:`Value ` Y value of upper right point or height. - corner_rad : :class:`Value ` + corner_rad : :class:`Value ` Corner radius. - rotation : :class:`Value ` + rotation : :class:`Value ` Rotation. """ self.__stub.SetParameters( @@ -483,7 +483,7 @@ def can_be_zone_primitive(self): @property def polygon_data(self): - """:class:`PolygonData `: Polygon data object of the rectangle. + """:class:`PolygonData `: Polygon data object of the rectangle. Read-Only. """ @@ -508,24 +508,24 @@ def render( ---------- rep_type : :class:`RectangleRepresentationType` Type that defines given parameters meaning. - x_lower_left_or_center_x : :class:`Value ` + x_lower_left_or_center_x : :class:`Value ` X value of lower left point or center point. - y_lower_left_or_center_y : :class:`Value ` + y_lower_left_or_center_y : :class:`Value ` Y value of lower left point or center point. - x_upper_right_or_width : :class:`Value ` + x_upper_right_or_width : :class:`Value ` X value of upper right point or width. - y_upper_right_or_height : :class:`Value ` + y_upper_right_or_height : :class:`Value ` Y value of upper right point or height. - corner_radius : :class:`Value ` + corner_radius : :class:`Value ` Corner radius. - rotation : :class:`Value ` + rotation : :class:`Value ` Rotation. is_hole : bool, optional If rectangle is hole. Returns ------- - :class:`PolygonData ` + :class:`PolygonData ` Polygon data object created. """ if rep_type == RectangleRepresentationType.LOWER_LEFT_UPPER_RIGHT: @@ -572,17 +572,17 @@ def create(cls, layout, layer, net, center_x, center_y, radius): Parameters ---------- - layout: :class:`Layout ` + layout: :class:`Layout ` Layout this circle will be in. - layer: str or :class:`Layer ` + layer: str or :class:`Layer ` Layer this circle will be on. - net: str or :class:`Net ` or None + net: str or :class:`Net ` or None Net this circle will have. - center_x: :class:`Value ` + center_x: :class:`Value ` X value of center point. - center_y: :class:`Value ` + center_y: :class:`Value ` Y value of center point. - radius: :class:`Value ` + radius: :class:`Value ` Radius value of the circle. Returns @@ -610,18 +610,18 @@ def render(cls, center_x, center_y, radius, is_hole): Parameters ---------- - center_x: :class:`Value ` + center_x: :class:`Value ` X value of center point. - center_y: :class:`Value ` + center_y: :class:`Value ` Y value of center point. - radius: :class:`Value ` + radius: :class:`Value ` Radius value of the circle. is_hole: bool If circle object is a hole. Returns ------- - :class:`PolygonData ` + :class:`PolygonData ` Polygon data object created. """ return cls.__stub.Render( @@ -639,9 +639,9 @@ def get_parameters(self): Returns ------- tuple[ - :class:`Value `, - :class:`Value `, - :class:`Value ` + :class:`Value `, + :class:`Value `, + :class:`Value ` ] Returns a tuple of the following format: @@ -666,11 +666,11 @@ def set_parameters(self, center_x, center_y, radius): Parameters ---------- - center_x: :class:`Value ` + center_x: :class:`Value ` X value of center point. - center_y: :class:`Value ` + center_y: :class:`Value ` Y value of center point. - radius: :class:`Value ` + radius: :class:`Value ` Radius value of the circle. """ self.__stub.SetParameters( @@ -685,7 +685,7 @@ def set_parameters(self, center_x, center_y, radius): ) def get_polygon_data(self): - """:class:`PolygonData `: Polygon data object of the Circle object.""" + """:class:`PolygonData `: Polygon data object of the Circle object.""" return Circle.render(*self.get_parameters(), self.is_void) def can_be_zone_primitive(self): @@ -704,13 +704,13 @@ def create(cls, layout, layer, center_x, center_y, text): Parameters ---------- - layout: :class:`Layout ` + layout: :class:`Layout ` Layout this text will be in. layer: str or Layer Layer this text will be on. - center_x: :class:`Value ` + center_x: :class:`Value ` X value of center point. - center_y: :class:`Value ` + center_y: :class:`Value ` Y value of center point. text: str Text string. @@ -738,8 +738,8 @@ def get_text_data(self): Returns ------- tuple[ - :class:`Value `, - :class:`Value `, + :class:`Value `, + :class:`Value `, str ] Returns a tuple of the following format: @@ -764,9 +764,9 @@ def set_text_data(self, center_x, center_y, text): Parameters ---------- - center_x: :class:`Value ` + center_x: :class:`Value ` X value of center point. - center_y: :class:`Value ` + center_y: :class:`Value ` Y value of center point. text: str Text object's String value. @@ -805,13 +805,13 @@ def create(cls, layout, layer, net, polygon_data): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout the polygon will be in. - layer : str or :class:`Layer ` + layer : str or :class:`Layer ` Layer this Polygon will be in. - net : str or :class:`Net ` or None + net : str or :class:`Net ` or None Net of the Polygon object. - polygon_data : :class:`PolygonData ` + polygon_data : :class:`PolygonData ` The outer contour of the Polygon. Returns @@ -826,7 +826,7 @@ def create(cls, layout, layer, net, polygon_data): @property @parser.to_polygon_data def polygon_data(self): - """:class:`PolygonData `: Outer contour of the Polygon object.""" + """:class:`PolygonData `: Outer contour of the Polygon object.""" return self.__stub.GetPolygonData(self.msg) @polygon_data.setter @@ -872,13 +872,13 @@ def create(cls, layout, layer, net, width, end_cap1, end_cap2, corner_style, poi Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout this Path will be in. - layer : str or :class:`Layer ` + layer : str or :class:`Layer ` Layer this Path will be on. - net : str or :class:`Net ` or None + net : str or :class:`Net ` or None Net this Path will have. - width: :class:`Value ` + width: :class:`Value ` Path width. end_cap1: :class:`PathEndCapType` End cap style of path start end cap. @@ -886,7 +886,7 @@ def create(cls, layout, layer, net, width, end_cap1, end_cap2, corner_style, poi End cap style of path end end cap. corner_style: :class:`PathCornerType` Corner style. - points : :class:`PolygonData ` + points : :class:`PolygonData ` Centerline polygonData to set. Returns @@ -909,7 +909,7 @@ def render(cls, width, end_cap1, end_cap2, corner_style, path): Parameters ---------- - width: :class:`Value ` + width: :class:`Value ` Path width. end_cap1: :class:`PathEndCapType` End cap style of path start end cap. @@ -917,12 +917,12 @@ def render(cls, width, end_cap1, end_cap2, corner_style, path): End cap style of path end end cap. corner_style: :class:`PathCornerType` Corner style. - path: :class:`PolygonData ` + path: :class:`PolygonData ` PolygonData to set. Returns ------- - :class:`PolygonData ` + :class:`PolygonData ` PolygonData object created. """ return cls.__stub.Render( @@ -935,16 +935,10 @@ def render(cls, width, end_cap1, end_cap2, corner_style, path): ) ) - @property - @parser.to_polygon_data - def polygon_data(self): - """:class:`PolygonData `: Polygon data of this Path.""" - return self.__stub.GetPolygonData(self.msg) - @property @parser.to_polygon_data def center_line(self): - """:class:`PolygonData `: Center line for this Path.""" + """:class:`PolygonData `: Center line for this Path.""" return self.__stub.GetCenterLine(self.msg) @center_line.setter @@ -998,7 +992,7 @@ def get_clip_info(self): Returns ------- - tuple[:class:`PolygonData `, bool] + tuple[:class:`PolygonData `, bool] Returns a tuple of the following format: @@ -1019,7 +1013,7 @@ def set_clip_info(self, clipping_poly, keep_inside=True): Parameters ---------- - clipping_poly: :class:`PolygonData ` + clipping_poly: :class:`PolygonData ` PolygonData used to clip the path. keep_inside: bool Indicates whether the part of the path inside the polygon should be preserved. @@ -1048,7 +1042,7 @@ def corner_style(self, corner_type): @property def width(self): - """:class:`Value `: Path width.""" + """:class:`Value `: Path width.""" return Value(self.__stub.GetWidth(self.msg).width) @width.setter @@ -1062,7 +1056,7 @@ def width(self, width): @property def miter_ratio(self): - """:class:`Value `: Miter ratio.""" + """:class:`Value `: Miter ratio.""" return Value(self.__stub.GetMiterRatio(self.msg).miter_ratio) @miter_ratio.setter @@ -1214,7 +1208,7 @@ def create( Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout this bondwire will be in. bondwire_type : :class:`BondwireType` Type of bondwire: kAPDBondWire or kJDECBondWire types. @@ -1222,27 +1216,27 @@ def create( Bondwire definition name. placement_layer : str Layer name this bondwire will be on. - width : :class:`Value ` + width : :class:`Value ` Bondwire width. material : str Bondwire material name. - start_context : :class:`CellInstance ` + start_context : :class:`CellInstance ` Start context: None means top level. start_layer_name : str Name of start layer. - start_x : :class:`Value ` + start_x : :class:`Value ` X value of start point. - start_y : :class:`Value ` + start_y : :class:`Value ` Y value of start point. - end_context : :class:`CellInstance ` + end_context : :class:`CellInstance ` End context: None means top level. end_layer_name : str Name of end layer. - end_x : :class:`Value ` + end_x : :class:`Value ` X value of end point. - end_y : :class:`Value ` + end_y : :class:`Value ` Y value of end point. - net : str or :class:`Net ` or None + net : str or :class:`Net ` or None Net of the Bondwire. Returns @@ -1320,7 +1314,7 @@ def cross_section_type(self, bondwire_type): @property def cross_section_height(self): - """:class:`Value `: Bondwire-cross-section height of a bondwire object.""" + """:class:`Value `: Bondwire-cross-section height of a bondwire object.""" return Value(self.__stub.GetCrossSectionHeight(self.msg)) @cross_section_height.setter @@ -1364,10 +1358,10 @@ def get_traj(self): Returns ------- tuple[ - :class:`Value `, - :class:`Value `, - :class:`Value `, - :class:`Value ` + :class:`Value `, + :class:`Value `, + :class:`Value `, + :class:`Value ` ] Returns a tuple of the following format: @@ -1395,20 +1389,20 @@ def set_traj(self, x1, y1, x2, y2): Parameters ---------- - x1 : :class:`Value ` + x1 : :class:`Value ` X value of the start point. - y1 : :class:`Value ` + y1 : :class:`Value ` Y value of the start point. - x2 : :class:`Value ` + x2 : :class:`Value ` X value of the end point. - y2 : :class:`Value ` + y2 : :class:`Value ` Y value of the end point. """ self.__stub.SetTraj(_BondwireQueryBuilder.set_bondwire_traj_message(self, x1, y1, x2, y2)) @property def width(self): - """:class:`Value `: Width of a bondwire object.""" + """:class:`Value `: Width of a bondwire object.""" val = self.__stub.GetWidthValue(self.msg) return Value(val) @@ -1421,12 +1415,12 @@ def get_start_elevation(self, start_context): Parameters ---------- - start_context : :class:`CellInstance ` + start_context : :class:`CellInstance ` Start cell context of the bondwire. Returns ------- - :class:`Layer ` + :class:`Layer ` Start context of the bondwire. """ return Layer( @@ -1440,9 +1434,9 @@ def set_start_elevation(self, start_context, layer): Parameters ---------- - start_context : :class:`CellInstance ` + start_context : :class:`CellInstance ` Start cell context of the bondwire. None means top level. - layer : str or :class:`Layer ` + layer : str or :class:`Layer ` Start layer of the bondwire. """ self.__stub.SetStartElevation( @@ -1454,12 +1448,12 @@ def get_end_elevation(self, end_context): Parameters ---------- - end_context : :class:`CellInstance ` + end_context : :class:`CellInstance ` End cell context of the bondwire. Returns ------- - :class:`Layer ` + :class:`Layer ` End context of the bondwire. """ return Layer( @@ -1473,9 +1467,9 @@ def set_end_elevation(self, end_context, layer): Parameters ---------- - end_context : :class:`CellInstance ` + end_context : :class:`CellInstance ` End cell context of the bondwire. None means top level. - layer : str or :class:`Layer ` + layer : str or :class:`Layer ` End layer of the bondwire. """ self.__stub.SetEndElevation( @@ -1653,23 +1647,23 @@ def create( Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout this padstack instance will be in. - net : :class:`Net ` + net : :class:`Net ` Net of this padstack instance. name : str Name of padstack instance. padstack_def : PadstackDef Padstack definition of this padstack instance. - rotation : :class:`Value ` + rotation : :class:`Value ` Rotation of this padstack instance. - top_layer : :class:`Layer ` + top_layer : :class:`Layer ` Top layer of this padstack instance. - bottom_layer : :class:`Layer ` + bottom_layer : :class:`Layer ` Bottom layer of this padstack instance. - solder_ball_layer : :class:`Layer ` + solder_ball_layer : :class:`Layer ` Solder ball layer of this padstack instance, or None for none. - layer_map : :class:`LayerMap ` + layer_map : :class:`LayerMap ` Layer map of this padstack instance. None or empty means do auto-mapping. Returns @@ -1695,7 +1689,7 @@ def create( @property def padstack_def(self): - """:class:`PadstackDef `: PadstackDef of a Padstack Instance.""" + """:class:`PadstackDef `: PadstackDef of a Padstack Instance.""" return PadstackDef(self.__stub.GetPadstackDef(self.msg)) @property @@ -1713,9 +1707,9 @@ def get_position_and_rotation(self): Returns ------- tuple[ - :class:`Value `, - :class:`Value `, - :class:`Value ` + :class:`Value `, + :class:`Value `, + :class:`Value ` ] Returns a tuple of the following format: @@ -1740,11 +1734,11 @@ def set_position_and_rotation(self, x, y, rotation): Parameters ---------- - x : :class:`Value ` + x : :class:`Value ` x : X coordinate. - y : :class:`Value ` + y : :class:`Value ` y : Y coordinate. - rotation : :class:`Value ` + rotation : :class:`Value ` rotation : Rotation in radians. """ self.__stub.SetPositionAndRotation( @@ -1757,8 +1751,8 @@ def get_layer_range(self): Returns ------- tuple[ - :class:`Layer `, - :class:`Layer ` + :class:`Layer `, + :class:`Layer ` ] Returns a tuple of the following format: @@ -1780,9 +1774,9 @@ def set_layer_range(self, top_layer, bottom_layer): Parameters ---------- - top_layer : :class:`Layer ` + top_layer : :class:`Layer ` Top layer of the Padstack instance. - bottom_layer : :class:`Layer ` + bottom_layer : :class:`Layer ` Bottom layer of the Padstack instance. """ self.__stub.SetLayerRange( @@ -1791,7 +1785,7 @@ def set_layer_range(self, top_layer, bottom_layer): @property def solderball_layer(self): - """:class:`Layer `: SolderBall Layer of Padstack Instance.""" + """:class:`Layer `: SolderBall Layer of Padstack Instance.""" return Layer(self.__stub.GetSolderBallLayer(self.msg)).cast() @solderball_layer.setter @@ -1802,7 +1796,7 @@ def solderball_layer(self, solderball_layer): @property def layer_map(self): - """:class:`LayerMap `: Layer Map of the Padstack Instance.""" + """:class:`LayerMap `: Layer Map of the Padstack Instance.""" return LayerMap(self.__stub.GetLayerMap(self.msg)) @layer_map.setter @@ -1816,7 +1810,7 @@ def get_hole_overrides(self): ------- tuple[ bool, - :class:`Value ` + :class:`Value ` ] Returns a tuple of the following format: @@ -1840,7 +1834,7 @@ def set_hole_overrides(self, is_hole_override, hole_override): ---------- is_hole_override : bool If padstack instance is hole override. - hole_override : :class:`Value ` + hole_override : :class:`Value ` Hole override diameter of this padstack instance. """ self.__stub.SetHoleOverrides( @@ -1891,8 +1885,8 @@ def get_back_drill_by_layer(self, from_bottom): ------- tuple[ bool, - :class:`Value `, - :class:`Value ` + :class:`Value `, + :class:`Value ` ] Returns a tuple of the following format: @@ -1921,12 +1915,12 @@ def set_back_drill_by_layer(self, drill_to_layer, offset, diameter, from_bottom) Parameters ---------- - drill_to_layer : :class:`Layer ` + drill_to_layer : :class:`Layer ` Layer drills to. If drill from top, drill stops at the upper elevation of the layer. If from bottom, drill stops at the lower elevation of the layer. - offset : :class:`Value ` + offset : :class:`Value ` Layer offset (or depth if layer is empty). - diameter : :class:`Value ` + diameter : :class:`Value ` Drilling diameter. from_bottom : bool True to set drill type from bottom. @@ -1949,7 +1943,7 @@ def get_back_drill_by_depth(self, from_bottom): ------- tuple[ bool, - :class:`Value ` + :class:`Value ` ] Returns a tuple of the following format: @@ -1969,9 +1963,9 @@ def set_back_drill_by_depth(self, drill_depth, diameter, from_bottom): Parameters ---------- - drill_depth : :class:`Value ` + drill_depth : :class:`Value ` Drilling depth, may not align with layer. - diameter : :class:`Value ` + diameter : :class:`Value ` Drilling diameter. from_bottom : bool True to set drill type from bottom. @@ -1983,7 +1977,7 @@ def set_back_drill_by_depth(self, drill_depth, diameter, from_bottom): ) def get_padstack_instance_terminal(self): - """:class:`TerminalInstance `: Padstack Instance's terminal.""" + """:class:`TerminalInstance `: Padstack Instance's terminal.""" return terminal.TerminalInstance(self.__stub.GetPadstackInstanceTerminal(self.msg)) def is_in_pin_group(self, pin_group): @@ -1991,7 +1985,7 @@ def is_in_pin_group(self, pin_group): Parameters ---------- - pin_group : :class:`PinGroup ` + pin_group : :class:`PinGroup ` Pin group to check if padstack instance is in. Returns @@ -2005,7 +1999,7 @@ def is_in_pin_group(self, pin_group): @property def pin_groups(self): - """:obj:`list` of :class:`PinGroup `: Pin groups of Padstack instance object. + """:obj:`list` of :class:`PinGroup `: Pin groups of Padstack instance object. Read-Only. """ @@ -2024,7 +2018,7 @@ def create(cls, layout, zone_prim, bend_middle, bend_radius, bend_angle): Parameters ---------- - layout : :class:`Layout ` + layout : :class:`Layout ` Layout this board bend definition will be in. zone_prim : :class:`Primitive ` Zone primitive this board bend definition exists on. @@ -2091,7 +2085,7 @@ def angle(self, val): @property @parser.to_polygon_data_list def bent_regions(self): - """:obj:`list` of :class:`PolygonData `: Bent region polygons. + """:obj:`list` of :class:`PolygonData `: Bent region polygons. Collection of polygon data representing the areas bent by this bend definition. diff --git a/src/ansys/edb/session.py b/src/ansys/edb/core/session.py similarity index 99% rename from src/ansys/edb/session.py rename to src/ansys/edb/core/session.py index 95920e57c6..8daaa00b13 100644 --- a/src/ansys/edb/session.py +++ b/src/ansys/edb/core/session.py @@ -137,9 +137,9 @@ from ansys.api.edb.v1.voltage_regulator_pb2_grpc import VoltageRegulatorServiceStub import grpc -from ansys.edb.core import LOGGER -from ansys.edb.core.exceptions import EDBSessionException, ErrorCode -from ansys.edb.core.interceptors import ExceptionInterceptor, LoggingInterceptor +from ansys.edb.core.inner import LOGGER +from ansys.edb.core.inner.exceptions import EDBSessionException, ErrorCode +from ansys.edb.core.inner.interceptors import ExceptionInterceptor, LoggingInterceptor # The session module singleton MOD = modules[__name__] diff --git a/src/ansys/edb/simulation_setup/__init__.py b/src/ansys/edb/core/simulation_setup/__init__.py similarity index 52% rename from src/ansys/edb/simulation_setup/__init__.py rename to src/ansys/edb/core/simulation_setup/__init__.py index 8342922e34..dc1d1d73b5 100644 --- a/src/ansys/edb/simulation_setup/__init__.py +++ b/src/ansys/edb/core/simulation_setup/__init__.py @@ -1,6 +1,6 @@ """Import simulation setup classes.""" -from ansys.edb.simulation_setup.adaptive_solutions import ( +from ansys.edb.core.simulation_setup.adaptive_solutions import ( AdaptiveFrequency, BroadbandAdaptiveSolution, MatrixConvergenceData, @@ -8,7 +8,7 @@ MultiFrequencyAdaptiveSolution, SingleFrequencyAdaptiveSolution, ) -from ansys.edb.simulation_setup.hfss_simulation_settings import ( +from ansys.edb.core.simulation_setup.hfss_simulation_settings import ( AdaptType, BasisFunctionOrder, HFSSAdvancedMeshingSettings, @@ -20,19 +20,19 @@ HFSSSolverSettings, SolverType, ) -from ansys.edb.simulation_setup.hfss_simulation_setup import HfssSimulationSetup -from ansys.edb.simulation_setup.mesh_operation import ( +from ansys.edb.core.simulation_setup.hfss_simulation_setup import HfssSimulationSetup +from ansys.edb.core.simulation_setup.mesh_operation import ( LengthMeshOperation, MeshOperation, SkinDepthMeshOperation, ) -from ansys.edb.simulation_setup.raptor_x_simulation_settings import ( +from ansys.edb.core.simulation_setup.raptor_x_simulation_settings import ( RaptorXAdvancedSettings, RaptorXGeneralSettings, RaptorXSimulationSettings, ) -from ansys.edb.simulation_setup.raptor_x_simulation_setup import RaptorXSimulationSetup -from ansys.edb.simulation_setup.simulation_settings import ( +from ansys.edb.core.simulation_setup.raptor_x_simulation_setup import RaptorXSimulationSetup +from ansys.edb.core.simulation_setup.simulation_settings import ( AdvancedMeshingSettings, AdvancedSettings, SettingsOptions, @@ -40,14 +40,16 @@ SolverSettings, ViaStyle, ) -from ansys.edb.simulation_setup.simulation_setup import ( +from ansys.edb.core.simulation_setup.simulation_setup import ( SimulationSetup, SimulationSetupType, SweepData, ) -from ansys.edb.simulation_setup.siwave_dcir_simulation_settings import SIWaveDCIRSimulationSettings -from ansys.edb.simulation_setup.siwave_dcir_simulation_setup import SIWaveDCIRSimulationSetup -from ansys.edb.simulation_setup.siwave_simulation_settings import ( +from ansys.edb.core.simulation_setup.siwave_dcir_simulation_settings import ( + SIWaveDCIRSimulationSettings, +) +from ansys.edb.core.simulation_setup.siwave_dcir_simulation_setup import SIWaveDCIRSimulationSetup +from ansys.edb.core.simulation_setup.siwave_simulation_settings import ( SIWaveAdvancedSettings, SIWaveDCAdvancedSettings, SIWaveDCSettings, @@ -58,4 +60,4 @@ SParamExtrapolation, SParamInterpolation, ) -from ansys.edb.simulation_setup.siwave_simulation_setup import SIWaveSimulationSetup +from ansys.edb.core.simulation_setup.siwave_simulation_setup import SIWaveSimulationSetup diff --git a/src/ansys/edb/simulation_setup/adaptive_solutions.py b/src/ansys/edb/core/simulation_setup/adaptive_solutions.py similarity index 100% rename from src/ansys/edb/simulation_setup/adaptive_solutions.py rename to src/ansys/edb/core/simulation_setup/adaptive_solutions.py diff --git a/src/ansys/edb/simulation_setup/hfss_simulation_settings.py b/src/ansys/edb/core/simulation_setup/hfss_simulation_settings.py similarity index 99% rename from src/ansys/edb/simulation_setup/hfss_simulation_settings.py rename to src/ansys/edb/core/simulation_setup/hfss_simulation_settings.py index ef823c4a81..5d2fcf65cc 100644 --- a/src/ansys/edb/simulation_setup/hfss_simulation_settings.py +++ b/src/ansys/edb/core/simulation_setup/hfss_simulation_settings.py @@ -4,8 +4,8 @@ import ansys.api.edb.v1.hfss_simulation_settings_pb2 as pb -from ansys.edb.core import messages, parser -from ansys.edb.session import ( +from ansys.edb.core.inner import messages, parser +from ansys.edb.core.session import ( DCRSettingsServiceStub, HFSSAdvancedMeshingSettingsServiceStub, HFSSAdvancedSettingsServiceStub, @@ -15,7 +15,7 @@ StubAccessor, StubType, ) -from ansys.edb.simulation_setup.simulation_settings import ( +from ansys.edb.core.simulation_setup.simulation_settings import ( AdvancedMeshingSettings, AdvancedSettings, SettingsOptions, diff --git a/src/ansys/edb/simulation_setup/hfss_simulation_setup.py b/src/ansys/edb/core/simulation_setup/hfss_simulation_setup.py similarity index 77% rename from src/ansys/edb/simulation_setup/hfss_simulation_setup.py rename to src/ansys/edb/core/simulation_setup/hfss_simulation_setup.py index 12bc7220eb..f8872aa52d 100644 --- a/src/ansys/edb/simulation_setup/hfss_simulation_setup.py +++ b/src/ansys/edb/core/simulation_setup/hfss_simulation_setup.py @@ -2,11 +2,11 @@ import ansys.api.edb.v1.hfss_simulation_setup_pb2 as pb -from ansys.edb.core import messages, parser -from ansys.edb.core.utils import map_list -from ansys.edb.session import HfssSimulationSetupServiceStub, StubAccessor, StubType -from ansys.edb.simulation_setup.hfss_simulation_settings import HFSSSimulationSettings -from ansys.edb.simulation_setup.simulation_setup import SimulationSetup, SimulationSetupType +from ansys.edb.core.inner import messages, parser +from ansys.edb.core.inner.utils import map_list +from ansys.edb.core.session import HfssSimulationSetupServiceStub, StubAccessor, StubType +from ansys.edb.core.simulation_setup.hfss_simulation_settings import HFSSSimulationSettings +from ansys.edb.core.simulation_setup.simulation_setup import SimulationSetup, SimulationSetupType class HfssSimulationSetup(SimulationSetup): @@ -20,7 +20,7 @@ def create(cls, cell, name): Parameters ---------- - cell : :class:`Cell ` + cell : :class:`Cell ` Cell containing new simulation setup. name : str Name of new simulation setup diff --git a/src/ansys/edb/simulation_setup/mesh_operation.py b/src/ansys/edb/core/simulation_setup/mesh_operation.py similarity index 100% rename from src/ansys/edb/simulation_setup/mesh_operation.py rename to src/ansys/edb/core/simulation_setup/mesh_operation.py diff --git a/src/ansys/edb/simulation_setup/raptor_x_simulation_settings.py b/src/ansys/edb/core/simulation_setup/raptor_x_simulation_settings.py similarity index 99% rename from src/ansys/edb/simulation_setup/raptor_x_simulation_settings.py rename to src/ansys/edb/core/simulation_setup/raptor_x_simulation_settings.py index 72fb897c63..511614bc3b 100644 --- a/src/ansys/edb/simulation_setup/raptor_x_simulation_settings.py +++ b/src/ansys/edb/core/simulation_setup/raptor_x_simulation_settings.py @@ -2,14 +2,14 @@ import ansys.api.edb.v1.raptor_x_simulation_settings_pb2 as pb -from ansys.edb.core import messages -from ansys.edb.session import ( +from ansys.edb.core.inner import messages +from ansys.edb.core.session import ( RaptorXAdvancedSettingsServiceStub, RaptorXGeneralSettingsServiceStub, StubAccessor, StubType, ) -from ansys.edb.simulation_setup.simulation_settings import ( +from ansys.edb.core.simulation_setup.simulation_settings import ( SimulationSettings, SimulationSettingsBase, ) diff --git a/src/ansys/edb/simulation_setup/raptor_x_simulation_setup.py b/src/ansys/edb/core/simulation_setup/raptor_x_simulation_setup.py similarity index 75% rename from src/ansys/edb/simulation_setup/raptor_x_simulation_setup.py rename to src/ansys/edb/core/simulation_setup/raptor_x_simulation_setup.py index 438e89cd52..adf2cdb0ef 100644 --- a/src/ansys/edb/simulation_setup/raptor_x_simulation_setup.py +++ b/src/ansys/edb/core/simulation_setup/raptor_x_simulation_setup.py @@ -1,7 +1,7 @@ """RaptorX Simulation Setup.""" -from ansys.edb.simulation_setup.raptor_x_simulation_settings import RaptorXSimulationSettings -from ansys.edb.simulation_setup.simulation_setup import SimulationSetup, SimulationSetupType +from ansys.edb.core.simulation_setup.raptor_x_simulation_settings import RaptorXSimulationSettings +from ansys.edb.core.simulation_setup.simulation_setup import SimulationSetup, SimulationSetupType class RaptorXSimulationSetup(SimulationSetup): @@ -13,7 +13,7 @@ def create(cls, cell, name): Parameters ---------- - cell : :class:`Cell ` + cell : :class:`Cell ` Cell containing new simulation setup. name : str Name of new simulation setup diff --git a/src/ansys/edb/simulation_setup/simulation_settings.py b/src/ansys/edb/core/simulation_setup/simulation_settings.py similarity index 98% rename from src/ansys/edb/simulation_setup/simulation_settings.py rename to src/ansys/edb/core/simulation_setup/simulation_settings.py index d5941ffb26..a33ad28e5f 100644 --- a/src/ansys/edb/simulation_setup/simulation_settings.py +++ b/src/ansys/edb/core/simulation_setup/simulation_settings.py @@ -3,8 +3,8 @@ import ansys.api.edb.v1.simulation_settings_pb2 as pb -from ansys.edb.core import messages -from ansys.edb.session import ( +from ansys.edb.core.inner import messages +from ansys.edb.core.session import ( AdvancedMeshingSettingsServiceStub, AdvancedSettingsServiceStub, SettingsOptionsServiceStub, @@ -79,7 +79,7 @@ def do_lamda_refine(self, do_lamda_refine): @property def lamda_target(self): - """:obj:`float`: Target lamda value for lambda refinement.""" + """:obj:`float`: Target lambda value for lambda refinement.""" return self.__stub.GetLamdaTarget(self.msg).value @lamda_target.setter diff --git a/src/ansys/edb/simulation_setup/simulation_setup.py b/src/ansys/edb/core/simulation_setup/simulation_setup.py similarity index 96% rename from src/ansys/edb/simulation_setup/simulation_setup.py rename to src/ansys/edb/core/simulation_setup/simulation_setup.py index 3732cc0f9a..890900bb7a 100644 --- a/src/ansys/edb/simulation_setup/simulation_setup.py +++ b/src/ansys/edb/core/simulation_setup/simulation_setup.py @@ -10,9 +10,9 @@ SweepDataMessage, ) -from ansys.edb.core import messages -from ansys.edb.core.base import ObjBase -from ansys.edb.session import SimulationSetupServiceStub, StubAccessor, StubType +from ansys.edb.core.inner import messages +from ansys.edb.core.inner.base import ObjBase +from ansys.edb.core.session import SimulationSetupServiceStub, StubAccessor, StubType class SimulationSetupType(Enum): @@ -176,7 +176,7 @@ def cast(self): ------- SimulationSetup """ - from ansys.edb.simulation_setup import ( + from ansys.edb.core.simulation_setup import ( HfssSimulationSetup, RaptorXSimulationSetup, SIWaveDCIRSimulationSetup, diff --git a/src/ansys/edb/simulation_setup/siwave_dcir_simulation_settings.py b/src/ansys/edb/core/simulation_setup/siwave_dcir_simulation_settings.py similarity index 95% rename from src/ansys/edb/simulation_setup/siwave_dcir_simulation_settings.py rename to src/ansys/edb/core/simulation_setup/siwave_dcir_simulation_settings.py index c5341281ce..1560e2d6de 100644 --- a/src/ansys/edb/simulation_setup/siwave_dcir_simulation_settings.py +++ b/src/ansys/edb/core/simulation_setup/siwave_dcir_simulation_settings.py @@ -2,9 +2,9 @@ import ansys.api.edb.v1.siwave_dcir_simulation_settings_pb2 as pb -from ansys.edb.core import messages -from ansys.edb.session import SIWaveDCIRSimulationSettingsServiceStub, StubAccessor, StubType -from ansys.edb.simulation_setup.siwave_simulation_settings import SIWaveSimulationSettings +from ansys.edb.core.inner import messages +from ansys.edb.core.session import SIWaveDCIRSimulationSettingsServiceStub, StubAccessor, StubType +from ansys.edb.core.simulation_setup.siwave_simulation_settings import SIWaveSimulationSettings class SIWaveDCIRSimulationSettings(SIWaveSimulationSettings): diff --git a/src/ansys/edb/simulation_setup/siwave_dcir_simulation_setup.py b/src/ansys/edb/core/simulation_setup/siwave_dcir_simulation_setup.py similarity index 74% rename from src/ansys/edb/simulation_setup/siwave_dcir_simulation_setup.py rename to src/ansys/edb/core/simulation_setup/siwave_dcir_simulation_setup.py index 54a624b22e..2ddc858e7c 100644 --- a/src/ansys/edb/simulation_setup/siwave_dcir_simulation_setup.py +++ b/src/ansys/edb/core/simulation_setup/siwave_dcir_simulation_setup.py @@ -1,7 +1,9 @@ """SIWave Simulation Setup.""" -from ansys.edb.simulation_setup.simulation_setup import SimulationSetup, SimulationSetupType -from ansys.edb.simulation_setup.siwave_dcir_simulation_settings import SIWaveDCIRSimulationSettings +from ansys.edb.core.simulation_setup.simulation_setup import SimulationSetup, SimulationSetupType +from ansys.edb.core.simulation_setup.siwave_dcir_simulation_settings import ( + SIWaveDCIRSimulationSettings, +) class SIWaveDCIRSimulationSetup(SimulationSetup): @@ -13,7 +15,7 @@ def create(cls, cell, name): Parameters ---------- - cell : :class:`Cell ` + cell : :class:`Cell ` Cell containing new simulation setup. name : str Name of new simulation setup diff --git a/src/ansys/edb/simulation_setup/siwave_simulation_settings.py b/src/ansys/edb/core/simulation_setup/siwave_simulation_settings.py similarity index 99% rename from src/ansys/edb/simulation_setup/siwave_simulation_settings.py rename to src/ansys/edb/core/simulation_setup/siwave_simulation_settings.py index 6270ab3985..fda5c4ab6c 100644 --- a/src/ansys/edb/simulation_setup/siwave_simulation_settings.py +++ b/src/ansys/edb/core/simulation_setup/siwave_simulation_settings.py @@ -4,8 +4,8 @@ import ansys.api.edb.v1.siwave_simulation_settings_pb2 as pb -from ansys.edb.core import messages -from ansys.edb.session import ( +from ansys.edb.core.inner import messages +from ansys.edb.core.session import ( SIWaveAdvancedSettingsServiceStub, SIWaveDCAdvancedSettingsServiceStub, SIWaveDCSettingsServiceStub, @@ -14,7 +14,7 @@ StubAccessor, StubType, ) -from ansys.edb.simulation_setup.simulation_settings import ( +from ansys.edb.core.simulation_setup.simulation_settings import ( SimulationSettings, SimulationSettingsBase, ) diff --git a/src/ansys/edb/simulation_setup/siwave_simulation_setup.py b/src/ansys/edb/core/simulation_setup/siwave_simulation_setup.py similarity index 75% rename from src/ansys/edb/simulation_setup/siwave_simulation_setup.py rename to src/ansys/edb/core/simulation_setup/siwave_simulation_setup.py index b86e54099c..2b85c05eb8 100644 --- a/src/ansys/edb/simulation_setup/siwave_simulation_setup.py +++ b/src/ansys/edb/core/simulation_setup/siwave_simulation_setup.py @@ -1,7 +1,7 @@ """SIWave Simulation Setup.""" -from ansys.edb.simulation_setup.simulation_setup import SimulationSetup, SimulationSetupType -from ansys.edb.simulation_setup.siwave_simulation_settings import SIWaveSimulationSettings +from ansys.edb.core.simulation_setup.simulation_setup import SimulationSetup, SimulationSetupType +from ansys.edb.core.simulation_setup.siwave_simulation_settings import SIWaveSimulationSettings class SIWaveSimulationSetup(SimulationSetup): @@ -13,7 +13,7 @@ def create(cls, cell, name): Parameters ---------- - cell : :class:`Cell ` + cell : :class:`Cell ` Cell containing new simulation setup. name : str Name of new simulation setup diff --git a/src/ansys/edb/terminal/__init__.py b/src/ansys/edb/core/terminal/__init__.py similarity index 87% rename from src/ansys/edb/terminal/__init__.py rename to src/ansys/edb/core/terminal/__init__.py index 630b57b548..208ae44b0f 100644 --- a/src/ansys/edb/terminal/__init__.py +++ b/src/ansys/edb/core/terminal/__init__.py @@ -1,6 +1,6 @@ """Import terminal classes.""" -from ansys.edb.terminal.terminals import ( +from ansys.edb.core.terminal.terminals import ( BoundaryType, BundleTerminal, Edge, diff --git a/src/ansys/edb/terminal/terminals.py b/src/ansys/edb/core/terminal/terminals.py similarity index 98% rename from src/ansys/edb/terminal/terminals.py rename to src/ansys/edb/core/terminal/terminals.py index 28f02e80ad..562fdf796c 100644 --- a/src/ansys/edb/terminal/terminals.py +++ b/src/ansys/edb/core/terminal/terminals.py @@ -5,13 +5,13 @@ import ansys.api.edb.v1.edge_term_pb2 as edge_term_pb2 import ansys.api.edb.v1.term_pb2 as term_pb2 -from ansys.edb import hierarchy, primitive -from ansys.edb.core import ObjBase, TypeField, conn_obj, messages, parser -from ansys.edb.edb_defs import LayoutObjType -from ansys.edb.geometry import ArcData -from ansys.edb.layer import Layer -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility import PortPostProcessingProp, Value +from ansys.edb.core import hierarchy, primitive +from ansys.edb.core.edb_defs import LayoutObjType +from ansys.edb.core.geometry import ArcData +from ansys.edb.core.inner import ObjBase, TypeField, conn_obj, messages, parser +from ansys.edb.core.layer import Layer +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility import PortPostProcessingProp, Value class TerminalType(Enum): diff --git a/src/ansys/edb/typing/__init__.py b/src/ansys/edb/core/typing/__init__.py similarity index 78% rename from src/ansys/edb/typing/__init__.py rename to src/ansys/edb/core/typing/__init__.py index af451aeefe..37a4685aaa 100644 --- a/src/ansys/edb/typing/__init__.py +++ b/src/ansys/edb/core/typing/__init__.py @@ -2,8 +2,8 @@ from typing import Iterable, Tuple, Union -import ansys.edb.geometry.point_data as point_data -import ansys.edb.utility.value as value +import ansys.edb.core.geometry.point_data as point_data +import ansys.edb.core.utility.value as value ValueLike = Union[int, float, complex, str, value.Value] PointLike = Union[point_data.PointData, Iterable[ValueLike]] diff --git a/src/ansys/edb/core/utility/__init__.py b/src/ansys/edb/core/utility/__init__.py new file mode 100644 index 0000000000..1c366068b1 --- /dev/null +++ b/src/ansys/edb/core/utility/__init__.py @@ -0,0 +1,14 @@ +"""This package contains utility classes and functions available to users.""" + +from ansys.edb.core.utility.heat_sink import HeatSink +from ansys.edb.core.utility.hfss_extent_info import HfssExtentInfo +from ansys.edb.core.utility.material_property_thermal_modifier_params import ( + AdvancedQuadraticParams, + BasicQuadraticParams, +) +from ansys.edb.core.utility.port_post_processing_prop import PortPostProcessingProp +from ansys.edb.core.utility.rlc import PinPair, PinPairRlc, Rlc +from ansys.edb.core.utility.temperature_settings import TemperatureSettings +from ansys.edb.core.utility.transform3d import Transform3D +from ansys.edb.core.utility.transform import Transform +from ansys.edb.core.utility.value import Value diff --git a/src/ansys/edb/utility/conversions.py b/src/ansys/edb/core/utility/conversions.py similarity index 92% rename from src/ansys/edb/utility/conversions.py rename to src/ansys/edb/core/utility/conversions.py index 9e8535001b..46bcd6412e 100644 --- a/src/ansys/edb/utility/conversions.py +++ b/src/ansys/edb/core/utility/conversions.py @@ -1,7 +1,7 @@ """This module performs conversions from arbitrary user input to explicit types.""" from ansys.api.edb.v1.edb_messages_pb2 import ValueMessage -from ansys.edb import geometry, utility +from ansys.edb.core import geometry, utility def to_value(val): @@ -9,7 +9,7 @@ def to_value(val): Parameters ---------- - val : ansys.edb.typing.ValueLike + val : ansys.edb.core.typing.ValueLike Returns ------- @@ -30,7 +30,7 @@ def to_point(val): Parameters ---------- - val : ansys.edb.typing.PointLike + val : ansys.edb.core.typing.PointLike Returns ------- diff --git a/src/ansys/edb/utility/heat_sink.py b/src/ansys/edb/core/utility/heat_sink.py similarity index 96% rename from src/ansys/edb/utility/heat_sink.py rename to src/ansys/edb/core/utility/heat_sink.py index e6786ed55d..08f7566de4 100644 --- a/src/ansys/edb/utility/heat_sink.py +++ b/src/ansys/edb/core/utility/heat_sink.py @@ -4,7 +4,7 @@ import ansys.api.edb.v1.package_def_pb2 as pb -from ansys.edb.utility import conversions +from ansys.edb.core.utility import conversions class HeatSinkFinOrientation(Enum): diff --git a/src/ansys/edb/utility/hfss_extent_info.py b/src/ansys/edb/core/utility/hfss_extent_info.py similarity index 92% rename from src/ansys/edb/utility/hfss_extent_info.py rename to src/ansys/edb/core/utility/hfss_extent_info.py index ca33d27566..f250f77c4d 100644 --- a/src/ansys/edb/utility/hfss_extent_info.py +++ b/src/ansys/edb/core/utility/hfss_extent_info.py @@ -4,8 +4,8 @@ import ansys.api.edb.v1.edb_defs_pb2 as edb_defs_pb2 -from ansys.edb.utility import conversions -from ansys.edb.utility.value import Value +from ansys.edb.core.utility import conversions +from ansys.edb.core.utility.value import Value class HfssExtentInfo: @@ -23,7 +23,7 @@ class HfssExtentInfo: Polygon to use if extent type is Polygon. dielectric_extent_type: HfssExtentInfo.HFSSExtentInfoType Dielectric extent type. - dielectric_base_polygon: :class:`Primitive ` + dielectric_base_polygon: :class:`Primitive ` Polygon to use if dielectric extent type is Polygon. dielectric: (float, bool) Dielectric extent size. First parameter is the value and second parameter \ @@ -45,9 +45,9 @@ class HfssExtentInfo: Whether airbox positive and negative vertical extent will be synchronized. is_pml_visible: bool Check to see if the PML boxes should be rendered or not. - operating_frequency: :class:`Value ` + operating_frequency: :class:`Value ` PML Operating Frequency. - radiation_level: :class:`Value ` + radiation_level: :class:`Value ` PML Radiation level to calculate the thickness of boundary. user_xy_data_extent_for_vertical_expansion: bool if true, retain the old behaviour for the vertical expansion of the airbox. @@ -118,7 +118,7 @@ def __init__( Polygon to use if extent type is Polygon. dielectric_extent_type: HfssExtentInfo.HFSSExtentInfoType Dielectric extent type. - dielectric_base_polygon: :class:`Primitive ` + dielectric_base_polygon: :class:`Primitive ` Polygon to use if dielectric extent type is Polygon. dielectric: (float, bool) Dielectric extent size. First parameter is the value and second parameter \ @@ -140,9 +140,9 @@ def __init__( Whether airbox positive and negative vertical extent will be synchronized. is_pml_visible: bool Check to see if the PML boxes should be rendered or not. - operating_frequency: :class:`Value ` + operating_frequency: :class:`Value ` PML Operating Frequency. - radiation_level: :class:`Value ` + radiation_level: :class:`Value ` PML Radiation level to calculate the thickness of boundary. user_xy_data_extent_for_vertical_expansion: bool if true, retain the old behaviour for the vertical expansion of the airbox. diff --git a/src/ansys/edb/utility/layer_map.py b/src/ansys/edb/core/utility/layer_map.py similarity index 96% rename from src/ansys/edb/utility/layer_map.py rename to src/ansys/edb/core/utility/layer_map.py index f6fe356766..ebc30a94f2 100644 --- a/src/ansys/edb/utility/layer_map.py +++ b/src/ansys/edb/core/utility/layer_map.py @@ -4,8 +4,8 @@ from ansys.api.edb.v1 import layer_map_pb2 as pb -from ansys.edb.core import ObjBase, messages -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.session import StubAccessor, StubType class _QueryBuilder: diff --git a/src/ansys/edb/utility/material_property_thermal_modifier_params.py b/src/ansys/edb/core/utility/material_property_thermal_modifier_params.py similarity index 98% rename from src/ansys/edb/utility/material_property_thermal_modifier_params.py rename to src/ansys/edb/core/utility/material_property_thermal_modifier_params.py index 826ef643a1..2b998077c0 100644 --- a/src/ansys/edb/utility/material_property_thermal_modifier_params.py +++ b/src/ansys/edb/core/utility/material_property_thermal_modifier_params.py @@ -1,6 +1,6 @@ """Class representing Material Property Thermal Modifier Parameters.""" -from ansys.edb.utility.value import Value +from ansys.edb.core.utility.value import Value class BasicQuadraticParams: diff --git a/src/ansys/edb/utility/port_post_processing_prop.py b/src/ansys/edb/core/utility/port_post_processing_prop.py similarity index 98% rename from src/ansys/edb/utility/port_post_processing_prop.py rename to src/ansys/edb/core/utility/port_post_processing_prop.py index 689f177ec0..11ec56c177 100644 --- a/src/ansys/edb/utility/port_post_processing_prop.py +++ b/src/ansys/edb/core/utility/port_post_processing_prop.py @@ -1,6 +1,6 @@ """Port Post Processing Prop.""" -from ansys.edb.utility.value import Value +from ansys.edb.core.utility.value import Value class PortPostProcessingProp: diff --git a/src/ansys/edb/utility/rlc.py b/src/ansys/edb/core/utility/rlc.py similarity index 98% rename from src/ansys/edb/utility/rlc.py rename to src/ansys/edb/core/utility/rlc.py index 12d4ac0a86..a51cc599f8 100644 --- a/src/ansys/edb/utility/rlc.py +++ b/src/ansys/edb/core/utility/rlc.py @@ -1,6 +1,6 @@ """RLC.""" -from ansys.edb.utility.value import Value +from ansys.edb.core.utility.value import Value class Rlc: diff --git a/src/ansys/edb/utility/temperature_settings.py b/src/ansys/edb/core/utility/temperature_settings.py similarity index 95% rename from src/ansys/edb/utility/temperature_settings.py rename to src/ansys/edb/core/utility/temperature_settings.py index 1535ef843a..826ca2f7d8 100644 --- a/src/ansys/edb/utility/temperature_settings.py +++ b/src/ansys/edb/core/utility/temperature_settings.py @@ -1,5 +1,5 @@ """Temperature Settings.""" -from ansys.edb.utility.value import Value +from ansys.edb.core.utility.value import Value class TemperatureSettings: diff --git a/src/ansys/edb/utility/transform.py b/src/ansys/edb/core/utility/transform.py similarity index 86% rename from src/ansys/edb/utility/transform.py rename to src/ansys/edb/core/utility/transform.py index 3e459e4cee..da738b47a8 100644 --- a/src/ansys/edb/utility/transform.py +++ b/src/ansys/edb/core/utility/transform.py @@ -2,9 +2,9 @@ import ansys.api.edb.v1.transform_pb2 as pb from ansys.api.edb.v1.transform_pb2_grpc import TransformServiceStub -from ansys.edb.core import ObjBase, messages, parser -from ansys.edb.session import StubAccessor, StubType -from ansys.edb.utility.value import Value +from ansys.edb.core.inner import ObjBase, messages, parser +from ansys.edb.core.session import StubAccessor, StubType +from ansys.edb.core.utility.value import Value class _TransformQueryBuilder: @@ -60,7 +60,7 @@ def create(cls, scale, angle, mirror, offset_x, offset_y): @property def scale(self): - """:class:`Value `: Scale property. + """:class:`Value `: Scale property. This property can be set to :term:`ValueLike` """ @@ -72,7 +72,7 @@ def scale(self, value): @property def rotation(self): - """:class:`Value `: Rotation property. + """:class:`Value `: Rotation property. This property can be set to :term:`ValueLike` """ @@ -84,7 +84,7 @@ def rotation(self, value): @property def offset_x(self): - """:class:`Value `: X offset property. + """:class:`Value `: X offset property. This property can be set to :term:`ValueLike` """ @@ -96,7 +96,7 @@ def offset_x(self, value): @property def offset_y(self): - """:class:`Value `: Y offset property. + """:class:`Value `: Y offset property. This property can be set to :term:`ValueLike` """ @@ -144,12 +144,12 @@ def transform_point(self, point): Parameters ---------- - point: :class:`PointData ` + point: :class:`PointData ` The point to transform [x, y] Point values. Returns ------- - :class:`PointData ` + :class:`PointData ` The transformed point """ pnt_msg = self.__stub.TransformPoint(messages.point_property_message(self, point)) @@ -161,12 +161,12 @@ def transform_polygon(self, polygon): Parameters ---------- - polygon: :class:`PolygonData ` + polygon: :class:`PolygonData ` The polygon to transform. Returns ------- - :class:`PolygonData ` + :class:`PolygonData ` The transformed polygon. """ return self.__stub.TransformPolygon(messages.polygon_data_property_message(self, polygon)) diff --git a/src/ansys/edb/utility/transform3d.py b/src/ansys/edb/core/utility/transform3d.py similarity index 97% rename from src/ansys/edb/utility/transform3d.py rename to src/ansys/edb/core/utility/transform3d.py index c590ec5e33..aaa165bce2 100644 --- a/src/ansys/edb/utility/transform3d.py +++ b/src/ansys/edb/core/utility/transform3d.py @@ -3,9 +3,9 @@ from ansys.api.edb.v1.transform3d_pb2_grpc import Transform3DServiceStub from google.protobuf import empty_pb2 -from ansys.edb.core import ObjBase, messages -from ansys.edb.core.parser import to_3_point3d_data, to_point3d_data -from ansys.edb.session import StubAccessor, StubType +from ansys.edb.core.inner import ObjBase, messages +from ansys.edb.core.inner.parser import to_3_point3d_data, to_point3d_data +from ansys.edb.core.session import StubAccessor, StubType class _Transform3DQueryBuilder: @@ -194,7 +194,7 @@ def create_from_transform_2d(cls, transform, z_off): Parameters ---------- - transform : :class:`Transform ` + transform : :class:`Transform ` Transform data. z_off : :obj:`float` Z offset. diff --git a/src/ansys/edb/utility/value.py b/src/ansys/edb/core/utility/value.py similarity index 95% rename from src/ansys/edb/utility/value.py rename to src/ansys/edb/core/utility/value.py index d577e306ab..c92dcfb232 100644 --- a/src/ansys/edb/utility/value.py +++ b/src/ansys/edb/core/utility/value.py @@ -4,9 +4,9 @@ from ansys.api.edb.v1 import value_pb2, value_pb2_grpc from ansys.api.edb.v1.edb_messages_pb2 import ValueMessage -from ansys.edb import session -from ansys.edb.core import messages -from ansys.edb.utility import conversions +from ansys.edb.core import session +from ansys.edb.core.inner import messages +from ansys.edb.core.utility import conversions class Value: @@ -16,8 +16,9 @@ class Value: ---------- val : :term:`ValueLike` The value assigned to the new Value - _owner : None, :class:`Database `, :class:`Cell `, - :class:`Layout `, :class:`ComponentDef ` + _owner : None, :class:`Database `, :class:`Cell `, + :class:`Layout `, \ + :class:`ComponentDef ` Notes ----- diff --git a/src/ansys/edb/definition/__init__.py b/src/ansys/edb/definition/__init__.py deleted file mode 100644 index d24eb888fd..0000000000 --- a/src/ansys/edb/definition/__init__.py +++ /dev/null @@ -1,44 +0,0 @@ -"""Import definition classes.""" - -from ansys.edb.definition.bondwire_def import ( - ApdBondwireDef, - BondwireDef, - BondwireDefType, - Jedec4BondwireDef, - Jedec5BondwireDef, -) -from ansys.edb.definition.component_def import ComponentDef -from ansys.edb.definition.component_model import ( - ComponentModel, - DynamicLinkComponentModel, - NPortComponentModel, -) -from ansys.edb.definition.component_pin import ComponentPin -from ansys.edb.definition.component_property import ComponentProperty -from ansys.edb.definition.dataset_def import DatasetDef -from ansys.edb.definition.debye_model import DebyeModel -from ansys.edb.definition.die_property import DieOrientation, DieProperty, DieType -from ansys.edb.definition.dielectric_material_model import ( - DielectricMaterialModel, - DielectricMaterialModelType, -) -from ansys.edb.definition.djordjecvic_sarkar_model import DjordjecvicSarkarModel -from ansys.edb.definition.ic_component_property import ICComponentProperty -from ansys.edb.definition.io_component_property import IOComponentProperty -from ansys.edb.definition.material_def import MaterialDef, MaterialProperty, ThermalModifier -from ansys.edb.definition.material_property_thermal_modifier import MaterialPropertyThermalModifier -from ansys.edb.definition.multipole_debye_model import MultipoleDebyeModel -from ansys.edb.definition.package_def import PackageDef -from ansys.edb.definition.padstack_def import PadstackDef -from ansys.edb.definition.padstack_def_data import ( - PadGeometryType, - PadstackDefData, - PadstackHoleRange, - PadType, - SolderballPlacement, - SolderballShape, -) -from ansys.edb.definition.port_property import PortProperty -from ansys.edb.definition.rlc_component_property import RLCComponentProperty -from ansys.edb.definition.solder_ball_property import SolderBallProperty -from ansys.edb.edb_defs import DefinitionObjType diff --git a/src/ansys/edb/geometry/__init__.py b/src/ansys/edb/geometry/__init__.py deleted file mode 100644 index f5f5006522..0000000000 --- a/src/ansys/edb/geometry/__init__.py +++ /dev/null @@ -1,8 +0,0 @@ -"""Import geometry classes.""" - -from ansys.edb.geometry.arc_data import ArcData -from ansys.edb.geometry.point3d_data import Point3DData -from ansys.edb.geometry.point_data import PointData -from ansys.edb.geometry.polygon_data import ExtentType, PolygonData, PolygonSenseType -from ansys.edb.geometry.r_tree import RTree -from ansys.edb.geometry.triangle3d_data import Triangle3DData diff --git a/src/ansys/edb/hierarchy/__init__.py b/src/ansys/edb/hierarchy/__init__.py deleted file mode 100644 index 74f8c74909..0000000000 --- a/src/ansys/edb/hierarchy/__init__.py +++ /dev/null @@ -1,14 +0,0 @@ -"""Import hierarchy classes.""" - -from ansys.edb.hierarchy.cell_instance import CellInstance -from ansys.edb.hierarchy.component_group import ComponentGroup, ComponentType -from ansys.edb.hierarchy.group import Group -from ansys.edb.hierarchy.inst_array import InstArray -from ansys.edb.hierarchy.model import Model -from ansys.edb.hierarchy.netlist_model import NetlistModel -from ansys.edb.hierarchy.pin_group import PinGroup -from ansys.edb.hierarchy.pin_pair_model import PinPairModel -from ansys.edb.hierarchy.sparameter_model import SParameterModel -from ansys.edb.hierarchy.spice_model import SPICEModel -from ansys.edb.hierarchy.structure3d import MeshClosure, Structure3D -from ansys.edb.hierarchy.via_group import ViaGroup diff --git a/src/ansys/edb/layer/__init__.py b/src/ansys/edb/layer/__init__.py deleted file mode 100644 index 6cbc2b8709..0000000000 --- a/src/ansys/edb/layer/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ -"""Import layer classes.""" - -from ansys.edb.layer.layer import ( - DrawOverride, - Layer, - LayerType, - LayerVisibility, - TopBottomAssociation, -) -from ansys.edb.layer.layer_collection import ( - DielectricMergingMethod, - LayerCollection, - LayerCollectionMode, - LayerTypeSet, -) -from ansys.edb.layer.stackup_layer import DCThicknessType, RoughnessRegion, StackupLayer -from ansys.edb.layer.via_layer import ViaLayer diff --git a/src/ansys/edb/layout/__init__.py b/src/ansys/edb/layout/__init__.py deleted file mode 100644 index e6f986d987..0000000000 --- a/src/ansys/edb/layout/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -"""Import layout classes.""" - -from ansys.edb.layout.cell import Cell, CellType, DesignMode -from ansys.edb.layout.layout import Layout -from ansys.edb.layout.mcad_model import McadModel -from ansys.edb.layout.voltage_regulator import PowerModule, VoltageRegulator diff --git a/src/ansys/edb/layout_instance/__init__.py b/src/ansys/edb/layout_instance/__init__.py deleted file mode 100644 index fe6f38c0e8..0000000000 --- a/src/ansys/edb/layout_instance/__init__.py +++ /dev/null @@ -1,8 +0,0 @@ -"""Import layout instance classes.""" - -from ansys.edb.layout_instance.layout_instance import LayoutInstance -from ansys.edb.layout_instance.layout_instance_context import LayoutInstanceContext -from ansys.edb.layout_instance.layout_obj_instance import LayoutObjInstance -from ansys.edb.layout_instance.layout_obj_instance_2d_geometry import LayoutObjInstance2DGeometry -from ansys.edb.layout_instance.layout_obj_instance_3d_geometry import LayoutObjInstance3DGeometry -from ansys.edb.layout_instance.layout_obj_instance_geometry import LayoutObjInstanceGeometry diff --git a/src/ansys/edb/net/__init__.py b/src/ansys/edb/net/__init__.py deleted file mode 100644 index c0a36bddb4..0000000000 --- a/src/ansys/edb/net/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -"""Import net classes.""" - -from ansys.edb.net.differential_pair import DifferentialPair -from ansys.edb.net.extended_net import ExtendedNet -from ansys.edb.net.net import Net -from ansys.edb.net.net_class import NetClass diff --git a/src/ansys/edb/utility/__init__.py b/src/ansys/edb/utility/__init__.py deleted file mode 100644 index 3791aefe00..0000000000 --- a/src/ansys/edb/utility/__init__.py +++ /dev/null @@ -1,14 +0,0 @@ -"""This package contains utility classes and functions available to users.""" - -from ansys.edb.utility.heat_sink import HeatSink -from ansys.edb.utility.hfss_extent_info import HfssExtentInfo -from ansys.edb.utility.material_property_thermal_modifier_params import ( - AdvancedQuadraticParams, - BasicQuadraticParams, -) -from ansys.edb.utility.port_post_processing_prop import PortPostProcessingProp -from ansys.edb.utility.rlc import PinPair, PinPairRlc, Rlc -from ansys.edb.utility.temperature_settings import TemperatureSettings -from ansys.edb.utility.transform3d import Transform3D -from ansys.edb.utility.transform import Transform -from ansys.edb.utility.value import Value diff --git a/tests/e2e/conftest.py b/tests/e2e/conftest.py index b0464cf418..2059b78abf 100644 --- a/tests/e2e/conftest.py +++ b/tests/e2e/conftest.py @@ -1,11 +1,11 @@ import pytest import settings -from ansys.edb.database import Database -from ansys.edb.definition import PadGeometryType, PadstackDef, PadstackDefData, PadType -from ansys.edb.layer import LayerType, StackupLayer -from ansys.edb.layout import Cell, CellType -from ansys.edb.session import session +from ansys.edb.core.database import Database +from ansys.edb.core.definition import PadGeometryType, PadstackDef, PadstackDefData, PadType +from ansys.edb.core.layer import LayerType, StackupLayer +from ansys.edb.core.layout import Cell, CellType +from ansys.edb.core.session import session @pytest.fixture diff --git a/tests/e2e/integration_tests/test_padstack.py b/tests/e2e/integration_tests/test_padstack.py index bdc83020ac..e2041a6810 100644 --- a/tests/e2e/integration_tests/test_padstack.py +++ b/tests/e2e/integration_tests/test_padstack.py @@ -1,5 +1,5 @@ -from ansys.edb.definition import PadGeometryType, PadstackDef -from ansys.edb.layout import Cell +from ansys.edb.core.definition import PadGeometryType, PadstackDef +from ansys.edb.core.layout import Cell def test_get_hole_parameters(circuit_cell_with_padstack_def: Cell): diff --git a/tests/e2e/integration_tests/test_spiral_inductor.py b/tests/e2e/integration_tests/test_spiral_inductor.py index 27a4c126d5..fa6d294f3e 100644 --- a/tests/e2e/integration_tests/test_spiral_inductor.py +++ b/tests/e2e/integration_tests/test_spiral_inductor.py @@ -4,14 +4,20 @@ import settings -from ansys.edb.database import Database -from ansys.edb.definition import MaterialDef, MaterialProperty -from ansys.edb.geometry import PolygonData -from ansys.edb.hierarchy import ViaGroup -from ansys.edb.layer import LayerCollection, LayerCollectionMode, LayerType, StackupLayer, ViaLayer -from ansys.edb.layout import Cell, CellType -from ansys.edb.net import Net -from ansys.edb.primitive import ( +from ansys.edb.core.database import Database +from ansys.edb.core.definition import MaterialDef, MaterialProperty +from ansys.edb.core.geometry import PolygonData +from ansys.edb.core.hierarchy import ViaGroup +from ansys.edb.core.layer import ( + LayerCollection, + LayerCollectionMode, + LayerType, + StackupLayer, + ViaLayer, +) +from ansys.edb.core.layout import Cell, CellType +from ansys.edb.core.net import Net +from ansys.edb.core.primitive import ( Path, PathCornerType, PathEndCapType, @@ -19,18 +25,18 @@ Rectangle, RectangleRepresentationType, ) -from ansys.edb.session import session -from ansys.edb.simulation_setup import ( +from ansys.edb.core.session import session +from ansys.edb.core.simulation_setup import ( HfssSimulationSetup, SingleFrequencyAdaptiveSolution, SkinDepthMeshOperation, SweepData, ) -from ansys.edb.terminal import PointTerminal +from ansys.edb.core.terminal import PointTerminal # Wrapper class over Database # This will ensure clean entry and exit from database -from ansys.edb.utility.hfss_extent_info import HfssExtentInfo +from ansys.edb.core.utility.hfss_extent_info import HfssExtentInfo class TDatabase: diff --git a/tests/e2e/scratch/sim_setup_scratch.py b/tests/e2e/scratch/sim_setup_scratch.py index 1af9e57856..304a8e5147 100644 --- a/tests/e2e/scratch/sim_setup_scratch.py +++ b/tests/e2e/scratch/sim_setup_scratch.py @@ -1,9 +1,9 @@ import settings -from ansys.edb.database import Database -from ansys.edb.layout import Cell, CellType -from ansys.edb.session import session -from ansys.edb.simulation_setup import ( +from ansys.edb.core.database import Database +from ansys.edb.core.layout import Cell, CellType +from ansys.edb.core.session import session +from ansys.edb.core.simulation_setup import ( AdaptType, BasisFunctionOrder, BroadbandAdaptiveSolution, diff --git a/tests/e2e/scratch/test_board_bend_def.py b/tests/e2e/scratch/test_board_bend_def.py index 10ecd329f1..adc05c6399 100644 --- a/tests/e2e/scratch/test_board_bend_def.py +++ b/tests/e2e/scratch/test_board_bend_def.py @@ -1,12 +1,12 @@ import settings -from ansys.edb.database import Database -from ansys.edb.layer import Layer, LayerType -from ansys.edb.layer.layer_collection import LayerCollection, LayerCollectionMode -from ansys.edb.layout import Cell, CellType -from ansys.edb.primitive import BoardBendDef, Rectangle, RectangleRepresentationType -from ansys.edb.session import session -from ansys.edb.utility import Value +from ansys.edb.core.database import Database +from ansys.edb.core.layer import Layer, LayerType +from ansys.edb.core.layer.layer_collection import LayerCollection, LayerCollectionMode +from ansys.edb.core.layout import Cell, CellType +from ansys.edb.core.primitive import BoardBendDef, Rectangle, RectangleRepresentationType +from ansys.edb.core.session import session +from ansys.edb.core.utility import Value def do_test(): diff --git a/tests/e2e/scratch/test_component_property.py b/tests/e2e/scratch/test_component_property.py index ebd2983707..84636e8504 100644 --- a/tests/e2e/scratch/test_component_property.py +++ b/tests/e2e/scratch/test_component_property.py @@ -1,7 +1,7 @@ import settings -from ansys.edb.database import Database -from ansys.edb.definition import ( +from ansys.edb.core.database import Database +from ansys.edb.core.definition import ( ComponentDef, DieOrientation, DieProperty, @@ -14,10 +14,10 @@ SolderBallProperty, SolderballShape, ) -from ansys.edb.hierarchy import ComponentGroup, ComponentType, PinPairModel -from ansys.edb.layout import Cell, CellType -from ansys.edb.session import session -from ansys.edb.utility import Rlc +from ansys.edb.core.hierarchy import ComponentGroup, ComponentType, PinPairModel +from ansys.edb.core.layout import Cell, CellType +from ansys.edb.core.session import session +from ansys.edb.core.utility import Rlc def do_test(): diff --git a/tests/e2e/scratch/test_power_module.py b/tests/e2e/scratch/test_power_module.py index 676da210b6..278a875410 100644 --- a/tests/e2e/scratch/test_power_module.py +++ b/tests/e2e/scratch/test_power_module.py @@ -1,8 +1,8 @@ import settings -from ansys.edb.database import Database -from ansys.edb.layout import Cell, CellType, PowerModule, VoltageRegulator -from ansys.edb.session import launch_session +from ansys.edb.core.database import Database +from ansys.edb.core.layout import Cell, CellType, PowerModule, VoltageRegulator +from ansys.edb.core.session import launch_session def test_power_module(): diff --git a/tests/e2e/scratch/test_value.py b/tests/e2e/scratch/test_value.py index a06e8a2d94..959ec80b2b 100644 --- a/tests/e2e/scratch/test_value.py +++ b/tests/e2e/scratch/test_value.py @@ -1,12 +1,12 @@ import settings -from ansys.edb.database import Database -from ansys.edb.layer import LayerType, StackupLayer -from ansys.edb.layout import Cell, CellType -from ansys.edb.net import Net -from ansys.edb.primitive import Circle -from ansys.edb.session import launch_session -from ansys.edb.utility import Value +from ansys.edb.core.database import Database +from ansys.edb.core.layer import LayerType, StackupLayer +from ansys.edb.core.layout import Cell, CellType +from ansys.edb.core.net import Net +from ansys.edb.core.primitive import Circle +from ansys.edb.core.session import launch_session +from ansys.edb.core.utility import Value def test_value(): diff --git a/tests/mock/test_arc_data.py b/tests/mock/test_arc_data.py index 6bac43f456..84a5f23357 100644 --- a/tests/mock/test_arc_data.py +++ b/tests/mock/test_arc_data.py @@ -5,7 +5,7 @@ import pytest from utils.fixtures import * # noqa -from ansys.edb import geometry, utility +from ansys.edb.core import geometry, utility @pytest.mark.parametrize( diff --git a/tests/mock/test_database.py b/tests/mock/test_database.py index c3706b7b74..06f5b91c36 100644 --- a/tests/mock/test_database.py +++ b/tests/mock/test_database.py @@ -3,9 +3,9 @@ from utils.fixtures import * # noqa from utils.test_utils import create_edb_obj_collection_msg, equals -from ansys.edb import database as database -from ansys.edb.core.messages import bool_message, empty_message, int64_message, str_message -from ansys.edb.layout import Cell +from ansys.edb.core import database as database +from ansys.edb.core.inner.messages import bool_message, empty_message, int64_message, str_message +from ansys.edb.core.layout import Cell # Helper fixtures and functions diff --git a/tests/mock/test_metadata.py b/tests/mock/test_metadata.py index 096fe8770f..afd04417f4 100644 --- a/tests/mock/test_metadata.py +++ b/tests/mock/test_metadata.py @@ -1,4 +1,4 @@ -from ansys.edb import __version__ +from ansys.edb.core import __version__ def test_pkg_version(): diff --git a/tests/mock/test_point_data.py b/tests/mock/test_point_data.py index 8cda2ed738..5bb62b83c8 100644 --- a/tests/mock/test_point_data.py +++ b/tests/mock/test_point_data.py @@ -1,8 +1,8 @@ import ansys.api.edb.v1.edb_messages_pb2 as edb_messages_pb2 from utils.fixtures import * # noqa -import ansys.edb.geometry.point_data as point_data -import ansys.edb.utility.value as value +import ansys.edb.core.geometry.point_data as point_data +import ansys.edb.core.utility.value as value @pytest.mark.parametrize( diff --git a/tests/mock/test_terminals.py b/tests/mock/test_terminals.py index ed562c4172..6ebd05e244 100644 --- a/tests/mock/test_terminals.py +++ b/tests/mock/test_terminals.py @@ -3,17 +3,17 @@ from utils.fixtures import * # noqa from utils.test_utils import create_edb_obj_msgs, equals -from ansys.edb import terminal -from ansys.edb.core import messages -import ansys.edb.layer as layer_api -from ansys.edb.utility import PortPostProcessingProp, Rlc +from ansys.edb.core import terminal +from ansys.edb.core.inner import messages +import ansys.edb.core.layer as layer_api +from ansys.edb.core.utility import PortPostProcessingProp, Rlc @pytest.fixture def patch(mocker): def _patch(cls): mock = mocker.Mock() - path = f"ansys.edb.terminal.terminals.{cls.__name__}._{cls.__name__}__stub" + path = f"ansys.edb.core.terminal.terminals.{cls.__name__}._{cls.__name__}__stub" mocker.patch(path, mock) return mock diff --git a/tests/mock/utils/fixtures.py b/tests/mock/utils/fixtures.py index ca0377dcc9..0ed0fffdcf 100644 --- a/tests/mock/utils/fixtures.py +++ b/tests/mock/utils/fixtures.py @@ -3,9 +3,9 @@ import pytest -from ansys.edb.layer import Layer -from ansys.edb.layout import Layout -from ansys.edb.net import Net +from ansys.edb.core.layer import Layer +from ansys.edb.core.layout import Layout +from ansys.edb.core.net import Net from .test_utils import create_edb_obj_msg, generate_random_int diff --git a/tests/mock/utils/test_utils.py b/tests/mock/utils/test_utils.py index 14b7b14e04..bee14229dd 100644 --- a/tests/mock/utils/test_utils.py +++ b/tests/mock/utils/test_utils.py @@ -2,7 +2,7 @@ from ansys.api.edb.v1.edb_messages_pb2 import EDBObjCollectionMessage, EDBObjMessage -from ansys.edb.core import ObjBase +from ansys.edb.core.inner import ObjBase # Comparison utils diff --git a/tox.ini b/tox.ini index e521f78713..eb66cec3d9 100644 --- a/tox.ini +++ b/tox.ini @@ -1,7 +1,7 @@ [tox] description = Default tox environments list envlist = - style,{py37,py38,py39,py310},doc + style,{py38,py39,py310},doc skip_missing_interpreters = true isolated_build = true isolated_build_env = build @@ -9,7 +9,6 @@ isolated_build_env = build [gh-actions] description = The tox environment to be executed in gh-actions for a given python version python = - 3.7: style,py37-coverage,doc 3.8: style,py38-coverage,doc 3.9: style,py39-coverage,doc 3.10: style,py310-coverage,doc @@ -17,7 +16,6 @@ python = [testenv] description = Checks for project unit tests basepython = - py37: python3.7 py38: python3.8 py39: python3.9 py310: python3.10 @@ -25,24 +23,24 @@ basepython = setenv = PYTHONUNBUFFERED = yes -deps = - -r {toxinidir}/requirements/requirements_tests.txt - -e ./protos install_command = python -m pip install {opts} {packages} -commands = - pytest {posargs} {env:PYTEST_EXTRA_ARGS:} - [testenv:test] description = Checks for project unit tests setenv = PYTEST_EXTRA_ARGS = --junitxml=junit/test-results.xml +commands = + python -m pip install .[tests] + pytest {posargs} {env:PYTEST_EXTRA_ARGS:} [testenv:coverage] description = Checks for project unit tests and coverage setenv = PYTEST_EXTRA_ARGS = --cov=ansys.edb --cov-report=term --cov-report=xml --cov-report=html +commands = + python -m pip install .[tests] + pytest {posargs} {env:PYTEST_EXTRA_ARGS:} [testenv:style] @@ -56,16 +54,12 @@ commands = [testenv:doc] description = Check if documentation generates properly -deps = - -r {toxinidir}/requirements/requirements_doc.txt - -e ./protos commands = + python -m pip install .[doc] sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out" --color -vW -bhtml [testenv:notebook] description = Run Jupyter notebook -deps = - -r {toxinidir}/requirements/requirements_notebook.txt - -e ./protos commands = + python -m pip install .[notebook] jupyter notebook notebooks