AEDTCommon#

class ansys.aedt.toolkits.common.backend.api.AEDTCommon(backend_properties: ThreadManager | None = None)[source]#

Provides common functions for controlling AEDT.

This class provides basic functions for controlling AEDT and properties to share between the backend and UI.

Parameters:

Examples

>>> from ansys.aedt.toolkits.common.backend.api import AEDTCommon
>>> toolkit_api = AEDTCommon()
>>> msg = toolkit_api.launch_aedt()

Methods

`AEDTCommon.aedt_sessions`()	Get information for the active AEDT sessions.
`AEDTCommon.connect_aedt`()	Connect to an existing AEDT session.
`AEDTCommon.connect_design`([app_name])	Connect to an application design.
`AEDTCommon.export_aedt_model`([obj_list, ...])	Export the model in the OBJ format and then encode the file if the `encode` parameter is enabled.
`AEDTCommon.get_design_names`()	Get the design names for a specific project.
`AEDTCommon.get_project_name`(project_path)	Get the project name from the project path.
`AEDTCommon.get_properties`()	Get the toolkit properties.
`AEDTCommon.get_thread_status`()	Get the toolkit thread status.
`AEDTCommon.installed_aedt_version`()	Get the installed AEDT versions.
`AEDTCommon.is_aedt_connected`()	Check if AEDT is connected.
`AEDTCommon.launch_aedt`()	Launch AEDT.
`AEDTCommon.launch_thread`(process)	Launch the thread.
`AEDTCommon.open_project`([project_name])	Open an AEDT project.
`AEDTCommon.release_aedt`([close_projects, ...])	Release AEDT.
`AEDTCommon.save_project`([project_path, ...])	Save the project.
`AEDTCommon.serialize_obj_base64`(file_path)	Encode a bytes-like object.
`AEDTCommon.set_properties`(data)	Assign the passed data to the internal data model.
`AEDTCommon.wait_to_be_idle`([timeout])	Wait for the thread to be idle and ready to accept a new task.