UnsupportedCommands

class ansys.geometry.core.tools.unsupported.UnsupportedCommands(grpc_client: ansys.geometry.core.connection.GrpcClient, modeler: ansys.geometry.core.modeler.Modeler, _internal_use: bool = False)

Provides unsupported commands for PyAnsys Geometry.

Parameters:

grpc_clientGrpcClient

gRPC client to use for the geometry commands.

modelerModeler

Modeler instance to use for the geometry commands.

_internal_usebool, optional

Internal flag to prevent direct instantiation by users. This parameter is for internal use only.

Raises:

GeometryRuntimeError

If the class is instantiated directly by users instead of through the modeler.

Notes

This class should not be instantiated directly. Use modeler.unsupported instead.

Overview

Methods

set_export_id	Set the persistent id for the moniker.
set_multiple_export_ids	Set multiple persistent ids for the monikers.
get_body_occurrences_from_import_id	Get all body occurrences whose master has the given import id.
get_face_occurrences_from_import_id	Get all face occurrences whose master has the given import id.
get_edge_occurrences_from_import_id	Get all edge occurrences whose master has the given import id.

Import detail

from ansys.geometry.core.tools.unsupported import UnsupportedCommands

Method detail

UnsupportedCommands.set_export_id(moniker: str, id_type: PersistentIdType, value: str) → None

Set the persistent id for the moniker.

Parameters:

monikerstr

Moniker to set the id for.

id_typePersistentIdType

Type of id.

valuestr

Id to set.

Warning

This method is only available starting on Ansys release 25R2.

UnsupportedCommands.set_multiple_export_ids(export_data: list[ExportIdData]) → None

Set multiple persistent ids for the monikers.

Parameters:

export_datalist[ExportIdData]

List of export data containing monikers, id types, and values.

Warning

This method is only available starting on Ansys release 26R1.

UnsupportedCommands.get_body_occurrences_from_import_id(import_id: str, id_type: PersistentIdType) → list[ansys.geometry.core.designer.body.Body]

Get all body occurrences whose master has the given import id.

Parameters:

import_idstr

Persistent id

id_typePersistentIdType

Type of id

Returns:

list[Body]

List of body occurrences.

UnsupportedCommands.get_face_occurrences_from_import_id(import_id: str, id_type: PersistentIdType) → list[ansys.geometry.core.designer.face.Face]

Get all face occurrences whose master has the given import id.

Parameters:

import_idstr

Persistent id.

id_typePersistentIdType

Type of id.

Returns:

list[Face]

List of face occurrences.

UnsupportedCommands.get_edge_occurrences_from_import_id(import_id: str, id_type: PersistentIdType) → list[ansys.geometry.core.designer.edge.Edge]

Get all edge occurrences whose master has the given import id.

Parameters:

import_idstr

Persistent id.

id_typePersistentIdType

Type of id.

Returns:

list[Edge]

List of edge occurrences.