## On this page

  

 

 # `GenericBoundaryCondition`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.GenericBoundaryCondition"></a>

#### *class* Ansys.ACT.Automation.Mechanical.BoundaryConditions.GenericBoundaryCondition

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

Defines a GenericBoundaryCondition.

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

## Overview

### Methods

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

NameDescription[`Children`](#GenericBoundaryCondition.Children)Gets the list of children.[`Comments`](#GenericBoundaryCondition.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#GenericBoundaryCondition.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Figures`](#GenericBoundaryCondition.Figures)Gets the list of associated figures.[`Images`](#GenericBoundaryCondition.Images)Gets the list of associated images.[`InternalObject`](#GenericBoundaryCondition.InternalObject)Gets the internal object. For advanced usage only.[`Properties`](#GenericBoundaryCondition.Properties)Gets the list of properties for this object.[`ReadOnly`](#GenericBoundaryCondition.ReadOnly)Gets or sets the ReadOnly.[`SharedRefBody`](#GenericBoundaryCondition.SharedRefBody)Gets or sets the SharedRefBody.[`Suppressed`](#GenericBoundaryCondition.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#GenericBoundaryCondition.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

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

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

Gets the list of children.

<a id="GenericBoundaryCondition.Comments"></a>

### *property* GenericBoundaryCondition.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

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

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

Gets the current DataModelObject’s category.

<a id="GenericBoundaryCondition.Figures"></a>

### *property* GenericBoundaryCondition.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="GenericBoundaryCondition.Images"></a>

### *property* GenericBoundaryCondition.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

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

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

Gets the internal object. For advanced usage only.

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

### *property* GenericBoundaryCondition.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="GenericBoundaryCondition.ReadOnly"></a>

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

Gets or sets the ReadOnly.

<a id="GenericBoundaryCondition.SharedRefBody"></a>

### *property* GenericBoundaryCondition.SharedRefBody *: [Ansys.ACT.Automation.Mechanical.Body](../Body.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Body) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SharedRefBody.

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

### *property* GenericBoundaryCondition.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="GenericBoundaryCondition.VisibleProperties"></a>

### *property* GenericBoundaryCondition.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="GenericBoundaryCondition.Activate"></a>

### GenericBoundaryCondition.Activate()

Activate the current object.

<a id="GenericBoundaryCondition.AddComment"></a>

### GenericBoundaryCondition.AddComment()

Creates a new child Comment.

<a id="GenericBoundaryCondition.AddFigure"></a>

### GenericBoundaryCondition.AddFigure()

Creates a new child Figure.

<a id="GenericBoundaryCondition.AddImage"></a>

### GenericBoundaryCondition.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

```

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

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

Copies all visible properties from this object to another.

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

### GenericBoundaryCondition.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

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

### GenericBoundaryCondition.Delete()

Run the Delete action.

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

### GenericBoundaryCondition.Duplicate()

Creates a copy of the current DataModelObject.

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

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

Gets the list of children, filtered by type.

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

### GenericBoundaryCondition.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

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

### GenericBoundaryCondition.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### GenericBoundaryCondition.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="GenericBoundaryCondition.PromoteToNamedSelection"></a>

### GenericBoundaryCondition.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

### GenericBoundaryCondition.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="GenericBoundaryCondition.PropertyByName"></a>

### GenericBoundaryCondition.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

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

### GenericBoundaryCondition.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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