Skip to main content

Mechanical scripting interface

CompositeCriterion

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.CompositeCriterion

Bases: object

Defines a CompositeCriterion.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
ClearGeneratedData Run the ClearGeneratedData action.
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.
GetDefinition Gets the Worksheet Definition.
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.
ReadOnly Gets or sets the ReadOnly.
Suppressed Gets or sets the Suppressed.
Value Gets the Value.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

property CompositeCriterion.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

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

Gets the list of associated images.

property CompositeCriterion.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSTopoCriterionAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property CompositeCriterion.ReadOnly : bool | None

Gets or sets the ReadOnly.

property CompositeCriterion.Suppressed : bool | None

Gets or sets the Suppressed.

property CompositeCriterion.Value : Ansys.Core.Units.Quantity | None

Gets the Value.

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

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

Method detail

CompositeCriterion.Activate()

Activate the current object.

CompositeCriterion.AddComment()

Creates a new child Comment.

CompositeCriterion.AddFigure()

Creates a new child Figure.

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

CompositeCriterion.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

CompositeCriterion.CreateParameter(propName: str)

Creates a new parameter for a Property.

CompositeCriterion.Delete()

Run the Delete action.

CompositeCriterion.Duplicate()

Creates a copy of the current DataModelObject.

CompositeCriterion.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Gets the list of children, filtered by type.

CompositeCriterion.GetDefinition()

Gets the Worksheet Definition.
This Definition is a list of CompositeCriterionTerms.

CompositeCriterion.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

CompositeCriterion.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

CompositeCriterion.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

CompositeCriterion.PropertyByName(name: str)

Get a property by its unique name.

CompositeCriterion.RemoveParameter(propName: str)

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