## On this page

  

 

 # `Alert`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Results.Alert"></a>

#### *class* Ansys.ACT.Automation.Mechanical.Results.Alert

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

Defines a Alert.

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

## Overview

### Methods

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

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

## Property detail

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets the current DataModelObject’s category.

<a id="Alert.FailsIf"></a>

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

Gets or sets the FailsIf.

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

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

Gets the list of associated images.

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

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

Gets the internal object. For advanced usage only.

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

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

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

Gets the Status.

<a id="Alert.Value"></a>

### *property* Alert.Value *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Value.

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

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

### Alert.Activate()

Activate the current object.

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

### Alert.AddComment()

Creates a new child Comment.

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

### Alert.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="Alert.CopyTo"></a>

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### Alert.Delete()

Run the Delete action.

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

### Alert.Duplicate()

Creates a copy of the current DataModelObject.

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

### Alert.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="Alert.GetParameter"></a>

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

Gets the parameter corresponding to the given property.

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

### Alert.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### Alert.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### Alert.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="Alert.PropertyByName"></a>

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

Get a property by its unique name.

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

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

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