ToolkitBackend#

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

Provides methods for controlling the toolkit workflow.

This class provides methods for creating an AEDT session, connecting to an existing AEDT session, and synthesizing and creating an antenna in HFSS.

Examples

>>> from ansys.aedt.toolkits.antenna.backend.api import ToolkitBackend
>>> import time
>>> toolkit = ToolkitBackend()
>>> msg1 = toolkit.launch_aedt()
>>> toolkit.wait_to_be_idle()
>>> toolkit.get_antenna("BowTie")

Methods

`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.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_farfield`([...])	Export far field data and then encode the file if the `encode` parameter is enabled.
`ToolkitBackend.get_antenna`(antenna[, synth_only])	Synthesize and create an antenna in HFSS.
`ToolkitBackend.get_design_names`()	Get the design names for a specific project.
`ToolkitBackend.get_project_name`(project_path)	Get the project name from the project path.
`ToolkitBackend.get_properties`()	Get the toolkit properties.
`ToolkitBackend.get_thread_status`()	Get the toolkit thread status.
`ToolkitBackend.installed_aedt_version`()	Get the installed AEDT versions.
`ToolkitBackend.is_aedt_connected`()	Check if AEDT is connected.
`ToolkitBackend.launch_aedt`()	Launch AEDT.
`ToolkitBackend.launch_thread`(process)	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.scattering_results`()	Get antenna scattering results.
`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_hfss_parameters`(key, val)	Update parameters in HFSS.
`ToolkitBackend.wait_to_be_idle`([timeout])	Wait for the thread to be idle and ready to accept a new task.