## On this page

  

 

 # `ComplianceConstraint`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.ComplianceConstraint"></a>

#### *class* Ansys.ACT.Automation.Mechanical.ComplianceConstraint

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a ComplianceConstraint.

<a id="overview"></a>

## Overview

### Methods

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

NameDescription[`Children`](#ComplianceConstraint.Children)Gets the list of children.[`ComplianceLimit`](#ComplianceConstraint.ComplianceLimit)Gets or sets the ComplianceLimit.[`DataModelObjectCategory`](#ComplianceConstraint.DataModelObjectCategory)Gets the current DataModelObject’s category.[`EnvironmentSelection`](#ComplianceConstraint.EnvironmentSelection)Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.[`InternalObject`](#ComplianceConstraint.InternalObject)Gets the internal object. For advanced usage only.[`Properties`](#ComplianceConstraint.Properties)Gets the list of properties for this object.[`Suppressed`](#ComplianceConstraint.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#ComplianceConstraint.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="ComplianceConstraint.Children"></a>

### *property* ComplianceConstraint.Children *: List\[[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="ComplianceConstraint.ComplianceLimit"></a>

### *property* ComplianceConstraint.ComplianceLimit *: [Ansys.ACT.Mechanical.Fields.Field](../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ComplianceLimit.

<a id="ComplianceConstraint.DataModelObjectCategory"></a>

### *property* ComplianceConstraint.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="ComplianceConstraint.EnvironmentSelection"></a>

### *property* ComplianceConstraint.EnvironmentSelection *: Any | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="ComplianceConstraint.InternalObject"></a>

### *property* ComplianceConstraint.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSTopoConstraintAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="ComplianceConstraint.Properties"></a>

### *property* ComplianceConstraint.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="ComplianceConstraint.Suppressed"></a>

### *property* ComplianceConstraint.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="ComplianceConstraint.VisibleProperties"></a>

### *property* ComplianceConstraint.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="method-detail"></a>

## Method detail

<a id="ComplianceConstraint.Activate"></a>

### ComplianceConstraint.Activate() → [None](https://docs.python.org/3/library/constants.html#None)

Activate the current object.

<a id="ComplianceConstraint.CopyTo"></a>

### ComplianceConstraint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → [None](https://docs.python.org/3/library/constants.html#None)

Copies all visible properties from this object to another.

<a id="ComplianceConstraint.CreateParameter"></a>

### ComplianceConstraint.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

<a id="ComplianceConstraint.Delete"></a>

### ComplianceConstraint.Delete() → [None](https://docs.python.org/3/library/constants.html#None)

Run the Delete action.

<a id="ComplianceConstraint.Duplicate"></a>

### ComplianceConstraint.Duplicate() → [Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Creates a copy of the current DataModelObject.

<a id="ComplianceConstraint.GetChildren"></a>

### ComplianceConstraint.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\]) → List\[ChildrenType\]

Gets the list of children, filtered by type.

<a id="ComplianceConstraint.GetParameter"></a>

### ComplianceConstraint.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

<a id="ComplianceConstraint.GroupAllSimilarChildren"></a>

### ComplianceConstraint.GroupAllSimilarChildren() → [None](https://docs.python.org/3/library/constants.html#None)

Run the GroupAllSimilarChildren action.

<a id="ComplianceConstraint.GroupSimilarObjects"></a>

### ComplianceConstraint.GroupSimilarObjects() → [Ansys.ACT.Automation.Mechanical.TreeGroupingFolder](TreeGroupingFolder.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder)

Run the GroupSimilarObjects action.

<a id="ComplianceConstraint.PropertyByAPIName"></a>

### ComplianceConstraint.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

```text
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.

```

<a id="ComplianceConstraint.PropertyByName"></a>

### ComplianceConstraint.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

<a id="ComplianceConstraint.RemoveParameter"></a>

### ComplianceConstraint.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

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

<a id="ComplianceConstraint.RenameBasedOnDefinition"></a>

### ComplianceConstraint.RenameBasedOnDefinition() → [None](https://docs.python.org/3/library/constants.html#None)

Run the RenameBasedOnDefinition action.