`CompositeCriterion`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.CompositeCriterion#

Bases: object

Defines a CompositeCriterion.

Overview#

Methods

`GetDefinition`	Gets the Worksheet Definition.
`EvaluateAllResults`	Run the EvaluateAllResults action.
`ClearGeneratedData`	Run the ClearGeneratedData action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`InternalObject`	Gets the internal object. For advanced usage only.
`Value`	Gets the Value.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Suppressed`	Gets or sets the Suppressed.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`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 CompositeCriterion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoCriterionAuto | None: Gets the internal object. For advanced usage only.

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

property CompositeCriterion.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property CompositeCriterion.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property CompositeCriterion.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property CompositeCriterion.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property CompositeCriterion.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property CompositeCriterion.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property CompositeCriterion.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property CompositeCriterion.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property CompositeCriterion.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property CompositeCriterion.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

CompositeCriterion.GetDefinition() → Ansys.ACT.Automation.Mechanical.CompositeCriterionDefinition

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

CompositeCriterion.EvaluateAllResults() → System.Void: Run the EvaluateAllResults action.

CompositeCriterion.ClearGeneratedData() → System.Void: Run the ClearGeneratedData action.

CompositeCriterion.Delete() → System.Void: Run the Delete action.

CompositeCriterion.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

CompositeCriterion.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

CompositeCriterion.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

CompositeCriterion.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

CompositeCriterion.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.Activate() → System.Void: Activate the current object.

CompositeCriterion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

CompositeCriterion.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

CompositeCriterion.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

CompositeCriterion.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

CompositeCriterion.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

CompositeCriterion.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

CompositeCriterion.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

CompositeCriterion.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.