Skip to main content

Mechanical scripting interface

ModelImport

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ModelImport

Bases: object

Defines a ModelImport.

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.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
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
AnalysisTypeDimensionSetting Gets or sets the AnalysisTypeDimensionSetting.
ApplicationSourceSetting Gets the ApplicationSourceSetting.
BodyGroupByAnsysElmTypeNumber Gets or sets the BodyGroupByAnsysElmTypeNumber.
BodyGroupByMaterialNumber Gets or sets the BodyGroupByMaterialNumber.
BodyGroupByThickness Gets or sets the BodyGroupByThickness.
Children Gets the list of children.
Comments Gets the list of associated comments.
CreateGeometry Gets or sets the CreateGeometry.
CreateGeometryEdgeComponents Gets or sets the CreateGeometryEdgeComponents.
CreateGeometryFaceComponents Gets or sets the CreateGeometryFaceComponents.
CreateGeometryVertexComponent Gets or sets the CreateGeometryVertexComponent.
DataModelObjectCategory Gets the current DataModelObject’s category.
ElementComponentKey Gets or sets the ElementComponentKey.
ElementOffset Gets or sets the ElementOffset.
FaceComponentKey Gets or sets the FaceComponentKey.
Figures Gets the list of associated figures.
GeometryComponentKey Gets or sets the GeometryComponentKey.
Images Gets the list of associated images.
ImportMaterials Gets or sets the ImportMaterials.
InternalObject Gets the internal object. For advanced usage only.
MaterialConsolidation Gets or sets the MaterialConsolidation.
ModelImportSourceFilePath Gets or sets the ModelImportSourceFilePath.
NodalComponentKey Gets or sets the NodalComponentKey.
NodeAndElementRenumberingMethod Gets or sets the NodeAndElementRenumberingMethod.
NodeOffset Gets or sets the NodeOffset.
ProcessElementComponents Gets or sets the ProcessElementComponents.
ProcessFaceComponents Gets or sets the ProcessFaceComponents.
ProcessLineBodies Gets or sets the ProcessLineBodies.
ProcessMesh200Elms Gets or sets the ProcessMesh200Elms.
ProcessModelData Gets or sets the ProcessModelData.
ProcessNodalComponents Gets or sets the ProcessNodalComponents.
ProcessValidBlockedCDBFile Gets or sets the ProcessValidBlockedCDBFile.
Properties Gets the list of properties for this object.
SourceIdentifier Gets the SourceIdentifier.
ToleranceAngle Gets or sets the ToleranceAngle.
UnitSystemTypeForImport Gets or sets the UnitSystemTypeForImport.
VertexInsertionAngle Gets or sets the VertexInsertionAngle.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property ModelImport.AnalysisTypeDimensionSetting : Ansys.Mechanical.DataModel.Enums.AnalysisTypeDimensionEnum | None

Gets or sets the AnalysisTypeDimensionSetting.

property ModelImport.ApplicationSourceSetting : Ansys.Mechanical.DataModel.Enums.ApplicationSourceEnum | None

Gets the ApplicationSourceSetting.

property ModelImport.BodyGroupByAnsysElmTypeNumber : bool | None

Gets or sets the BodyGroupByAnsysElmTypeNumber.

property ModelImport.BodyGroupByMaterialNumber : bool | None

Gets or sets the BodyGroupByMaterialNumber.

property ModelImport.BodyGroupByThickness : bool | None

Gets or sets the BodyGroupByThickness.

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

Gets the list of children.

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

Gets the list of associated comments.

property ModelImport.CreateGeometry : bool | None

Gets or sets the CreateGeometry.

property ModelImport.CreateGeometryEdgeComponents : bool | None

Gets or sets the CreateGeometryEdgeComponents.

property ModelImport.CreateGeometryFaceComponents : bool | None

Gets or sets the CreateGeometryFaceComponents.

property ModelImport.CreateGeometryVertexComponent : bool | None

Gets or sets the CreateGeometryVertexComponent.

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

Gets the current DataModelObject’s category.

property ModelImport.ElementComponentKey : str | None

Gets or sets the ElementComponentKey.

property ModelImport.ElementOffset : int | None

Gets or sets the ElementOffset.

property ModelImport.FaceComponentKey : str | None

Gets or sets the FaceComponentKey.

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

Gets the list of associated figures.

property ModelImport.GeometryComponentKey : str | None

Gets or sets the GeometryComponentKey.

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

Gets the list of associated images.

property ModelImport.ImportMaterials : bool | None

Gets or sets the ImportMaterials.

property ModelImport.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSModelImportAuto | None

Gets the internal object. For advanced usage only.

property ModelImport.MaterialConsolidation : bool | None

Gets or sets the MaterialConsolidation.

property ModelImport.ModelImportSourceFilePath : str | None

Gets or sets the ModelImportSourceFilePath.

property ModelImport.NodalComponentKey : str | None

Gets or sets the NodalComponentKey.

property ModelImport.NodeAndElementRenumberingMethod : Ansys.Mechanical.DataModel.Enums.NodeAndElementRenumberingMethodType | None

Gets or sets the NodeAndElementRenumberingMethod.

property ModelImport.NodeOffset : int | None

Gets or sets the NodeOffset.

property ModelImport.ProcessElementComponents : bool | None

Gets or sets the ProcessElementComponents.

property ModelImport.ProcessFaceComponents : bool | None

Gets or sets the ProcessFaceComponents.

property ModelImport.ProcessLineBodies : bool | None

Gets or sets the ProcessLineBodies.

property ModelImport.ProcessMesh200Elms : bool | None

Gets or sets the ProcessMesh200Elms.

property ModelImport.ProcessModelData : bool | None

Gets or sets the ProcessModelData.

property ModelImport.ProcessNodalComponents : bool | None

Gets or sets the ProcessNodalComponents.

property ModelImport.ProcessValidBlockedCDBFile : bool | None

Gets or sets the ProcessValidBlockedCDBFile.

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

Gets the list of properties for this object.

property ModelImport.SourceIdentifier : str | None

Gets the SourceIdentifier.

property ModelImport.ToleranceAngle : Ansys.Core.Units.Quantity | None

Gets or sets the ToleranceAngle.

property ModelImport.UnitSystemTypeForImport : Ansys.Mechanical.DataModel.Enums.ModelImportUnitSystemType | None

Gets or sets the UnitSystemTypeForImport.

property ModelImport.VertexInsertionAngle : Ansys.Core.Units.Quantity | None

Gets or sets the VertexInsertionAngle.

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

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

Method detail

ModelImport.Activate()

Activate the current object.

ModelImport.AddComment()

Creates a new child Comment.

ModelImport.AddFigure()

Creates a new child Figure.

ModelImport.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.

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

Copies all visible properties from this object to another.

ModelImport.CreateParameter(propName: str)

Creates a new parameter for a Property.

ModelImport.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ModelImport.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ModelImport.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ModelImport.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ModelImport.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.

ModelImport.PropertyByName(name: str)

Get a property by its unique name.

ModelImport.RemoveParameter(propName: str)

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