Skip to main content

Mechanical scripting interface

FatigueSensitivity

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueSensitivity

Bases: object

Defines a FatigueSensitivity.

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.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.

Properties

Name Description
ChartViewingStyle Gets or sets the ChartViewingStyle.
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
DesignLife Gets or sets the DesignLife.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
LowerVariation Gets or sets the LowerVariation.
NumberOfFillPoints Gets or sets the NumberOfFillPoints.
Properties Gets the list of properties for this object.
Sensitivity Gets or sets the Sensitivity.
Suppressed Gets or sets the Suppressed.
UpperVariation Gets or sets the UpperVariation.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property FatigueSensitivity.ChartViewingStyle : Ansys.Mechanical.DataModel.Enums.ChartAxisScaleType | None

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

property FatigueSensitivity.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property FatigueSensitivity.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property FatigueSensitivity.DesignLife : int | None

Gets or sets the DesignLife.

property FatigueSensitivity.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property FatigueSensitivity.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto | None

Gets the internal object. For advanced usage only.

property FatigueSensitivity.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property FatigueSensitivity.LowerVariation : int | None

Gets or sets the LowerVariation.

property FatigueSensitivity.NumberOfFillPoints : int | None

Gets or sets the NumberOfFillPoints.

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

Gets the list of properties for this object.

property FatigueSensitivity.Sensitivity : Ansys.Mechanical.DataModel.Enums.FatigueSensitivityType | None

Gets or sets the Sensitivity.

property FatigueSensitivity.Suppressed : bool | None

Gets or sets the Suppressed.

property FatigueSensitivity.UpperVariation : int | None

Gets or sets the UpperVariation.

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

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

Method detail

FatigueSensitivity.Activate()

Activate the current object.

FatigueSensitivity.AddComment()

Creates a new child Comment.

FatigueSensitivity.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.

FatigueSensitivity.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

FatigueSensitivity.CreateParameter(propName: str)

Creates a new parameter for a Property.

FatigueSensitivity.Delete()

Run the Delete action.

FatigueSensitivity.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

FatigueSensitivity.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

FatigueSensitivity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

FatigueSensitivity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

FatigueSensitivity.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.

FatigueSensitivity.PropertyByName(name: str)

Get a property by its unique name.

FatigueSensitivity.RemoveParameter(propName: str)

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

FatigueSensitivity.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.