Common#

class ansys.aedt.toolkits.common.backend.api.Common(backend_properties=None)[source]#

Provides the API for controlling the toolkits.

This class provides basic functions to control AEDT and EDB and the properties to share between the backend and UI.

Parameters:

backend_propertiesbackend.models.Properties: Updated properties.

Examples

>>> from ansys.aedt.toolkits.common.backend.api import Common
>>> toolkit_api = Common()
>>> toolkit_properties = toolkit_api.get_properties()
>>> new_properties = {"aedt_version": "2024.2"}
>>> toolkit_api.set_properties(new_properties)
>>> new_properties = toolkit_api.get_properties()

Methods

`Common.aedt_sessions`()	Get information for the active AEDT sessions.
`Common.get_properties`()	Get the toolkit properties.
`Common.get_thread_status`()	Get the toolkit thread status.
`Common.installed_aedt_version`()	Get the installed AEDT versions.
`Common.launch_thread`(process)	Launch the thread.
`Common.serialize_obj_base64`(file_path)	Encode a bytes-like object.
`Common.set_properties`(data)	Assign the passed data to the internal data model.
`Common.wait_to_be_idle`([timeout])	Wait for the thread to be idle and ready to accept a new task.