Alert
Last update: 14.01.2025
Alert
class Ansys.ACT.Automation.Mechanical.Results.Alert
Bases: object
Defines a Alert.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
AddComment |
Creates a new child Comment. |
AddImage |
Creates a new child Image. |
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. |
Properties
Name | Description |
---|---|
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
FailsIf |
Gets or sets the FailsIf. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
Properties |
Gets the list of properties for this object. |
Status |
Gets the Status. |
Value |
Gets or sets the Value. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property Alert.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property Alert.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property Alert.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property Alert.FailsIf : Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None
Gets or sets the FailsIf.
property Alert.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property Alert.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAlertAuto | None
Gets the internal object. For advanced usage only.
property Alert.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property Alert.Status : Ansys.Mechanical.DataModel.Enums.PassFailResult | None
Gets the Status.
property Alert.Value : float | None
Gets or sets the Value.
property Alert.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
Alert.Activate()
Activate the current object.
Alert.AddComment()
Creates a new child Comment.
Alert.AddImage(filePath: str)
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.
Alert.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
Alert.CreateParameter(propName: str)
Creates a new parameter for a Property.
Alert.Delete()
Run the Delete action.
Alert.Duplicate()
Creates a copy of the current DataModelObject.
Alert.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
Alert.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
Alert.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
Alert.GroupSimilarObjects()
Run the GroupSimilarObjects action.
Alert.PropertyByAPIName(name: str)
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.
Alert.PropertyByName(name: str)
Get a property by its unique name.
Alert.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.