Skip to main content

Mechanical scripting interface

CondensedGeometry

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.CondensedGeometry

Bases: object

Defines a CondensedGeometry.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddCondensedPart Creates a new CondensedPart
AddCondensedPartInfoTool Creates a new CondensedPartInfoTool
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
AddImportedCondensedPart Creates a new ImportedCondensedPart
ClearGeneratedData Run the ClearGeneratedData action.
CopyTo Copies all visible properties from this object to another.
CreateAutomaticCondensedParts Run the CreateAutomaticCondensedParts action.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GenerateCondensedParts Run the GenerateCondensedParts action.
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
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.
Properties Gets the list of properties for this object.
SolverFilesDirectory Gets the SolverFilesDirectory.
TransparencyEnabled Gets or sets the TransparencyEnabled.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property CondensedGeometry.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSCondensedGeometryAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property CondensedGeometry.SolverFilesDirectory : str | None

Gets the SolverFilesDirectory.

property CondensedGeometry.TransparencyEnabled : bool | None

Gets or sets the TransparencyEnabled.

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

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

Method detail

CondensedGeometry.Activate()

Activate the current object.

CondensedGeometry.AddComment()

Creates a new child Comment.

CondensedGeometry.AddCondensedPart()

Creates a new CondensedPart

CondensedGeometry.AddCondensedPartInfoTool()

Creates a new CondensedPartInfoTool

CondensedGeometry.AddFigure()

Creates a new child Figure.

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

CondensedGeometry.AddImportedCondensedPart()

Creates a new ImportedCondensedPart

CondensedGeometry.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

CondensedGeometry.CreateAutomaticCondensedParts()

Run the CreateAutomaticCondensedParts action.

CondensedGeometry.CreateParameter(propName: str)

Creates a new parameter for a Property.

CondensedGeometry.Delete()

Run the Delete action.

CondensedGeometry.Duplicate()

Creates a copy of the current DataModelObject.

CondensedGeometry.GenerateCondensedParts()

Run the GenerateCondensedParts action.

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

Gets the list of children, filtered by type.

CondensedGeometry.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

CondensedGeometry.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

CondensedGeometry.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

CondensedGeometry.PropertyByName(name: str)

Get a property by its unique name.

CondensedGeometry.RemoveParameter(propName: str)

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