ModelImport

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.ModelImport(internalObject: Any)

Bases: object

Defines a ModelImport.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
DeleteAssociatedBodies	DeleteAssociatedBodies method.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
Generate	Generate method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
Import	Import method.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AnalysisTypeDimensionSetting	Gets or sets the AnalysisTypeDimensionSetting.
ApplicationSourceSetting	Gets the ApplicationSourceSetting.
AttachedRefs	AttachedRefs property.
BodyGroupByAnsysElmTypeNumber	Gets or sets the BodyGroupByAnsysElmTypeNumber.
BodyGroupByMaterialNumber	Gets or sets the BodyGroupByMaterialNumber.
BodyGroupByThickness	Gets or sets the BodyGroupByThickness.
CanRemove	CanRemove property.
Children	Gets the list of children.
ClsId	ClsId property.
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.
FilePath	FilePath property.
GeometryComponentKey	Gets or sets the GeometryComponentKey.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
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.
Name	Name property.
NodalComponentKey	Gets or sets the NodalComponentKey.
NodeAndElementRenumberingMethod	Gets or sets the NodeAndElementRenumberingMethod.
NodeOffset	Gets or sets the NodeOffset.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PostAction	PostAction property.
PreAction	PreAction property.
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.
State	State property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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.CanRemove: bool | None

CanRemove property.

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

Gets the list of children.

property ModelImport.ClsId: int | None

ClsId property.

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.FilePath: str | None

FilePath property.

property ModelImport.GeometryComponentKey: str | None

Gets or sets the GeometryComponentKey.

property ModelImport.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property ModelImport.IconName: str | None

IconName property.

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.Name: str | None

Name property.

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.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property ModelImport.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property ModelImport.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property ModelImport.PostAction: System.Action | None

PostAction property.

property ModelImport.PreAction: System.Action | None

PreAction property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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() → None

Activate the current object.

ModelImport.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

ModelImport.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

ModelImport.AddImage(filePath: str) → 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.

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

Copies all visible properties from this object to another.

ModelImport.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

ModelImport.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

ModelImport.DeleteAssociatedBodies() → bool

DeleteAssociatedBodies method.

ModelImport.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

ModelImport.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

ModelImport.Generate() → bool

Generate method.

ModelImport.GetAPIName(dispId: int) → str

Property name bound to dispId.

ModelImport.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

ModelImport.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

ModelImport.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

ModelImport.GetHashCode() → int

GetHashCode method.

ModelImport.GetIconFile() → System.Byte

GetIconFile method.

ModelImport.GetLifetimeService() → Any

GetLifetimeService method.

ModelImport.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

ModelImport.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

ModelImport.GetPath() → str

GetPath method.

ModelImport.GetPropertyName(dispId: int) → str

GetPropertyName method.

ModelImport.GetPropertyValue(name: str) → Any

GetPropertyValue method.

ModelImport.GetType() → type

GetType method.

ModelImport.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

ModelImport.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

ModelImport.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

ModelImport.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

ModelImport.Import() → bool

Import method.

ModelImport.InitializeLifetimeService() → Any

InitializeLifetimeService method.

ModelImport.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

ModelImport.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

ModelImport.PropertyByAPIName(name: str) → 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.

ModelImport.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

ModelImport.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

ModelImport.RemoveParameter(propName: str) → None

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

ModelImport.ToString() → str

ToString method.