Skip to main content

Mechanical scripting interface

GeometryImport

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.GeometryImport

Bases: object

Defines a GeometryImport.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Duplicate Creates a copy of the current DataModelObject.
GetChildren Gets the list of children, filtered by type.
GetFormat Gets the format of the geometry file/data for the most recent import.
GetGeometryURI Gets the Geometry URI for the most recent import. The Universal Resource Identifier,
GetParameter Gets the parameter corresponding to the given property.
GetPreferences Gets the preferences for most recent import operations with the geometry file/data.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
Import Import/reload geometry from the CAD file using the provided preferences.

<br/>**<br/>

* If no
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Parts List of parts created by the most recent import operation.
Properties Gets the list of properties for this object.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property GeometryImport.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property GeometryImport.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property GeometryImport.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property GeometryImport.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property GeometryImport.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property GeometryImport.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSGeometryImportAuto | None

Gets the internal object. For advanced usage only.

property GeometryImport.Parts : List[Any] | None

List of parts created by the most recent import operation.

property GeometryImport.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property GeometryImport.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

GeometryImport.Activate()

Activate the current object.

GeometryImport.AddComment()

Creates a new child Comment.

GeometryImport.AddFigure()

Creates a new child Figure.

GeometryImport.AddImage(filePath: str)

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

GeometryImport.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

GeometryImport.CreateParameter(propName: str)

Creates a new parameter for a Property.

GeometryImport.Duplicate()

Creates a copy of the current DataModelObject.

GeometryImport.GetChildren(recurses: bool, children: List[ChildrenType])

Gets the list of children, filtered by type.

GeometryImport.GetFormat()

Gets the format of the geometry file/data for the most recent import.

GeometryImport.GetGeometryURI()

Gets the Geometry URI for the most recent import. The Universal Resource Identifier,
which on disk would be "file://..."

GeometryImport.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

GeometryImport.GetPreferences()

Gets the preferences for most recent import operations with the geometry file/data.

GeometryImport.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

GeometryImport.GroupSimilarObjects()

Run the GroupSimilarObjects action.

GeometryImport.Import(geometryURI: str, format: Ansys.Mechanical.DataModel.Enums.GeometryImportPreference.Format, preferences: Ansys.ACT.Mechanical.Utilities.GeometryImportPreferences)

Import/reload geometry from the CAD file using the provided preferences. *** If no
preference argument is provided, i.e., null is used (also the default argument), then
default values from Mechanical preferences will be used (Mechanical: File -> Options:
Import; this will need to be implemented). Previously used preferences are always purged
during an import operation. *** The parts will be read into the Geometry.

GeometryImport.PropertyByAPIName(name: str)

Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

GeometryImport.PropertyByName(name: str)

Get a property by its unique name.

GeometryImport.RemoveParameter(propName: str)

Removes the parameter from the parameter set corresponding to the given property.