ExclusionRegion

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.ExclusionRegion

Bases: object

ExclusionRegion class.

Overview

Methods

CopyTo	Copies all visible properties from this object to another.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
Delete	Run the Delete action.
GetChildren	Gets the list of children, filtered by type.
GetChildren	Gets the list of children, filtered by type.
Activate	Activate the current object.
CopyTo	Copies all visible properties from this object to another.
Duplicate	Creates a copy of the current DataModelObject.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
PropertyByName	Get a property by its unique name.
PropertyByAPIName	Get a property by its API name.
CreateParameter	Creates a new parameter for a Property.
GetParameter	Gets the parameter corresponding to the given property.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.

Properties

InternalObject	InternalObject property.
Suppressed	Gets or sets the Suppressed.
DataModelObjectCategory	Gets the current DataModelObject’s category.
ExclusionRegionLocation	Gets or sets the ExclusionRegionLocation.
ExclusionScopingMethod	Gets or sets the ExclusionScopingMethod.
Children	Gets the list of children.
MaxCumulatedDisplacementControl	Gets or sets the MaxCumulatedDisplacementControl.
MorphingTotalMoveLimit	Gets or sets the MorphingTotalMoveLimit.
InternalObject	Gets the internal object. For advanced usage only.
Properties	Gets the list of properties for this object.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property ExclusionRegion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSOptimizationRegionAuto | None

InternalObject property.

property ExclusionRegion.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

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

Gets the current DataModelObject’s category.

property ExclusionRegion.ExclusionRegionLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ExclusionRegionLocation.

property ExclusionRegion.ExclusionScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ExclusionScopingMethod.

property ExclusionRegion.Children: System.Collections.Generic.IList[Ansys.ACT.Automation.Mechanical.DataModelObject] | None

Gets the list of children.

property ExclusionRegion.MaxCumulatedDisplacementControl: Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType | None

Gets or sets the MaxCumulatedDisplacementControl.

property ExclusionRegion.MorphingTotalMoveLimit: System.Double | None

Gets or sets the MorphingTotalMoveLimit.

property ExclusionRegion.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property ExclusionRegion.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property ExclusionRegion.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

ExclusionRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.ExclusionRegion) → System.Void

Copies all visible properties from this object to another.
Override because of copy order of properties

ExclusionRegion.RenameBasedOnDefinition() → System.Void

Run the RenameBasedOnDefinition action.

ExclusionRegion.Delete() → System.Void

Run the Delete action.

ExclusionRegion.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

ExclusionRegion.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Gets the list of children, filtered by type.

ExclusionRegion.Activate() → System.Void

Activate the current object.

ExclusionRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

ExclusionRegion.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ExclusionRegion.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

ExclusionRegion.PropertyByAPIName(name: System.String) → 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.

ExclusionRegion.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

ExclusionRegion.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

ExclusionRegion.RemoveParameter(propName: System.String) → System.Void

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