DisplacementConstraint#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.DisplacementConstraint#

Bases: object

Defines a DisplacementConstraint.

Overview#

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.

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

Children

Gets the list of children.

DataModelObjectCategory

Gets the current DataModelObject's category.

EnvironmentSelection

Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.

InternalObject

Gets the internal object. For advanced usage only.

Location

Gets or sets the Location.

Properties

Gets the list of properties for this object.

ScopingMethod

Gets or sets the ScopingMethod.

Suppressed

Gets or sets the Suppressed.

VisibleProperties

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

XComponentMax

Gets or sets the XComponentMax.

YComponentMax

Gets or sets the YComponentMax.

ZComponentMax

Gets or sets the ZComponentMax.

Property detail#

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

Gets the list of children.

property DisplacementConstraint.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property DisplacementConstraint.EnvironmentSelection: Any | None#

Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.

property DisplacementConstraint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoConstraintAuto | None#

Gets the internal object. For advanced usage only.

property DisplacementConstraint.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

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

Gets the list of properties for this object.

property DisplacementConstraint.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the ScopingMethod.

property DisplacementConstraint.Suppressed: bool | None#

Gets or sets the Suppressed.

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

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

property DisplacementConstraint.XComponentMax: Ansys.ACT.Mechanical.Fields.Field | None#

Gets or sets the XComponentMax.

property DisplacementConstraint.YComponentMax: Ansys.ACT.Mechanical.Fields.Field | None#

Gets or sets the YComponentMax.

property DisplacementConstraint.ZComponentMax: Ansys.ACT.Mechanical.Fields.Field | None#

Gets or sets the ZComponentMax.

Method detail#

DisplacementConstraint.Activate() None#

Activate the current object.

DisplacementConstraint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

DisplacementConstraint.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

DisplacementConstraint.Delete() None#

Run the Delete action.

DisplacementConstraint.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

DisplacementConstraint.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

DisplacementConstraint.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

DisplacementConstraint.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

DisplacementConstraint.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.
DisplacementConstraint.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

DisplacementConstraint.RemoveParameter(propName: str) None#

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

DisplacementConstraint.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.