EDBCommon#

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

Provides the generic API for controlling EDB.

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

Parameters:
backend_propertiesbackend.models.Properties

Updated properties.

Examples

>>> from ansys.aedt.toolkits.common.backend.api import EDBCommon
>>> toolkit_api = EDBCommon()
>>> toolkit_api.load_edb("path/to/file")

Methods

EDBCommon.aedt_sessions()

Get information for the active AEDT sessions.

EDBCommon.close_edb()

Close the EDB project.

EDBCommon.get_properties()

Get the toolkit properties.

EDBCommon.get_thread_status()

Get the toolkit thread status.

EDBCommon.installed_aedt_version()

Get the installed AEDT versions.

EDBCommon.launch_thread(process)

Launch the thread.

EDBCommon.load_edb([edb_path])

Load the EDB project.

EDBCommon.save_edb([edb_path])

Save the EDB project.

EDBCommon.serialize_obj_base64(file_path)

Encode a bytes-like object.

EDBCommon.set_properties(data)

Assign the passed data to the internal data model.

EDBCommon.wait_to_be_idle([timeout])

Wait for the thread to be idle and ready to accept a new task.