Skip to main content

Mechanical scripting interface

PipeIdealization

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.PipeIdealization

Bases: object

Defines a PipeIdealization.

Overview

Methods

Name Description
Activate Activate the current object.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
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
Children Gets the list of children.
DataModelObjectCategory Gets the current DataModelObject’s category.
Extend Gets or sets the Extend.
Factor Gets or sets the Factor.
GeometrySelection Gets or sets the GeometrySelection.
InternalObject Gets the internal object. For advanced usage only.
Properties Gets the list of properties for this object.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the current DataModelObject’s category.

property PipeIdealization.Extend : Ansys.Mechanical.DataModel.Enums.GrowElbowElementsBy | None

Gets or sets the Extend.

property PipeIdealization.Factor : float | None

Gets or sets the Factor.

property PipeIdealization.GeometrySelection : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the GeometrySelection.

property PipeIdealization.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSPipeIdealizationAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property PipeIdealization.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

PipeIdealization.Activate()

Activate the current object.

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

Copies all visible properties from this object to another.

PipeIdealization.CreateParameter(propName: str)

Creates a new parameter for a Property.

PipeIdealization.Delete()

Run the Delete action.

PipeIdealization.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

PipeIdealization.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

PipeIdealization.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

PipeIdealization.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

PipeIdealization.PropertyByName(name: str)

Get a property by its unique name.

PipeIdealization.RemoveParameter(propName: str)

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