ToolkitBackend#

class ansys.aedt.toolkits.radar_explorer.backend.api.ToolkitBackend[source]#

API to control the toolkit workflow.

This class provides methods to connect to a selected design and create geometries.

Examples

>>> from ansys.aedt.toolkits.radar_explorer.backend.api import ToolkitBackend
>>> toolkit_api = ToolkitBackend()
>>> toolkit_api.launch_aedt()
>>> toolkit_api.wait_to_be_idle()

Methods

`ToolkitBackend.add_plane_wave`([name, ...])	Insert plane wave.
`ToolkitBackend.add_setup`([name])	Insert setup.
`ToolkitBackend.aedt_sessions`()	Get information for the active AEDT sessions.
`ToolkitBackend.analyze`()	Analyze the design.
`ToolkitBackend.connect_aedt`()	Connect to an existing AEDT session.
`ToolkitBackend.connect_design`([app_name])	Connect to an application design.
`ToolkitBackend.duplicate_sbr_design`([name])	Duplicate an existing SBR+ design.
`ToolkitBackend.export_aedt_model`([obj_list, ...])	Export the model in the OBJ format and then encode the file if the `encode` parameter is enabled.
`ToolkitBackend.export_rcs`([excitation, ...])	Get RCS data.
`ToolkitBackend.generate_3d_component`()	Generate a 3D component from current design.
`ToolkitBackend.get_design_names`()	Get the design names for a specific project.
`ToolkitBackend.get_materials`()	Get available materials.
`ToolkitBackend.get_plane_waves`()	Get plane waves.
`ToolkitBackend.get_project_name`(project_path)	Get the project name from the project path.
`ToolkitBackend.get_properties`()	Get the toolkit properties.
`ToolkitBackend.get_setups`()	Get setups.
`ToolkitBackend.get_sweeps`()	Get sweeps.
`ToolkitBackend.get_thread_status`()	Get the toolkit thread status.
`ToolkitBackend.insert_cad_sbr`([name])	Insert CAD in the SBR+ design.
`ToolkitBackend.insert_sbr_design`(input_file)	Insert SBR+ design and insert a component if passed.
`ToolkitBackend.installed_aedt_version`()	Get the installed AEDT versions.
`ToolkitBackend.is_aedt_connected`()	Check if AEDT is connected.
`ToolkitBackend.is_sbr_design`()	Check if the design is the SBR+ solution type.
`ToolkitBackend.launch_aedt`()	Launch AEDT.
`ToolkitBackend.launch_thread`(process, *args)	Launch the thread.
`ToolkitBackend.open_project`([project_name])	Open an AEDT project.
`ToolkitBackend.release_aedt`([...])	Release AEDT.
`ToolkitBackend.save_project`([project_path, ...])	Save the project.
`ToolkitBackend.serialize_obj_base64`(file_path)	Encode a bytes-like object.
`ToolkitBackend.set_properties`(data)	Assign the passed data to the internal data model.
`ToolkitBackend.update_isar_2d_properties`([...])	Update radar setup properties for the range profile.
`ToolkitBackend.update_range_profile_properties`([...])	Update radar setup properties for range profile.
`ToolkitBackend.update_rcs_properties`([...])	Update radar setup properties for RCS.
`ToolkitBackend.update_waterfall_properties`([...])	Update radar setup properties for waterfall.
`ToolkitBackend.wait_to_be_idle`([timeout])	Wait for the thread to be idle and ready to accept a new task.