`GeometryImport`#

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

Bases: object

Defines a GeometryImport.

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.
`Duplicate`	Creates a copy of the current DataModelObject.
`Equals`	Equals 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
`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,
`GetHashCode`	GetHashCode method.
`GetIconFile`	GetIconFile method.
`GetLifetimeService`	GetLifetimeService method.
`GetObjectData`	GetObjectData method.
`GetParameter`	Gets the parameter corresponding to the given property.
`GetPath`	GetPath method.
`GetPreferences`	Gets the preferences for most recent import operations with the geometry file/data.
`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/reload geometry from the CAD file using the provided preferences. *** If no
`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

`AttachedRefs`	AttachedRefs property.
`CanRemove`	Secondary sources are always removable, and primary sources when when Mechanical
`Children`	Gets the list of children.
`ClsId`	ClsId property.
`Comments`	Gets the list of associated comments.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`Figures`	Gets the list of associated figures.
`GroupingFolder`	GroupingFolder property.
`HasValidGeometry`	HasValidGeometry property.
`IconName`	IconName property.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`IsPrimarySource`	IsPrimarySource property.
`IsUserInteractable`	IsUserInteractable property.
`Name`	Name property.
`ObjectId`	ObjectId property.
`ObjectState`	ObjectState property.
`ObjectTags`	ObjectTags property.
`Parent`	Parent property.
`Parts`	List of parts created by the most recent import operation.
`PostAction`
`PreAction`
`Properties`	Gets the list of properties for this object.
`State`	State property.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property GeometryImport.AttachedRefs: List[int] | None#: AttachedRefs property.

property GeometryImport.CanRemove: bool | None#: Secondary sources are always removable, and primary sources when when Mechanical geometry is not provided via the Workbench project schematic.

property GeometryImport.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property GeometryImport.ClsId: int | None#: ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: GroupingFolder property.

property GeometryImport.HasValidGeometry: bool | None#: HasValidGeometry property.

property GeometryImport.IconName: str | None#: IconName property.

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.IsPrimarySource: bool | None#: IsPrimarySource property.

property GeometryImport.IsUserInteractable: bool | None#: IsUserInteractable property.

property GeometryImport.Name: str | None#: Name property.

property GeometryImport.ObjectId: int | None#: ObjectId property.

property GeometryImport.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#: ObjectState property.

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

property GeometryImport.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: Parent property.

property GeometryImport.Parts: List[Any] | None#: List of parts created by the most recent import operation.

property GeometryImport.PostAction: System.Action | None#

property GeometryImport.PreAction: System.Action | None#

property GeometryImport.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property GeometryImport.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#: State property.

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

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

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

GeometryImport.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef#: CreateObjRef method.

GeometryImport.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

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

GeometryImport.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool#: Equals method.

GeometryImport.GetAPIName(dispId: int) → str#: Property name bound to dispId.

GeometryImport.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#: GetAllProperties method.

GeometryImport.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

GeometryImport.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData#: GetDetailsView method.

GeometryImport.GetEnumName(enumType: type, value: int, dispId: int) → str#: Enum name bound to value

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

GeometryImport.GetGeometryURI() → str#

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

GeometryImport.GetHashCode() → int#: GetHashCode method.

GeometryImport.GetIconFile() → System.Byte#: GetIconFile method.

GeometryImport.GetLifetimeService() → Any#: GetLifetimeService method.

GeometryImport.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None#: GetObjectData method.

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

GeometryImport.GetPath() → str#: GetPath method.

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

GeometryImport.GetPropertyName(dispId: int) → str#: GetPropertyName method.

GeometryImport.GetPropertyValue(name: str) → Any#: GetPropertyValue method.

GeometryImport.GetType() → type#: GetType method.

GeometryImport.GetVisibleProperties() → List[System.Reflection.PropertyInfo]#: GetVisibleProperties method.

GeometryImport.GetVisiblePropertyNames() → List[str]#: GetVisiblePropertyNames method.

GeometryImport.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

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

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

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.InitializeLifetimeService() → Any#: InitializeLifetimeService method.

GeometryImport.IsPropertyEditable(dispId: int) → bool#: IsPropertyEditable method.

GeometryImport.IsPropertyVisible(dispId: int) → bool#: IsPropertyVisible method.

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

GeometryImport.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property#: PropertyById method.

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

GeometryImport.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

GeometryImport.ToString() → str#: ToString method.

GeometryImport#

Overview#

Property detail#

Method detail#

`GeometryImport`#