ToolkitBackend#

class ansys.aedt.toolkits.magnet_segmentation.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 automating the segmentation and skew of a 3D motor model.

Examples

>>> from ansys.aedt.toolkits.magnet_segmentation.backend.api import ToolkitBackend
>>> toolkit = ToolkitBackend()
>>> toolkit.launch_aedt()

Methods

`ToolkitBackend.aedt_sessions`()	Get information for the active AEDT sessions.
`ToolkitBackend.apply_skew`()	Apply skew to rotor slices.
`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.get_design_names`()	Get the design names for a specific project.
`ToolkitBackend.get_magnet_loss`()	Get magnet loss.
`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.segmentation`()	Apply object segmentation.
`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.validate_and_analyze`()	Validate and analyze the design.
`ToolkitBackend.wait_to_be_idle`([timeout])	Wait for the thread to be idle and ready to accept a new task.