`GeometryImport`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.GeometryImport#

Bases: object

Defines a GeometryImport.

Overview#

Methods

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

Properties

`Parts`	List of parts created by the most recent import operation.
`InternalObject`	Gets the internal object. For advanced usage only.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`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.Parts: System.Collections.Generic.IList[System.Object] | None: List of parts created by the most recent import operation.

property GeometryImport.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSGeometryImportAuto | None: Gets the internal object. For advanced usage only.

property GeometryImport.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property GeometryImport.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property GeometryImport.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property GeometryImport.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property GeometryImport.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property GeometryImport.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property GeometryImport.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property GeometryImport.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

GeometryImport.GetGeometryURI() → System.String

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

GeometryImport.GetFormat() → Ansys.Mechanical.DataModel.Enums.GeometryImportPreference.Format: Gets the format of the geometry file/data for the most recent import.

GeometryImport.GetPreferences() → Ansys.ACT.Mechanical.Utilities.GeometryImportPreferences: Gets the preferences for most recent import operations with the geometry file/data.

GeometryImport.Import(geometryURI: System.String, format: Ansys.Mechanical.DataModel.Enums.GeometryImportPreference.Format, preferences: Ansys.ACT.Mechanical.Utilities.GeometryImportPreferences) → System.Void

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.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

GeometryImport.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

GeometryImport.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

GeometryImport.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

GeometryImport.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.Activate() → System.Void: Activate the current object.

GeometryImport.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

GeometryImport.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

GeometryImport.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

GeometryImport.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

GeometryImport.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

GeometryImport.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

GeometryImport.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

GeometryImport.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.