Skip to main content

Mechanical scripting interface

FeatureSuppress

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.MeshControls.FeatureSuppress

Bases: object

Defines a FeatureSuppress.

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.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GenerateMesh Generate the Mesh.
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.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
FeatureHeight To specify the Feature Height.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
NamedSelection Gets or sets the NamedSelection.
Properties Gets the list of properties for this object.
ScopingMethod Gets or sets the ScopingMethod.
SourceLocation To specify the face selections for the method: Defeature Faces or Parent Faces.
SourceNamedSelection Gets or sets the SourceNamedSelection.
SourceSelection To select the FeatureSuppress method.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

property FeatureSuppress.FeatureHeight : Ansys.Core.Units.Quantity | None

To specify the Feature Height.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property FeatureSuppress.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSMeshControlAuto | None

Gets the internal object. For advanced usage only.

property FeatureSuppress.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property FeatureSuppress.NamedSelection : Ansys.ACT.Automation.Mechanical.NamedSelection | None

Gets or sets the NamedSelection.

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

Gets the list of properties for this object.

property FeatureSuppress.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property FeatureSuppress.SourceLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

To specify the face selections for the method: Defeature Faces or Parent Faces.

property FeatureSuppress.SourceNamedSelection : Ansys.ACT.Automation.Mechanical.NamedSelection | None

Gets or sets the SourceNamedSelection.

property FeatureSuppress.SourceSelection : Ansys.Mechanical.DataModel.Enums.FeatureSuppressMethod | None

To select the FeatureSuppress method.

property FeatureSuppress.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

FeatureSuppress.Activate()

Activate the current object.

FeatureSuppress.AddComment()

Creates a new child Comment.

FeatureSuppress.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

FeatureSuppress.CreateParameter(propName: str)

Creates a new parameter for a Property.

FeatureSuppress.Delete()

Run the Delete action.

FeatureSuppress.Duplicate()

Creates a copy of the current DataModelObject.

FeatureSuppress.GenerateMesh()

Generate the Mesh.

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

Gets the list of children, filtered by type.

FeatureSuppress.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

FeatureSuppress.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

FeatureSuppress.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

FeatureSuppress.PropertyByName(name: str)

Get a property by its unique name.

FeatureSuppress.RemoveParameter(propName: str)

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

FeatureSuppress.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.