CompositeFailureTool
Last update: 14.01.2025
CompositeFailureTool
class Ansys.ACT.Automation.Mechanical.Results.CompositeFailureResults.CompositeFailureTool
Bases: object
Defines a CompositeFailureTool.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
AddComment |
Creates a new child Comment. |
AddFigure |
Creates a new child Figure. |
AddGroupedScopedACPResults |
AddGroupedScopedACPResults method. |
AddImage |
Creates a new child Image. |
AddInverseReserveFactor |
Creates a new InverseReserveFactor |
AddSafetyFactor |
Creates a new SafetyFactor |
AddSafetyMargin |
Creates a new SafetyMargin |
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. |
EvaluateAllResults |
Run the EvaluateAllResults action. |
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. |
Figures |
Gets the list of associated figures. |
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. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property CompositeFailureTool.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property CompositeFailureTool.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property CompositeFailureTool.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property CompositeFailureTool.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property CompositeFailureTool.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property CompositeFailureTool.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSCompositeFailureToolAuto | None
Gets the internal object. For advanced usage only.
property CompositeFailureTool.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property CompositeFailureTool.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
CompositeFailureTool.Activate()
Activate the current object.
CompositeFailureTool.AddComment()
Creates a new child Comment.
CompositeFailureTool.AddFigure()
Creates a new child Figure.
CompositeFailureTool.AddGroupedScopedACPResults(resultType: Ansys.Mechanical.DataModel.Enums.ResultType, selectedPlies: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject])
AddGroupedScopedACPResults method.
CompositeFailureTool.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.
CompositeFailureTool.AddInverseReserveFactor()
Creates a new InverseReserveFactor
CompositeFailureTool.AddSafetyFactor()
Creates a new SafetyFactor
CompositeFailureTool.AddSafetyMargin()
Creates a new SafetyMargin
CompositeFailureTool.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
CompositeFailureTool.CreateParameter(propName: str)
Creates a new parameter for a Property.
CompositeFailureTool.Delete()
Run the Delete action.
CompositeFailureTool.Duplicate()
Creates a copy of the current DataModelObject.
CompositeFailureTool.EvaluateAllResults()
Run the EvaluateAllResults action.
CompositeFailureTool.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
CompositeFailureTool.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
CompositeFailureTool.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
CompositeFailureTool.GroupSimilarObjects()
Run the GroupSimilarObjects action.
CompositeFailureTool.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.
CompositeFailureTool.PropertyByName(name: str)
Get a property by its unique name.
CompositeFailureTool.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.